ewf_adapter_espressif_common.h File Reference

The Embedded Wireless Framework Espressif common adapter API. More...

#include "ewf_adapter.h"

Go to the source code of this file.

Data Structures
struct	_ewf_adapter_espressif_common_internet_socket
	Internal structure for internet socket status More...
struct	_ewf_adapter_espressif_common
	The ESPRESSIF common adapter data structure. More...

Macros
#define	EWF_ADAPTER_ESPRESSIF_COMMON_TLS_BASIC_ENABLED   (0)
#define	EWF_ADAPTER_ESPRESSIF_COMMON_MQTT_BASIC_ENABLED   (0)
#define	EWF_ADAPTER_ESPRESSIF_COMMON_TCP_ENABLED   (1)
#define	EWF_ADAPTER_ESPRESSIF_COMMON_UDP_ENABLED   (1)
#define	EWF_ADAPTER_ESPRESSIF_COMMON_INTERNET_SOCKET_POOL_SIZE   (5)
	The total number of supported internet sockets in the adapter.
#define	EWF_ADAPTER_ESPRESSIF_COMMON_INTERNET_SOCKET_RECV_BUFFER_SIZE   (1500)
	The total number of supported internet sockets in the adapter.
#define	EWF_ADAPTER_ESPRESSIF_COMMON_INTERNET_SOCKET_INVALID   (-1)
	The internet socket invalid value.

Typedefs
typedef enum _ewf_adapter_common_internet_socket_service_type	ewf_adapter_espressif_common_internet_socket_service_type
	The socket service type
typedef struct _ewf_adapter_espressif_common_internet_socket	ewf_adapter_espressif_common_internet_socket
	Internal structure for internet socket status
typedef struct _ewf_adapter_espressif_common	ewf_adapter_espressif_common
	The ESPRESSIF common adapter data structure.

Enumerations
enum	_ewf_adapter_common_internet_socket_service_type {   ewf_adapter_espressif_common_internet_socket_service_type_not_initialized , ewf_adapter_espressif_common_internet_socket_service_type_tcp , ewf_adapter_espressif_common_internet_socket_service_type_udp , ewf_adapter_espressif_common_internet_socket_service_type_tcp_listener ,   ewf_adapter_espressif_common_internet_socket_service_type_udp_listener , ewf_adapter_mxchip_common_internet_socket_service_type_not_initialized , ewf_adapter_mxchip_common_internet_socket_service_type_tcp , ewf_adapter_mxchip_common_internet_socket_service_type_udp ,   ewf_adapter_mxchip_common_internet_socket_service_type_tcp_listener , ewf_adapter_mxchip_common_internet_socket_service_type_udp_listener , ewf_adapter_quectel_common_internet_socket_service_type_not_initialized , ewf_adapter_quectel_common_internet_socket_service_type_tcp ,   ewf_adapter_quectel_common_internet_socket_service_type_udp , ewf_adapter_quectel_common_internet_socket_service_type_tcp_listener , ewf_adapter_quectel_common_internet_socket_service_type_udp_listener , ewf_adapter_thales_common_internet_socket_service_type_not_initialized ,   ewf_adapter_thales_common_internet_socket_service_type_tcp , ewf_adapter_thales_common_internet_socket_service_type_udp , ewf_adapter_thales_common_internet_socket_service_type_tcp_listener , ewf_adapter_thales_common_internet_socket_service_type_udp_listener }
	The socket service type

Functions
ewf_result	ewf_adapter_espressif_common_start (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_espressif_common_stop (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_espressif_common_info (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_espressif_common_get_ipv4_address (ewf_adapter *adapter_ptr, uint32_t *address_ptr)
ewf_result	ewf_adapter_espressif_common_get_ipv4_netmask (ewf_adapter *adapter_ptr, uint32_t *netmask_ptr)
ewf_result	ewf_adapter_espressif_common_get_ipv4_gateway (ewf_adapter *adapter_ptr, uint32_t *gateway_ptr)
ewf_result	ewf_adapter_espressif_common_get_ipv4_dns (ewf_adapter *adapter_ptr, uint32_t *dns)
ewf_result	ewf_adapter_espressif_common_urc_callback (ewf_interface *interface_ptr, uint8_t *buffer_ptr, uint32_t buffer_length)
ewf_result	ewf_adapter_espressif_common_wifi_station_connect (ewf_adapter *adapter_ptr, const char *ssid_str, const char *password_str)
ewf_result	ewf_adapter_espressif_common_wifi_station_disconnect (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_espressif_common_internet_start (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_espressif_common_internet_stop (ewf_adapter *adapter_ptr)
ewf_result	ewf_adapter_espressif_common_internet_urc_callback (ewf_interface *interface_ptr, uint8_t *buffer_ptr, uint32_t buffer_length)
ewf_result	ewf_adapter_espressif_common_tcp_open (ewf_adapter *adapter_ptr, ewf_socket_tcp *socket_ptr)
ewf_result	ewf_adapter_espressif_common_tcp_close (ewf_socket_tcp *socket_ptr)
ewf_result	ewf_adapter_espressif_common_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_espressif_common_tcp_set_tls_configuration (ewf_socket_tcp *socket_ptr, uint32_t tls_configuration_id)
ewf_result	ewf_adapter_espressif_common_tcp_bind (ewf_socket_tcp *socket_ptr, uint32_t port)
ewf_result	ewf_adapter_espressif_common_tcp_listen (ewf_socket_tcp *socket_ptr)
ewf_result	ewf_adapter_espressif_common_tcp_accept (ewf_socket_tcp *socket_ptr, ewf_socket_tcp *socket_new_ptr)
ewf_result	ewf_adapter_espressif_common_tcp_connect (ewf_socket_tcp *socket_ptr, const char *const server, uint32_t port)
ewf_result	ewf_adapter_espressif_common_tcp_shutdown (ewf_socket_tcp *socket_ptr)
ewf_result	ewf_adapter_espressif_common_tcp_send (ewf_socket_tcp *socket_ptr, const uint8_t *buffer_ptr, uint32_t buffer_length)
ewf_result	ewf_adapter_espressif_common_tcp_receive (ewf_socket_tcp *socket_ptr, uint8_t *buffer_ptr, uint32_t *buffer_length, bool wait)
ewf_result	ewf_adapter_espressif_common_udp_open (ewf_adapter *adapter_ptr, ewf_socket_udp *socket_ptr)
ewf_result	ewf_adapter_espressif_common_udp_close (ewf_socket_udp *socket_ptr)
ewf_result	ewf_adapter_espressif_common_udp_control (ewf_socket_udp *socket_ptr, const char *control_str, const uint8_t *buffer_ptr, uint32_t *buffer_length_ptr)
ewf_result	ewf_adapter_espressif_common_udp_set_dtls_configuration (ewf_socket_udp *socket_ptr, uint32_t dtls_configuration_id)
ewf_result	ewf_adapter_espressif_common_udp_bind (ewf_socket_udp *socket_ptr, uint32_t port)
ewf_result	ewf_adapter_espressif_common_udp_shutdown (ewf_socket_udp *socket_ptr)
ewf_result	ewf_adapter_espressif_common_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_espressif_common_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)

Variables
ewf_adapter_api_control	ewf_adapter_espressif_common_api_control
ewf_adapter_api_info	ewf_adapter_espressif_common_api_info
ewf_adapter_api_wifi_station	ewf_adapter_espressif_common_api_wifi_station
ewf_adapter_api_tcp	ewf_adapter_espressif_common_api_tcp
ewf_adapter_api_udp	ewf_adapter_espressif_common_api_udp

Detailed Description

The Embedded Wireless Framework Espressif common adapter API.

Version

Preview

Copyright

Copyright (c) Microsoft Corporation. All rights reserved. SPDX-License-Identifier: MIT