** More...

Data Structures
struct	sockaddr
	socket address struct More...

struct	in_addr
	socket address(net format) More...

struct	sockaddr_in
	socket address_in struct More...

struct	in6_addr
	socket address(IPV6 net format) More...

struct	sockaddr_in6
	socket address_in6 struct More...

struct	sockaddr_storage

struct	addrinfo
	socket address_in6 info More...

struct	_fd_set

Macros
#define	FD_SETSIZE 64
	MAX fd number is 64 in MXOS. More...

#define	NBBY 8
	number of bits in a byte. More...

#define	NFDBITS (sizeof(unsigned long) * NBBY)
	bits per mask More...

#define	FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] \|= MC_FDSET_MASK(n))
	Add a fd to FD set. More...

#define	FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~MC_FDSET_MASK(n))
	Remove fd from FD set. More...

#define	FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & MC_FDSET_MASK(n))
	Check if the fd is set in FD set. More...

#define	FD_ZERO(p) memset((p), 0, sizeof(*(p)))
	Clear FD set. More...

Enumerations

Functions
int32_t	MX_WIFI_Socket_create (MX_WIFIObject_t *Obj, int32_t domain, int32_t type, int32_t protocol)
	Create a socket. More...

int32_t	MX_WIFI_Socket_setsockopt (MX_WIFIObject_t Obj, int32_t sockfd, int32_t level, int32_t optname, const void optvalue, int32_t optlen)
	Set option for a socket. More...

int32_t	MX_WIFI_Socket_getsockopt (MX_WIFIObject_t Obj, int32_t sockfd, int32_t level, int32_t optname, void optvalue, uint32_t *optlen)
	Get option of a socket. More...

int32_t	MX_WIFI_Socket_bind (MX_WIFIObject_t Obj, int32_t sockfd, const struct sockaddr addr, int32_t addrlen)
	Bind a socket. More...

int32_t	MX_WIFI_Socket_listen (MX_WIFIObject_t *Obj, int32_t sockfd, int32_t backlog)
	Listen a socket. More...

int32_t	MX_WIFI_Socket_accept (MX_WIFIObject_t Obj, int32_t sockfd, struct sockaddr addr, uint32_t *addrlen)
	Accept a socket. More...

int32_t	MX_WIFI_Socket_connect (MX_WIFIObject_t Obj, int32_t sockfd, const struct sockaddr addr, int32_t addrlen)
	Socket connect. More...

int32_t	MX_WIFI_Socket_shutdown (MX_WIFIObject_t *Obj, int32_t sockfd, int32_t mode)
	Socket shutdown. More...

int32_t	MX_WIFI_Socket_close (MX_WIFIObject_t *Obj, int32_t sockfd)
	Socket close. More...

int32_t	MX_WIFI_Socket_send (MX_WIFIObject_t Obj, int32_t sockfd, uint8_t buf, int32_t len, int32_t flags)
	Socket send. More...

int32_t	MX_WIFI_Socket_recv (MX_WIFIObject_t Obj, int32_t sockfd, uint8_t buf, int32_t len, int32_t flags)
	Socket recv. More...

int32_t	MX_WIFI_Socket_sendto (MX_WIFIObject_t Obj, int32_t sockfd, uint8_t buf, int32_t len, int32_t flags, struct sockaddr *toaddr, int32_t toaddrlen)
	Socket sendto. More...

int32_t	MX_WIFI_Socket_recvfrom (MX_WIFIObject_t Obj, int32_t sockfd, uint8_t buf, int32_t len, int32_t flags, struct sockaddr fromaddr, uint32_t fromaddrlen)
	Socket recvfrom. More...

int32_t	MX_WIFI_Socket_gethostbyname (MX_WIFIObject_t Obj, struct sockaddr addr, char *name)
	Gethostbyname, only for IPv4 address. More...

int32_t	MX_WIFI_Socket_ping (MX_WIFIObject_t Obj, const char hostname, int32_t count, int32_t delay, int32_t response[])
	Ping a host, only for IPv4 address. More...

int32_t	MX_WIFI_Socket_getpeername (MX_WIFIObject_t Obj, int32_t sockfd, struct sockaddr addr, uint32_t *addrlen)
	socket getpeername. More...

int32_t	MX_WIFI_Socket_getsockname (MX_WIFIObject_t Obj, int32_t sockfd, struct sockaddr addr, uint32_t *addrlen)
	socket getsockname. More...

Detailed Description

**

socket related API **

Macro Definition Documentation

#define FD_CLR	(	n,
		p
	)	((p)->fds_bits[(n)/NFDBITS] &= ~MC_FDSET_MASK(n))

Remove fd from FD set.

Definition at line 876 of file mx_wifi.h.

#define FD_ISSET	(	n,
		p
	)	((p)->fds_bits[(n)/NFDBITS] & MC_FDSET_MASK(n))

Check if the fd is set in FD set.

Definition at line 877 of file mx_wifi.h.

#define FD_SET	(	n,
		p
	)	((p)->fds_bits[(n)/NFDBITS] \|= MC_FDSET_MASK(n))

Add a fd to FD set.

Definition at line 875 of file mx_wifi.h.

#define FD_SETSIZE 64

MAX fd number is 64 in MXOS.

Definition at line 862 of file mx_wifi.h.

#define FD_ZERO ( p ) memset((p), 0, sizeof(*(p)))

Clear FD set.

Definition at line 878 of file mx_wifi.h.

#define NBBY 8

number of bits in a byte.

Definition at line 865 of file mx_wifi.h.

#define NFDBITS (sizeof(unsigned long) * NBBY)

bits per mask

Definition at line 866 of file mx_wifi.h.

Enumeration Type Documentation

enum IP_OPT_VAL

IP option types, level: IPPROTO_IP.

Enumerator
IP_ADD_MEMBERSHIP	Join multicast group.
IP_DROP_MEMBERSHIP	Leave multicast group.

Definition at line 884 of file mx_wifi.h.

enum SOCK_OPT_VAL

socket option value

Enumerator
SO_DEBUG	Unimplemented: turn on debugging info recording.
SO_ACCEPTCONN	socket has had listen()
SO_REUSEADDR	Allow local address reuse.
SO_KEEPALIVE	keep connections alive
SO_DONTROUTE	Just use interface addresses.
SO_BROADCAST	Permit to send and to receive broadcast messages.
SO_USELOOPBACK	Bypass hardware when possible.
SO_LINGER	linger on close if data present
SO_OOBINLINE	Leave received OOB data in line.
SO_REUSEPORT	Allow local address & port reuse.
SO_BLOCKMODE	set socket as block(optval=0)/non-block(optval=1) mode. Default is block mode.
SO_SNDTIMEO	Send timeout in block mode. block for ever in default mode.
SO_RCVTIMEO	Recv timeout in block mode. block 1 second in default mode.
SO_ERROR	Get socket error number.
SO_TYPE	Get socket type.
SO_NO_CHECK	Don't create UDP checksum.

Definition at line 838 of file mx_wifi.h.

Function Documentation

int32_t MX_WIFI_Socket_accept	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd,
		struct sockaddr *	addr,
		uint32_t *	addrlen
	)

Accept a socket.

Parameters

Obj	pointer to module handle
sockfd	socket fd
addr	client address
addrlen	length of client address

Return values

Accepted client socket fd, return < 0 if failed.

int32_t MX_WIFI_Socket_bind	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd,
		const struct sockaddr *	addr,
		int32_t	addrlen
	)

Bind a socket.

Parameters

Obj	pointer to module handle
sockfd	socket fd
addr	socket address
addrlen	address length

Return values

Operation Status.

int32_t MX_WIFI_Socket_close	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd
	)

Socket close.

Parameters

Obj	pointer to module handle
sockfd	socket fd

Return values

Operation Status.

int32_t MX_WIFI_Socket_connect	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd,
		const struct sockaddr *	addr,
		int32_t	addrlen
	)

Socket connect.

Parameters

Obj	pointer to module handle
sockfd	socket fd
addr	client address
addrlen	length of client address

Return values

Operation Status.

int32_t MX_WIFI_Socket_create	(	MX_WIFIObject_t *	Obj,
		int32_t	domain,
		int32_t	type,
		int32_t	protocol
	)

Create a socket.

Parameters

Obj	pointer to module handle
domain	socket domain
type	socket type
protocol	socket protocol

Return values

Socket file descriptor, return < 1 if failed.

int32_t MX_WIFI_Socket_gethostbyname	(	MX_WIFIObject_t *	Obj,
		struct sockaddr *	addr,
		char *	name
	)

Gethostbyname, only for IPv4 address.

Parameters

Obj	pointer to module handle
addr	address of the host
name	hostname

Return values

Operation Status.

int32_t MX_WIFI_Socket_getpeername	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd,
		struct sockaddr *	addr,
		uint32_t *	addrlen
	)

socket getpeername.

Parameters

Obj	pointer to module handle
sockfd	socket fd
addr	address buffer
addrlen	size of address buffer

Return values

get	address of peer socket, return < 0 if failed.

int32_t MX_WIFI_Socket_getsockname	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd,
		struct sockaddr *	addr,
		uint32_t *	addrlen
	)

socket getsockname.

Parameters

Obj	pointer to module handle
sockfd	socket fd
addr	address buffer
addrlen	size of address buffer

Return values

get	address of local socket, return < 0 if failed.

int32_t MX_WIFI_Socket_getsockopt	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd,
		int32_t	level,
		int32_t	optname,
		void *	optvalue,
		uint32_t *	optlen
	)

Get option of a socket.

Parameters

Obj	pointer to module handle
sockfd	socket fd
level	option level
optname	option to set
optvalue	buffer pointer of value of the option
optlen	buffer pointer of length of the option value

Return values

Operation Status.

int32_t MX_WIFI_Socket_listen	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd,
		int32_t	backlog
	)

Listen a socket.

Parameters

Obj	pointer to module handle
sockfd	socket fd
backlog	max number to queued.

Return values

Operation Status.

int32_t MX_WIFI_Socket_ping	(	MX_WIFIObject_t *	Obj,
		const char *	hostname,
		int32_t	count,
		int32_t	delay,
		int32_t	response[]
	)

Ping a host, only for IPv4 address.

Parameters

Obj	pointer to module handle
addr	hostname
count	ping max count
delay	ping delay in millisecond
response	response time array of ping result

Return values

Operation Status.

int32_t MX_WIFI_Socket_recv	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd,
		uint8_t *	buf,
		int32_t	len,
		int32_t	flags
	)

Socket recv.

Parameters

Obj	pointer to module handle
sockfd	socket fd
buf	recv buffer
len	length of recv buffer
flags	zero for MXOS

Return values

Number of bytes received, return < 0 if failed.

int32_t MX_WIFI_Socket_recvfrom	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd,
		uint8_t *	buf,
		int32_t	len,
		int32_t	flags,
		struct sockaddr *	fromaddr,
		uint32_t *	fromaddrlen
	)

Socket recvfrom.

Parameters

Obj	pointer to module handle
sockfd	socket fd
buf	recv buffer
len	length of recv buffer
fromaddr	address of the data source
fromaddrlen	length of address of the data source
flags	zero for MXOS

Return values

Number of bytes received, return < 0 if failed.

int32_t MX_WIFI_Socket_send	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd,
		uint8_t *	buf,
		int32_t	len,
		int32_t	flags
	)

Socket send.

Parameters

Obj	pointer to module handle
sockfd	socket fd
buf	send data buffer
len	length of send data
flags	zero for MXOS

Return values

Number of bytes sent, return < 0 if failed.

int32_t MX_WIFI_Socket_sendto	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd,
		uint8_t *	buf,
		int32_t	len,
		int32_t	flags,
		struct sockaddr *	toaddr,
		int32_t	toaddrlen
	)

Socket sendto.

Parameters

Obj	pointer to module handle
sockfd	socket fd
buf	send data buffer
len	length of send data
flags	zero for MXOS
toaddr	address to send
toaddrlen	length of address to send

Return values

Number of bytes sent, return < 0 if failed.

int32_t MX_WIFI_Socket_setsockopt	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd,
		int32_t	level,
		int32_t	optname,
		const void *	optvalue,
		int32_t	optlen
	)

Set option for a socket.

Parameters

Obj	pointer to module handle
sockfd	socket fd
level	option level
optname	option to set
optvalue	value buffer for the option
optlen	length of the option value

Return values

Operation Status.

int32_t MX_WIFI_Socket_shutdown	(	MX_WIFIObject_t *	Obj,
		int32_t	sockfd,
		int32_t	mode
	)

Socket shutdown.

Parameters

Obj	pointer to module handle
sockfd	socket fd
mode	shutdown mode: 0 Stop receiving data for this socket; 1 Stop trying to transmit data from this socket 2 Stop all transmit from this socket

Return values

Operation Status.

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation

Important Information for this Arm website