st_things_types.h

Go to the documentation of this file.

/* ****************************************************************
 *
 * Copyright 2017 Samsung Electronics 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.
 *
 ******************************************************************/

#ifndef __ST_THINGS_TYPES_H__
#define __ST_THINGS_TYPES_H__

#include <stdint.h>
#include <stdlib.h>
#include <stdbool.h>

typedef enum {
    ST_THINGS_ERROR_NONE                         =  0, 
    ST_THINGS_ERROR_INVALID_PARAMETER            = -1, 
    ST_THINGS_ERROR_OPERATION_FAILED             = -2, 
    ST_THINGS_ERROR_STACK_NOT_INITIALIZED        = -3, 
    ST_THINGS_ERROR_STACK_ALREADY_INITIALIZED    = -4, 
    ST_THINGS_ERROR_STACK_NOT_STARTED            = -5, 
    ST_THINGS_ERROR_STACK_RUNNING                = -6, 
} st_things_error_e;

typedef enum {
    ST_THINGS_STATUS_INIT = 0,                         
    ST_THINGS_STATUS_ES_STARTED,                       
    ST_THINGS_STATUS_ES_DONE,                          
    ST_THINGS_STATUS_ES_FAILED_ON_OWNERSHIP_TRANSFER,  
    ST_THINGS_STATUS_CONNECTING_TO_AP,                 
    ST_THINGS_STATUS_CONNECTED_TO_AP,                  
    ST_THINGS_STATUS_CONNECTING_TO_AP_FAILED,          
    ST_THINGS_STATUS_REGISTERING_TO_CLOUD,             
    ST_THINGS_STATUS_REGISTERED_TO_CLOUD,              
    ST_THINGS_STATUS_REGISTERING_FAILED_ON_SIGN_IN,    
    ST_THINGS_STATUS_REGISTERING_FAILED_ON_PUB_RES     
} st_things_status_e;

typedef struct _st_things_representation
{
    void*   payload; 
    bool    (*get_str_value)            (struct _st_things_representation* rep, const char* key, char** value);

    bool    (*get_bool_value)           (struct _st_things_representation* rep, const char* key, bool* value);

    bool    (*get_int_value)            (struct _st_things_representation* rep, const char* key, int64_t* value);

    bool    (*get_double_value)         (struct _st_things_representation* rep, const char* key, double* value);

    bool    (*get_byte_value)           (struct _st_things_representation* rep, const char* key, uint8_t** value, size_t* size);

    bool    (*get_object_value)         (struct _st_things_representation* rep, const char* key, struct _st_things_representation** value);

    bool    (*set_str_value)            (struct _st_things_representation* rep, const char* key, const char* value);

    bool    (*set_bool_value)           (struct _st_things_representation* rep, const char* key, bool value);

    bool    (*set_int_value)            (struct _st_things_representation* rep, const char* key, int64_t value);

    bool    (*set_double_value)         (struct _st_things_representation* rep, const char* key, double value);

    bool    (*set_byte_value)           (struct _st_things_representation* rep, const char* key, const uint8_t* value, size_t size);

    bool    (*set_object_value)         (struct _st_things_representation* rep, const char* key, const struct _st_things_representation* value);

    bool    (*get_str_array_value)      (struct _st_things_representation* rep, const char* key, char*** array, size_t* length);

    bool    (*get_int_array_value)      (struct _st_things_representation* rep, const char* key, int64_t** array, size_t* length);

    bool    (*get_double_array_value)   (struct _st_things_representation* rep, const char* key, double** array, size_t* length);

    bool    (*get_object_array_value)   (struct _st_things_representation* rep, const char* key, struct _st_things_representation*** array, size_t* length);

    bool    (*set_str_array_value)      (struct _st_things_representation* rep, const char* key, const char** array, size_t length);

    bool    (*set_int_array_value)      (struct _st_things_representation* rep, const char* key, const int64_t* array, size_t length);

    bool    (*set_double_array_value)   (struct _st_things_representation* rep, const char* key, const double* array, size_t length);

    bool    (*set_object_array_value)   (struct _st_things_representation* rep, const char* key, const struct _st_things_representation** array, size_t length);

} st_things_representation_s;

typedef struct _st_things_get_request_message
{
    char*                               resource_uri;   
    char*                               query;          
    char*                               property_key;   
    bool    (*get_query_value)          (struct _st_things_get_request_message* req_msg, const char* key, char** value);

    bool    (*has_property_key)         (struct _st_things_get_request_message* req_msg, const char* key);

} st_things_get_request_message_s;

typedef struct _st_things_set_request_message
{
    char*                               resource_uri;   
    char*                               query;          
    struct _st_things_representation*   rep;            
    bool    (*get_query_value)          (struct _st_things_set_request_message* req_msg, const char* key, char** value);

} st_things_set_request_message_s;

#endif /* __ST_THINGS_TYPES_H__ */