Socket API#

SOL_SOCKET#

#define SOL_SOCKET

0

Socket option level.

SOL_APPLICATION#

#define SOL_APPLICATION

1

Application socket option level.

IPPROTO_IPV6#

#define IPPROTO_IPV6

41

IPV6 socket option level.

SO_EVENT_MODE#

#define SO_EVENT_MODE

10

Specify event mode of a socket. When set, optval must point to an uint32_t.

Possible values are:

• SL_WISUN_SOCKET_EVENT_MODE_INDICATION: received data is included in SL_WISUN_MSG_SOCKET_DATA_IND_ID indication

• SL_WISUN_SOCKET_EVENT_MODE_POLLING: only the amount of received data is included SL_WISUN_MSG_SOCKET_DATA_AVAILABLE_IND_ID indication. recv() or recvfrom() shouldbe invoked after indication reception to retrieve data

SOCKET_EVENT_MODE#

#define SOCKET_EVENT_MODE

SO_EVENT_MODE

Specify event mode of a socket. When set, optval must point to an uint32_t.

Possible values are:

• SL_WISUN_SOCKET_EVENT_MODE_INDICATION: received data is included in SL_WISUN_MSG_SOCKET_DATA_IND_ID indication

• SL_WISUN_SOCKET_EVENT_MODE_POLLING: only the amount of received data is included SL_WISUN_MSG_SOCKET_DATA_AVAILABLE_IND_ID indication. recv() or recvfrom() shouldbe invoked after indication reception to retrieve data

SO_NONBLOCK#

#define SO_NONBLOCK

11

Enable/disable nonblocking mode.

This option takes an uint32_t value.

Possible values are:

• (1) enables nonblocking mode

• (0) disables nonblocking mode

SO_RCVBUF#

#define SO_RCVBUF

1

Specify receive buffer size in payload bytes. When set, optval must point to an int32_t.

0 means unread data are dropped, unless read in data callback.

SO_SNDBUF#

#define SO_SNDBUF

2

Specify send buffer size in payload bytes.

When set, optval must point to an int32_t.

Used only for stream sockets.

SO_SNDLOWAT#

#define SO_SNDLOWAT

4

Specify send low water mark in payload bytes.

When set, optval must point to an int32_t.

IPV6_UNICAST_HOPS#

#define IPV6_UNICAST_HOPS

2

Set the unicast hop limit for the socket. When set, optval must point to an int16_t.

-1 in the value means use the route default, otherwise it should be between 0 and 255.

IPV6_MULTICAST_HOPS#

#define IPV6_MULTICAST_HOPS

3

Set the multicast hop limit for the socket.

When set, optval must point to an int16_t.

-1 in the value means use the route default, otherwise it should be between 0 and 255.

IPV6_JOIN_GROUP#

#define IPV6_JOIN_GROUP

15

Join a multicast group.

When set, optval must point to an in6_addr_t.

IPV6_LEAVE_GROUP#

#define IPV6_LEAVE_GROUP

16

Leave a multicast group.

When set, optval must point to an in6_addr_t.

SO_EDFE_MODE#

#define SO_EDFE_MODE

0xfb

Experimental: Enable Extended Directed Frame Exchange mode.

When set, optval must point to an uint32_t.

SOCKET_EDFE_MODE#

#define SOCKET_EDFE_MODE

SO_EDFE_MODE

Set the unicast hop limit for the socket. When set, optval must point to an int16_t.

-1 in the value means use the route default, otherwise it should be between 0 and 255.

sl_wisun_socket_event_mode_t#

sl_wisun_socket_event_mode_t

Enumerations for socket event mode.

socket_domain#

socket_domain

Supported address families.

socket_type#

socket_type

Socket types.

socket_protocol#

socket_protocol

IP protocols.

socklen_t#

typedef uint32_t socklen_t

Socket address length type definition.

sl_wisun_socket_id_t#

typedef int32_t sl_wisun_socket_id_t

Socket id.

sl_socket_domain_t#

typedef enum socket_domain sl_socket_domain_t

Supported address families.

sl_socket_type_t#

typedef enum socket_type sl_socket_type_t

Socket types.

sl_socket_protocol_t#

typedef enum socket_protocol sl_socket_protocol_t

IP protocols.

in6_addr_t#

typedef struct in6_addr in6_addr_t

IPv6 Internet address.

sockaddr_in6_t#

typedef struct sockaddr_in6 sockaddr_in6_t

IPv6 address format.

in6addr_any#

const in6_addr_t in6addr_any

IPv6 wildcard address.

socket#

int32_t socket (int32_t domain, int32_t type, int32_t protocol)

Creates an endpoint for communication and returns an Id that refers to that endpoint.

Returns

• The socket's id on success, (-1) on failure.

close#

int32_t close (int32_t sockid)

Close a socket.

Returns

• 0 on success, -1 on failure.

Close a socket and remove from the socket handler storage.

bind#

int32_t bind (int32_t sockid, const struct sockaddr * addr, socklen_t addrlen)

Bind a name to a socket.

Returns

• 0 on success, -1 on failure.

Assigns the address to the socket, referred to by the socket ID, as specified by addr. It is normally necessary to assign a local address using bind() before a SOCK_STREAM socket may receive connections.

send#

int32_t send (int32_t sockid, const void * buff, uint32_t len, int32_t flags)

Send a message on a socket.

Returns

• The number of bytes sent on success, -1 if an error occurred.

Preferred with connection-oriented sockets (TCP).

sendto#

int32_t sendto (int32_t sockid, const void * buff, uint32_t len, int32_t flags, const struct sockaddr * dest_addr, socklen_t addr_len)

Send a message to a given address.

Returns

• The number of bytes sent on success, -1 if an error occurred.

Preferred in datagram mode (UDP).

recvfrom#

int32_t recvfrom (int32_t sockid, void * buf, uint32_t len, int32_t flags, struct sockaddr * src_addr, socklen_t * addrlen)

Receive messages from a socket.

Returns

• The number of bytes received on success, -1 if an error occurred.

Receives data on a socket whether or not it is connection-oriented.

recv#

int32_t recv (int32_t sockid, void * buf, uint32_t len, int32_t flags)

Receive a message from a socket.

Returns

• The number of bytes received on success, -1 if an error occurred.

Should be used for connection-oriented protocol (TCP)

accept#

int32_t accept (int32_t sockid, struct sockaddr * addr, socklen_t * addrlen)

Accept a connection on a socket.

Returns

• The socket id of the accepted socket on success, -1 if an error occurred.

Used with connection-based socket types (TCP). It extracts the first connection request on the queue of pending connections for the listening socket.

connect#

int32_t connect (int32_t sockid, const struct sockaddr * addr, socklen_t addrlen)

Initiate a connection on a socket.

Returns

• 0 on connection or binding success, -1 if an error occurred.

Connects the socket referred to by the sockid to the address specified by address.

listen#

int32_t listen (int32_t sockid, int32_t backlog)

Listen for connections on a socket.

Returns

• 0 on success, -1 if an error occurred.

Marks the socket referred to by sockid as a passive socket, that is, as a socket that will be used to accept incoming connection requests using accept.

setsockopt#

int32_t setsockopt (int32_t sockid, int32_t level, int32_t optname, const void * optval, socklen_t optlen)

Set socket option designated by optname at a given protocol level to the value pointed by optval.

Returns

• 0 on success, -1 if an error occurred.

This function can set socket properties.

getsockopt#

int32_t getsockopt (int32_t sockid, int32_t level, int32_t optname, void * optval, socklen_t * optlen)

Get socket option.

Returns

• 0 on success, -1 if an error occurred.

The function gets socket option by optname, and copies option data to optval ptr.

htonl#

__STATIC_INLINE uint32_t htonl (uint32_t hostlong)

Convert the long host byte order to network order.

Returns

• Long network integer

This function converts the unsigned integer hostlong from host byte order to network byte order. For Wi-SUN, the conversion is not needed. Dummy implementation

htons#

__STATIC_INLINE uint16_t htons (uint16_t hostshort)

Convert the short host byte order to network order.

Returns

• Short network integer

This function converts the unsigned short integer hostshort from host byte order to network byte order. For Wi-SUN, the conversion is not needed. Dummy implementation

ntohl#

__STATIC_INLINE uint32_t ntohl (uint32_t netlong)

Convert the long network byte order to host byte order.

Returns

• Long host integer

This function converts the unsigned integer netlong from network byte order to host byte order. For Wi-SUN, the conversion is not needed. Dummy implementation

ntohs#

__STATIC_INLINE uint16_t ntohs (uint16_t netshort)

Convert the short network byte order to host byte order.

Returns

• Short host integer

This function converts the unsigned short integer netshort from the network byte order to host byte order.For Wi-SUN, the conversion is not needed. Dummy implementation.

inet_pton#

int32_t inet_pton (int32_t af, const char * src, void * dst)

Convert the IPv4 and IPv6 addresses from text to binary form.

Returns

• 1 on succes, -1 if an error occurred. (POSIX described the 0 value too)

This function converts the character string src into a network address structure in the af address family, then copies the network address structure to dst. AF_INET (IPv4) case not supported.

inet_ntop#

const char * inet_ntop (int32_t af, const void * src, char * dst, socklen_t size)

Convert IPv6 addresses from binary to text form.

Returns

• It returns a non-null pointer to dst. NULL if an error occurred.

Converts the network address structure src in the af address family into a character string. The resulting string is copied to the buffer pointed to by dst, which must be a non-null pointer. The caller specifies the number of bytes available in this buffer in the argument size. AF_INET (IPv4) case not supported.

APP_LEVEL_SOCKET#

#define APP_LEVEL_SOCKET

SOL_APPLICATION

IPV6_ADDR_SIZE#

#define IPV6_ADDR_SIZE

16

Size of an IPv6 address.

SOCK_NONBLOCK#

#define SOCK_NONBLOCK

0X00010000

When bitwise ored with socket's type, it sets the O_NONBLOCK status flag on the opened socket file description.