ewf_adapter_api_tcp.h

Go to the documentation of this file.

/************************************************************************/
#ifndef __ewf_adapter_tcp__h__included__
#define __ewf_adapter_tcp__h__included__
 
#include "ewf.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/************************************************************************/
struct _ewf_socket_tcp;
 
typedef struct _ewf_socket_tcp ewf_socket_tcp;
 
typedef ewf_result(*ewf_adapter_tcp_receive_callback)(ewf_socket_tcp* socket_ptr, const uint8_t* buffer_ptr, uint32_t buffer_length);
 
typedef ewf_result(*ewf_adapter_tcp_disconnect_callback)(ewf_socket_tcp* socket_ptr);
 
struct _ewf_socket_tcp
{
    void* data_ptr;
    ewf_adapter* adapter_ptr;
    ewf_adapter_tcp_receive_callback receive_callback;
    ewf_adapter_tcp_disconnect_callback disconnect_callback;
};
 
#define EWF_VALIDATE_TCP_SOCKET_POINTER(socket_ptr)                                 \
do {                                                                                \
    if ((socket_ptr == NULL) ||                                                     \
        (socket_ptr->adapter_ptr == NULL))                                          \
    {                                                                               \
        EWF_LOG_ERROR("The TCP socket pointer is invalid.\n");                      \
        return EWF_RESULT_INVALID_FUNCTION_ARGUMENT;                                \
    }                                                                               \
} while(0)
 
#define EWF_ADAPTER_TCP_SOCKET_CONTROL_SET_CONTEXT_ID              ("!SetContextId")
#define EWF_ADAPTER_TCP_SOCKET_CONTROL_SET_CONNECTION_TIMEOUT      ("!SetConnectionTimeout")
#define EWF_ADAPTER_TCP_SOCKET_CONTROL_IS_CONNECTED                ("!IsConnected")
#define EWF_ADAPTER_TCP_SOCKET_CONTROL_IS_BOUND                    ("!IsBound")
#define EWF_ADAPTER_TCP_SOCKET_CONTROL_USES_TLS                    ("!UsesTLS")
#define EWF_ADAPTER_TCP_SOCKET_CONTROL_PEER_ADDRESSS               ("!PeerAddress")
#define EWF_ADAPTER_TCP_SOCKET_CONTROL_LOCAL_ADDRESSS              ("!LocalAddress")
#define EWF_ADAPTER_TCP_SOCKET_CONTROL_SENT_BYTES                  ("!SentBytes")
#define EWF_ADAPTER_TCP_SOCKET_CONTROL_RECEIVED_BYTES              ("!ReceivedBytes")
 
typedef struct _ewf_adapter_api_tcp
{
    ewf_result(*open)(ewf_adapter* adapter_ptr, ewf_socket_tcp* socket_ptr);
    ewf_result(*close)(ewf_socket_tcp* socket_ptr);
 
    ewf_result(*control)(ewf_socket_tcp* socket_ptr, const char* control_str, const uint8_t* buffer_ptr, uint32_t* buffer_length_ptr);
 
    ewf_result(*set_tls_configuration)(ewf_socket_tcp* socket_ptr, uint32_t tls_configuration_id);
 
    ewf_result(*bind)(ewf_socket_tcp* socket_ptr, uint32_t port);
    ewf_result(*listen)(ewf_socket_tcp* socket_ptr);
    ewf_result(*accept)(ewf_socket_tcp* socket_ptr, ewf_socket_tcp* socket_new_ptr);
    ewf_result(*connect)(ewf_socket_tcp* socket_ptr, const char* server_str, uint32_t port);
    ewf_result(*shutdown)(ewf_socket_tcp* socket_ptr);
    ewf_result(*send)(ewf_socket_tcp* socket_ptr, const uint8_t* buffer_ptr, uint32_t buffer_length);
    ewf_result(*receive)(ewf_socket_tcp* socket_ptr, uint8_t* buffer_ptr, uint32_t* buffer_length, bool wait);
 
} ewf_adapter_api_tcp;
 
ewf_result ewf_adapter_tcp_open(ewf_adapter* adapter_ptr, ewf_socket_tcp* socket_ptr);
 
ewf_result ewf_adapter_tcp_close(ewf_socket_tcp* socket_ptr);
 
ewf_result ewf_adapter_tcp_control(ewf_socket_tcp* socket_ptr, const char* control_str, const uint8_t* buffer_ptr, uint32_t* buffer_length_ptr);
 
ewf_result ewf_adapter_tcp_set_tls_configuration(ewf_socket_tcp* socket_ptr, uint32_t tls_configuration_id);
 
ewf_result ewf_adapter_tcp_bind(ewf_socket_tcp* socket_ptr, uint32_t port);
 
ewf_result ewf_adapter_tcp_listen(ewf_socket_tcp* socket_ptr);
 
ewf_result ewf_adapter_tcp_accept(ewf_socket_tcp* socket_ptr, ewf_socket_tcp* socket_new_ptr);
 
ewf_result ewf_adapter_tcp_connect(ewf_socket_tcp* socket_ptr, const char* server_str, uint32_t port);
 
ewf_result ewf_adapter_tcp_shutdown(ewf_socket_tcp* socket_ptr);
 
ewf_result ewf_adapter_tcp_send(ewf_socket_tcp* socket_ptr, const uint8_t* buffer_ptr, uint32_t buffer_length);
 
ewf_result ewf_adapter_tcp_receive(ewf_socket_tcp* socket_ptr, uint8_t* buffer_ptr, uint32_t * buffer_length, bool wait);
 
ewf_result ewf_adapter_tcp_receive_callback_set(ewf_socket_tcp* socket_ptr, ewf_adapter_tcp_receive_callback callback);
 
ewf_result ewf_adapter_tcp_disconnect_callback_set(ewf_socket_tcp* socket_ptr, ewf_adapter_tcp_disconnect_callback callback);
 
/************************************************************************/
#ifdef __cplusplus
}
#endif
 
#endif /* __ewf_adapter_tcp__h__included__ */