ewf_adapter_api_udp.h

Go to the documentation of this file.

/************************************************************************/
#ifndef __ewf_adapter_udp__h__included__
#define __ewf_adapter_udp__h__included__
 
#include "ewf.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/************************************************************************/
struct _ewf_socket_udp;
 
typedef struct _ewf_socket_udp ewf_socket_udp;
 
typedef ewf_result(*ewf_adapter_udp_receive_callback)(ewf_socket_udp* socket_ptr, const char* server, uint32_t port, const char* buffer, uint32_t length);
 
struct _ewf_socket_udp
{
    void* data_ptr;
    ewf_adapter* adapter_ptr;
    ewf_adapter_udp_receive_callback receive_callback;
};
 
#define EWF_VALIDATE_UDP_SOCKET_POINTER(socket_ptr)                                 \
do {                                                                                \
    if ((socket_ptr == NULL) ||                                                     \
        (socket_ptr->adapter_ptr == NULL))                                          \
    {                                                                               \
        EWF_LOG_ERROR("The UDP socket pointer is invalid.\n");                      \
        return EWF_RESULT_INVALID_FUNCTION_ARGUMENT;                                \
    }                                                                               \
} while(0)
 
#define EWF_ADAPTER_UDP_SOCKET_QUERY_IS_BOUND                      ("?IsBound")
#define EWF_ADAPTER_UDP_SOCKET_QUERY_USES_TLS                      ("?UsesTLS")
#define EWF_ADAPTER_UDP_SOCKET_QUERY_SENT_BYTES                    ("?SentBytes")
#define EWF_ADAPTER_UDP_SOCKET_QUERY_RECEIVED_BYTES                ("?ReceivedBytes")
 
typedef struct _ewf_adapter_api_udp
{
    ewf_result(*open)(ewf_adapter* adapter_ptr, ewf_socket_udp* socket_ptr);
    ewf_result(*close)(ewf_socket_udp* socket_ptr);
 
    ewf_result(*control)(ewf_socket_udp* socket_ptr, const char* control_str, const uint8_t* buffer_ptr, uint32_t* buffer_length_ptr);
 
    ewf_result(*set_dtls_configuration)(ewf_socket_udp* socket_ptr, uint32_t dtls_configuration_id);
 
    ewf_result(*bind)(ewf_socket_udp* socket_ptr, uint32_t local_port);
    ewf_result(*shutdown)(ewf_socket_udp* socket_ptr);
    ewf_result(*send_to)(ewf_socket_udp* socket_ptr, const char* remote_address_str, uint32_t remote_port, const uint8_t* buffer_ptr, uint32_t buffer_length);
    ewf_result(*receive_from)(ewf_socket_udp* socket_ptr, char* remote_address, uint32_t* remote_address_length_ptr, uint32_t* remote_port_ptr, uint8_t* buffer_ptr, uint32_t* buffer_length_ptr, bool wait);
 
} ewf_adapter_api_udp;
 
ewf_result ewf_adapter_udp_open(ewf_adapter* adapter_ptr, ewf_socket_udp* socket_ptr);
 
ewf_result ewf_adapter_udp_close(ewf_socket_udp* socket_ptr);
 
ewf_result ewf_adapter_udp_control(ewf_socket_udp* socket_ptr, const char* control_str, uint8_t* buffer_ptr, uint32_t* buffer_length_ptr);
 
ewf_result ewf_adapter_udp_set_dtls_configuration(ewf_socket_udp* socket_ptr, uint32_t dtls_configuration_id);
 
ewf_result ewf_adapter_udp_bind(ewf_socket_udp* socket_ptr, uint32_t local_port);
 
ewf_result ewf_adapter_udp_shutdown(ewf_socket_udp* socket_ptr);
 
ewf_result ewf_adapter_udp_send_to(ewf_socket_udp* socket_ptr, const char* remote_address_str, uint32_t remote_port, const uint8_t* buffer_ptr, uint32_t buffer_length);
 
ewf_result ewf_adapter_udp_receive_from(ewf_socket_udp* socket_ptr, char* remote_address, uint32_t* remote_address_length_ptr, uint32_t* remote_port_ptr, uint8_t* buffer_ptr, uint32_t* buffer_length_ptr, bool wait);
 
ewf_result ewf_adapter_udp_receive_callback_set(ewf_socket_udp* socket_ptr, ewf_adapter_udp_receive_callback callback);
 
/************************************************************************/
#ifdef __cplusplus
}
#endif
 
#endif /* __ewf_adapter_udp__h__included__ */