Embedded Wireless Framework
Macros | Typedefs | Enumerations
ewf.h File Reference

The Embedded Wireless Framework. More...

#include "ewf.config.h"
#include "ewf_ids.h"
#include <stdint.h>
#include <stdbool.h>
#include <inttypes.h>

Go to the source code of this file.

Macros

#define ewf_result_failed(code)   (EWF_RESULT_OK > (code))
 Returns true if the passed code is an error, false if not.
 
#define ewf_result_succeeded(code)   ((code) >= EWF_RESULT_OK)
 Returns true if the code passed indicates success, false if it is an error.
 
#define EWF_LOG(...)
 
#define EWF_LOG_ERROR(...)
 
#define EWF_PARAMETER_NOT_USED(p)   ((void)(p))
 

Typedefs

typedef enum _ewf_result ewf_result
 Success and error result codes specific to the EWF API.
 
typedef struct _ewf_adapter ewf_adapter
 The adapter type definition.
 
typedef struct _ewf_interface ewf_interface
 The interface type definition.
 
typedef struct _ewf_allocator ewf_allocator
 
typedef struct _ewf_message ewf_message
 The interface message structure type definition.
 
typedef struct _ewf_tokenizer_pattern ewf_tokenizer_pattern
 The interface tokenizer pattern structure type definition.
 

Enumerations

enum  _ewf_result {
  EWF_RESULT_OK = 0 , EWF_RESULT_UNHANDLED_URC = 1 , EWF_RESULT_NO_DATA_AVAILABLE = 2 , 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_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
}
 Success and error result codes specific to the EWF API. More...
 

Detailed Description

The Embedded Wireless Framework.

Version
Preview