sol-flow-packet.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <stdbool.h>
#include <stddef.h>
#include <time.h>

#include "sol-common-buildopts.h"
#include "sol-str-slice.h"
#include "sol-types.h"

#ifdef __cplusplus
extern "C" {
#endif

struct sol_flow_packet;
typedef struct sol_flow_packet sol_flow_packet;

typedef struct sol_flow_packet_type {
#ifndef SOL_NO_API_VERSION
#define SOL_FLOW_PACKET_TYPE_API_VERSION (1)
    uint16_t api_version; 
#endif
    uint16_t data_size; 
    const char *name; 
    int (*init)(const struct sol_flow_packet_type *packet_type, void *mem, const void *input);

    int (*get)(const struct sol_flow_packet_type *packet_type, const void *mem, void *output);

    void (*dispose)(const struct sol_flow_packet_type *packet_type, void *mem);

    struct sol_flow_packet *(*get_constant)(const struct sol_flow_packet_type *packet_type, const void *value);
} sol_flow_packet_type;

struct sol_flow_packet *sol_flow_packet_new(const struct sol_flow_packet_type *type, const void *value);

void sol_flow_packet_del(struct sol_flow_packet *packet);

const struct sol_flow_packet_type *sol_flow_packet_get_type(const struct sol_flow_packet *packet);

int sol_flow_packet_get(const struct sol_flow_packet *packet, void *output);

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_EMPTY;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_BOOL;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_BYTE;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_IRANGE;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_STRING;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_BLOB;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_JSON_OBJECT;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_JSON_ARRAY;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_DRANGE;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_ANY;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_ERROR;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_RGB;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_DIRECTION_VECTOR;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_LOCATION;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_TIMESTAMP;

extern const struct sol_flow_packet_type *SOL_FLOW_PACKET_TYPE_HTTP_RESPONSE;


/*
 * Convenience functions to use certain types of common packets.
 */

struct sol_flow_packet *sol_flow_packet_new_empty(void);

struct sol_flow_packet *sol_flow_packet_new_bool(bool boolean);

int sol_flow_packet_get_bool(const struct sol_flow_packet *packet, bool *boolean);

struct sol_flow_packet *sol_flow_packet_new_byte(unsigned char byte);

int sol_flow_packet_get_byte(const struct sol_flow_packet *packet, unsigned char *byte);

struct sol_flow_packet *sol_flow_packet_new_irange(const struct sol_irange *irange);

struct sol_flow_packet *sol_flow_packet_new_irange_value(int32_t value);

int sol_flow_packet_get_irange(const struct sol_flow_packet *packet, struct sol_irange *irange);

int sol_flow_packet_get_irange_value(const struct sol_flow_packet *packet, int32_t *value);

struct sol_flow_packet *sol_flow_packet_new_string(const char *value);

struct sol_flow_packet *sol_flow_packet_new_string_slice(struct sol_str_slice slice);

int sol_flow_packet_get_string(const struct sol_flow_packet *packet, const char **value);

struct sol_flow_packet *sol_flow_packet_new_string_take(char *value);

struct sol_flow_packet *sol_flow_packet_new_blob(const struct sol_blob *value);

int sol_flow_packet_get_blob(const struct sol_flow_packet *packet, struct sol_blob **value);

struct sol_flow_packet *sol_flow_packet_new_json_object(const struct sol_blob *value);

int sol_flow_packet_get_json_object(const struct sol_flow_packet *packet, struct sol_blob **value);

struct sol_flow_packet *sol_flow_packet_new_json_array(const struct sol_blob *value);

int sol_flow_packet_get_json_array(const struct sol_flow_packet *packet, struct sol_blob **value);

struct sol_flow_packet *sol_flow_packet_new_drange(const struct sol_drange *drange);

struct sol_flow_packet *sol_flow_packet_new_drange_value(double value);

int sol_flow_packet_get_drange(const struct sol_flow_packet *packet, struct sol_drange *drange);

int sol_flow_packet_get_drange_value(const struct sol_flow_packet *packet, double *value);

struct sol_flow_packet *sol_flow_packet_new_error(int code, const char *msg);

int sol_flow_packet_get_error(const struct sol_flow_packet *packet, int *code, const char **msg);

struct sol_flow_packet *sol_flow_packet_new_rgb(const struct sol_rgb *rgb);

struct sol_flow_packet *sol_flow_packet_new_rgb_components(uint32_t red, uint32_t green, uint32_t blue);

int sol_flow_packet_get_rgb(const struct sol_flow_packet *packet, struct sol_rgb *rgb);

int sol_flow_packet_get_rgb_components(const struct sol_flow_packet *packet, uint32_t *red, uint32_t *green, uint32_t *blue);

struct sol_flow_packet *sol_flow_packet_new_direction_vector(const struct sol_direction_vector *direction_vector);

struct sol_flow_packet *sol_flow_packet_new_direction_vector_components(double x, double y, double z);

int sol_flow_packet_get_direction_vector(const struct sol_flow_packet *packet, struct sol_direction_vector *direction_vector);

int sol_flow_packet_get_direction_vector_components(const struct sol_flow_packet *packet, double *x, double *y, double *z);

struct sol_flow_packet *sol_flow_packet_new_location(const struct sol_location *location);

struct sol_flow_packet *sol_flow_packet_new_location_components(double lat, double lon, double alt);

int sol_flow_packet_get_location(const struct sol_flow_packet *packet, struct sol_location *location);

int sol_flow_packet_get_location_components(const struct sol_flow_packet *packet, double *lat, double *lon, double *alt);

struct sol_flow_packet *sol_flow_packet_new_timestamp(const struct timespec *timestamp);

int sol_flow_packet_get_timestamp(const struct sol_flow_packet *packet, struct timespec *timestamp);

const struct sol_flow_packet_type *sol_flow_packet_type_composed_new(const struct sol_flow_packet_type **types);

bool sol_flow_packet_is_composed_type(const struct sol_flow_packet_type *type);

int sol_flow_packet_get_composed_members_packet_types(const struct sol_flow_packet_type *type, const struct sol_flow_packet_type ***children, uint16_t *len);

int sol_flow_packet_get_composed_members(const struct sol_flow_packet *packet, struct sol_flow_packet ***children, uint16_t *len);

struct sol_flow_packet *sol_flow_packet_dup(const struct sol_flow_packet *packet);

struct sol_flow_packet *sol_flow_packet_new_http_response(int response_code, const char *url, const char *content_type, const struct sol_blob *content, const struct sol_vector *cookies, const struct sol_vector *headers);

int sol_flow_packet_get_http_response(const struct sol_flow_packet *packet, int *response_code, const char **url, const char **content_type, const struct sol_blob **content, struct sol_vector *cookies, struct sol_vector *headers);

const char *sol_flow_get_packet_type_name(const struct sol_str_slice type);

const struct sol_flow_packet_type *sol_flow_packet_type_from_string(const struct sol_str_slice type);

#ifdef __cplusplus
}
#endif