ewf.h

Go to the documentation of this file.

/************************************************************************/
#ifndef __ewf__h__included__
#define __ewf__h__included__
 
/************************************************************************/
#include "ewf.config.h"
 
#include "ewf_ids.h"
 
#ifdef EWF_DEBUG
#include <stdio.h>
#endif
 
#include <stdint.h>
#include <stdbool.h>
#include <inttypes.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/************************************************************************/
typedef enum _ewf_result
{
    /* Non error results - positive or zero */
 
    EWF_RESULT_OK                               = 0,    
    EWF_RESULT_UNHANDLED_URC                    = 1,    
    EWF_RESULT_NO_DATA_AVAILABLE                = 2,    
    /* Error results - negative */
 
    EWF_RESULT_INVALID_FUNCTION_ARGUMENT        = -1,   
    EWF_RESULT_OUT_OF_MEMORY                    = -2,   
    EWF_RESULT_NOT_SUPPORTED                    = -3,   
    EWF_RESULT_TIMEOUT                          = -4,   
    EWF_RESULT_IRRECOVERABLE_ERROR              = -5,   
    EWF_RESULT_UNEXPECTED_RESPONSE              = -50,  
    EWF_RESULT_EMPTY_QUEUE                      = -80,  
    EWF_RESULT_FULL_QUEUE                       = -81,  
    EWF_RESULT_CONNECTION_FAILED                = -101, 
    EWF_RESULT_RECEPTION_FAILED                 = -102, 
    EWF_RESULT_NO_DATA_RECEIVED                 = -103, 
    EWF_RESULT_TOO_MANY_OPEN_SOCKETS            = -201, 
    EWF_RESULT_INVALID_SOCKET                   = -202, 
    EWF_RESULT_SOCKET_NOT_OPEN                  = -203, 
    EWF_RESULT_INTERFACE_INITIALIZATION_FAILED  = -301, 
    EWF_RESULT_INTERFACE_SEND_FAILED            = -302, 
    EWF_RESULT_INTERFACE_RECEIVE_FAILED         = -303, 
    EWF_RESULT_ADAPTER_INITIALIZATION_FAILED    = -401, 
    EWF_RESULT_ADAPTER_RESPONDED_ERROR          = -402, 
    EWF_RESULT_ADAPTER_RECEIVE_FAILED           = -403, 
    EWF_RESULT_ADAPTER_TRANSMIT_FAILED          = -404, 
    EWF_RESULT_ALLOCATOR_INITIALIZATION_FAILED  = -501, 
    EWF_RESULT_ADAPTER_NETWORK_NOT_REGISTERED   = -601, 
    /* EWF Apdater MQTT Result codes */
    EWF_RESULT_ADAPTER_MQTT_CONNECTION_FAILED   = -701, 
    EWF_RESULT_ADAPTER_MQTT_DISCONNECTED        = -702, 
    EWF_RESULT_ADAPTER_MQTT_PUBLISH_FAILED      = -703, 
    EWF_RESULT_ADAPTER_MQTT_SUBSCRIBE_FAILED    = -704, 
    EWF_RESULT_ADAPTER_MQTT_MESSAGE_GET_FAILED  = -705, 
} ewf_result;
 
#define ewf_result_failed(code) (EWF_RESULT_OK > (code))
 
#define ewf_result_succeeded(code) ((code) >= EWF_RESULT_OK)
 
#ifndef EWF_LOG
#ifndef EWF_DEBUG
#define EWF_LOG(...)
#else
#define EWF_LOG(...)                                                            \
do {                                                                            \
    (void)fprintf(stdout, __VA_ARGS__);                                         \
    (void)fflush(stdout);                                                       \
} while (0)
#endif
#endif
 
#ifndef EWF_LOG_ERROR
#ifndef EWF_DEBUG
#define EWF_LOG_ERROR(...)
#else
#define EWF_LOG_ERROR(...)                                                      \
do {                                                                            \
    EWF_LOG(                                                                    \
        "\n\n"                                                                  \
        "ERROR:\n"                                                              \
        "[%s]:[%d]\n"                                                           \
        "function: [%s]\n\n",                                                   \
        __FILE__, __LINE__, __func__);                                          \
    EWF_LOG(__VA_ARGS__);                                                       \
} while (0)
#endif
#endif
 
struct _ewf_adapter;
 
typedef struct _ewf_adapter ewf_adapter;
 
struct _ewf_interface;
 
typedef struct _ewf_interface ewf_interface;
 
struct _ewf_allocator;
 
typedef struct _ewf_allocator ewf_allocator;
 
struct _ewf_message;
 
typedef struct _ewf_message ewf_message;
 
struct _ewf_tokenizer_pattern;
 
typedef struct _ewf_tokenizer_pattern ewf_tokenizer_pattern;
 
/* Disable warning of parameter not used. */
 
#ifndef EWF_PARAMETER_NOT_USED
#define EWF_PARAMETER_NOT_USED(p) ((void)(p))
#endif /* EWF_PARAMETER_NOT_USED */
 
/************************************************************************/
#ifdef __cplusplus
}
#endif
 
#endif /* __ewf__h__included__ */