winc1500/host_drv/socket/include/m2m_socket_host_if.h File Reference

BSD compatible socket interface internal types.

Copyright (c) 2016-2021 Microchip Technology Inc. and its subsidiaries.

#include "socket/include/socket.h"

Data Structures
struct	tstrAcceptReply
struct	tstrBindCmd
struct	tstrBindReply
struct	tstrConnectAlpnReply
	Connect Reply, contains sock number, error value and index of negotiated application protocol. More...
struct	tstrConnectCmd
struct	tstrConnectReply
	Connect Reply, contains sock number and error value. More...
struct	tstrDnsReply
	DNS Reply, contains hostName and HostIP. More...
struct	tstrListenCmd
struct	tstrListenReply
struct	tstrPingCmd
struct	tstrPingReply
struct	tstrRecvCmd
struct	tstrRecvReply
struct	tstrSendCmd
struct	tstrSendReply
	Send Reply, contains socket number and number of sent bytes. More...
struct	tstrSetSocketOptCmd
struct	tstrSockAddr
struct	tstrSslCertExpSettings
	SSL Certificate Expiry Validation Settings. More...
struct	tstrSSLSetSockOptCmd
struct	tstrSSLSocketCreateCmd

Macros
#define	ALPN_LIST_MAX_SIZE   32
#define	ALPN_LIST_MIN_SIZE   4
#define	PING_ERR_DEST_UNREACH   1
#define	PING_ERR_SUCCESS   0
#define	PING_ERR_TIMEOUT   2
#define	SOCKET_CMD_ACCEPT   0x43
#define	SOCKET_CMD_BIND   0x41
#define	SOCKET_CMD_CLOSE   0x49
#define	SOCKET_CMD_CONNECT   0x44
#define	SOCKET_CMD_DNS_RESOLVE   0x4A
#define	SOCKET_CMD_INVALID   0x00
#define	SOCKET_CMD_LISTEN   0x42
#define	SOCKET_CMD_PING   0x52
#define	SOCKET_CMD_RECV   0x46
#define	SOCKET_CMD_RECVFROM   0x48
#define	SOCKET_CMD_SECURE   0x56
#define	SOCKET_CMD_SEND   0x45
#define	SOCKET_CMD_SENDTO   0x47
#define	SOCKET_CMD_SET_SOCKET_OPTION   0x4F
#define	SOCKET_CMD_SSL_BIND   0x54
#define	SOCKET_CMD_SSL_CLOSE   0x4E
#define	SOCKET_CMD_SSL_CONNECT   0x4B
#define	SOCKET_CMD_SSL_CONNECT_ALPN   0x57
#define	SOCKET_CMD_SSL_CREATE   0x50
#define	SOCKET_CMD_SSL_EXP_CHECK   0x55
#define	SOCKET_CMD_SSL_RECV   0x4D
#define	SOCKET_CMD_SSL_SEND   0x4C
#define	SOCKET_CMD_SSL_SET_CS_LIST   0x53
#define	SOCKET_CMD_SSL_SET_SOCK_OPT   0x51
#define	SSL_MAX_OPT_LEN   HOSTNAME_MAX_SIZE

Typedefs
typedef sint8	SOCKET
typedef tstrSockAddr	tstrUIPSockAddr

#define ALPN_LIST_MAX_SIZE   32

Maximum length of ALPN list that can be specified by the application. The list is in the following format:

0       1       2       3 ... (bytes)
+-------+-------+-------+  ...        +-------+  ...        +-------+  ...
| Length L (BE) | len1  | name1...    | len2  | name2...    | len3  | name3...
+-------+-------+-------+  ...        +-------+  ...        +-------+  ...
Length fields do not include themselves.

#define ALPN_LIST_MIN_SIZE   4

#define PING_ERR_DEST_UNREACH   1

#define PING_ERR_SUCCESS   0

#define PING_ERR_TIMEOUT   2

#define SOCKET_CMD_ACCEPT   0x43

Socket Accepting command value.

#define SOCKET_CMD_BIND   0x41

Socket Binding command value.

#define SOCKET_CMD_CLOSE   0x49

Socket Close command value.

#define SOCKET_CMD_CONNECT   0x44

Socket Connecting command value.

#define SOCKET_CMD_DNS_RESOLVE   0x4A

Socket DNS Resolve command value.

#define SOCKET_CMD_INVALID   0x00

Invalid Socket command value.

#define SOCKET_CMD_LISTEN   0x42

Socket Listening command value.

#define SOCKET_CMD_PING   0x52

#define SOCKET_CMD_RECV   0x46

Socket Receive command value.

#define SOCKET_CMD_RECVFROM   0x48

Socket ReceiveFrom command value.

#define SOCKET_CMD_SECURE   0x56

Make secure a previously opened socket.

#define SOCKET_CMD_SEND   0x45

Socket send command value.

#define SOCKET_CMD_SENDTO   0x47

Socket sendTo command value.

#define SOCKET_CMD_SET_SOCKET_OPTION   0x4F

Set Socket Option command value.

#define SOCKET_CMD_SSL_BIND   0x54

Referenced by bind(), and m2m_ip_cb().

#define SOCKET_CMD_SSL_CLOSE   0x4E

SSL-Socket Close command value.

#define SOCKET_CMD_SSL_CONNECT   0x4B

SSL-Socket Connect command value.

#define SOCKET_CMD_SSL_CONNECT_ALPN   0x57

SSL-Socket Connect with ALPN command value.

#define SOCKET_CMD_SSL_CREATE   0x50

#define SOCKET_CMD_SSL_EXP_CHECK   0x55

Referenced by sslEnableCertExpirationCheck().

#define SOCKET_CMD_SSL_RECV   0x4D

SSL-Socket Receive command value.

#define SOCKET_CMD_SSL_SEND   0x4C

SSL-Socket Send command value.

#define SOCKET_CMD_SSL_SET_CS_LIST   0x53

Recommend instead using M2M_SSL_REQ_SET_CS_LIST and associated response M2M_SSL_RESP_SET_CS_LIST

#define SOCKET_CMD_SSL_SET_SOCK_OPT   0x51

#define SSL_MAX_OPT_LEN   HOSTNAME_MAX_SIZE

typedef sint8 SOCKET

typedef tstrSockAddr tstrUIPSockAddr