iotcs_message.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
 *
 * This software is dual-licensed to you under the MIT License (MIT) and
 * the Universal Permissive License (UPL). See the LICENSE file in the root
 * directory for license terms. You may choose either license, or both.
 */


#ifndef IOTCS_MESSAGE_H_
#define IOTCS_MESSAGE_H_

#include "iotcs.h"

typedef enum {
    IOTCS_MESSAGE_DATA = 0,
    IOTCS_MESSAGE_ALERT = 1,
    IOTCS_MESSAGE_REQUEST = 2,
    IOTCS_MESSAGE_RESPONSE = 3,
    IOTCS_MESSAGE_RESOURCE = 4,
} iotcs_message_type;

typedef enum {
    IOTCS_MESSAGE_PRIORITY_LOWEST = 0,
    IOTCS_MESSAGE_PRIORITY_LOW = 1,
    IOTCS_MESSAGE_PRIORITY_MEDIUM = 2,
    IOTCS_MESSAGE_PRIORITY_HIGH = 3,
    IOTCS_MESSAGE_PRIORITY_HIGHEST = 4,
    IOTCS_MESSAGE_PRIORITY_DEFAULT = IOTCS_MESSAGE_PRIORITY_LOW
} iotcs_message_priority;

typedef enum {
    IOTCS_MESSAGE_RELIABILITY_NO_GUARANTEE = 0,
    IOTCS_MESSAGE_RELIABILITY_BEST_EFFORT = 1, 
    IOTCS_MESSAGE_RELIABILITY_GUARANTED_DELIVERY = 2,
    IOTCS_MESSAGE_RELIABILITY_DEFAULT = IOTCS_MESSAGE_RELIABILITY_BEST_EFFORT
} iotcs_message_reliability;

typedef enum {
    IOTCS_MESSAGE_SEVERITY_CRITICAL = 0,
    IOTCS_MESSAGE_SEVERITY_SIGNIFICANT = 1,
    IOTCS_MESSAGE_SEVERITY_NORMAL = 2,
    IOTCS_MESSAGE_SEVERITY_LOW = 3,
    IOTCS_MESSAGE_SEVERITY_DEFAULT = IOTCS_MESSAGE_SEVERITY_SIGNIFICANT
} iotcs_message_severity;

typedef enum {
    IOTCS_RESOURCE_MESSAGE_UPDATE = 0,
    IOTCS_RESOURCE_MESSAGE_DELETE = 1,
    IOTCS_RESOURCE_MESSAGE_RECONCILIATION = 2
} iotcs_resource_message_type;

typedef struct {
    iotcs_value_type type;   
    const char* key;         
} iotcs_data_item_desc;

typedef struct {
    iotcs_data_item_desc *base;  
    iotcs_value value;           
} iotcs_data_item;

typedef struct {
    const char* key; 
    iotcs_value value; 
    iotcs_value_type type; 
} iotcs_message_diagnostic;

typedef struct {
    const char* key; 
    const char* const* values; 
} iotcs_message_property;

typedef struct {
    iotcs_message_type type;               
    const char* source;                    
    const char* sender;                    
    const char* destination;               
    iotcs_message_priority priority;       
    iotcs_message_reliability reliability; 
} iotcs_message_base;

typedef struct {
    const char *format;           
} iotcs_data_message_base;

typedef struct {
    const iotcs_data_message_base *base;       
    const iotcs_data_item_desc *items_desc;     
    iotcs_value *items_value;                   
} iotcs_data_message;

typedef struct {
    const char *format;                     
    const char* description;                
    iotcs_message_severity severity_level;  
} iotcs_alert_message_base;

typedef struct {
    const iotcs_alert_message_base *base;    
    const iotcs_data_item_desc *items_desc;   
    iotcs_value *items_value;                 
} iotcs_alert_message;

typedef enum {
    IOTCS_REQUEST_METHOD_DELETE = 1, 
    IOTCS_REQUEST_METHOD_GET = 2, 
    IOTCS_REQUEST_METHOD_POST = 8, 
    IOTCS_REQUEST_METHOD_PUT = 16 
} iotcs_request_method;

typedef struct {
    const char* name;                        
    const char* path;                        
    const char* description;                 
    iotcs_request_method methods;            
} iotcs_resource_message_base;

typedef struct {
    const iotcs_resource_message_base* base;   
    int resource_len;                          
    iotcs_resource_message_type report_type;   
    const char* endpointName;                  
} iotcs_resource_message;

typedef struct {
    char* id;                         
    char* source;                     
    char* destination;                
    iotcs_key_value *headers;         
    int headers_len;                  
    iotcs_key_value *params;          
    int params_len;                   
    iotcs_request_method method;      
    char* url;                        
    char* body;                       
} iotcs_request_message;

typedef struct {
    int status_code;                 
    const char* body;                
    iotcs_request_message* request;  
    iotcs_key_value *headers;        
    int headers_len;                 
} iotcs_response_message;

typedef struct {
    const iotcs_message_base *base;       
    const char* id;                       
    int uid;                      
    uint64_t event_time;                  
    void *user_data;                      
    void *message_mark;                      
    const iotcs_message_diagnostic *diagnostics;  
    const iotcs_message_property *properties; 
#ifdef IOTCS_VIRTUALIZATION_SUPPORT
    void* error_callback;
    void* error_callback_cpp;
    void* handler;
#endif
    union {
        iotcs_data_message data;           
        iotcs_alert_message alert;         
        iotcs_response_message response;   
        iotcs_resource_message resource;   
    } u; 
} iotcs_message;

#endif /* IOTCS_MESSAGE_H_ */