Embedded Wireless Framework
Data Structures | Macros | Typedefs | Functions
ewf_adapter_api_udp.h File Reference

The Embedded Wireless Framework adapter UDP API. More...

#include "ewf.h"

Go to the source code of this file.

Data Structures

struct  _ewf_socket_udp
 The UDP socket structure definition. More...
 
struct  _ewf_adapter_api_udp
 The UDP API type. More...
 

Macros

#define EWF_VALIDATE_UDP_SOCKET_POINTER(socket_ptr)
 
#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")
 

Typedefs

typedef struct _ewf_socket_udp ewf_socket_udp
 The UDP socket type.
 
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)
 A function pointer type for TCP receive callbacks. More...
 
typedef struct _ewf_adapter_api_udp ewf_adapter_api_udp
 The UDP API type.
 

Functions

ewf_result ewf_adapter_udp_open (ewf_adapter *adapter_ptr, ewf_socket_udp *socket_ptr)
 Open a UDP socket. More...
 
ewf_result ewf_adapter_udp_close (ewf_socket_udp *socket_ptr)
 Close a UDP socket. More...
 
ewf_result ewf_adapter_udp_control (ewf_socket_udp *socket_ptr, const char *control_str, uint8_t *buffer_ptr, uint32_t *buffer_length_ptr)
 Control an UDP socket This is mainly used to funnel implementation specific functionality. More...
 
ewf_result ewf_adapter_udp_set_dtls_configuration (ewf_socket_udp *socket_ptr, uint32_t dtls_configuration_id)
 Set the DTLS configuration for the socket. More...
 
ewf_result ewf_adapter_udp_bind (ewf_socket_udp *socket_ptr, uint32_t local_port)
 Binds an UDP socket to a local port. More...
 
ewf_result ewf_adapter_udp_shutdown (ewf_socket_udp *socket_ptr)
 Shutdown a UDP socket. More...
 
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)
 Send data over a UDP socket. More...
 
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)
 Receive data over a UDP socket. More...
 
ewf_result ewf_adapter_udp_receive_callback_set (ewf_socket_udp *socket_ptr, ewf_adapter_udp_receive_callback callback)
 Register a user UDP receive callback function. More...
 

Detailed Description

The Embedded Wireless Framework adapter UDP API.

Version
Preview