POSIX-compliant Socket#

in6addr_any#

const in6_addr_t in6addr_any

Definition of any address for IPv6.

socket#

int32_t socket (sock_domain_t domain, sock_type_t type, proto_type_t protocol)

Create an endpoint for communication and return a socket ID.

Socket API support Wi-SUN FAN and external IP network communications. External handlers can be implemented, the default implementations are weak functions. Created sockets added to socket handler automatically Returns

• if any error occurred, return with -1, otherwise return with the socket id

close#

int32_t close (int32_t sockid)

Close socket.

Close socket and remove from the socket handler storage Returns

• if any error occurred, return with -1, otherwise return with the socket id

bind#

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

Bind a name to a socket.

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

• On success, zero is returned. On error, -1 is returned

listen#

int32_t listen (int32_t sockid, int32_t backlog)

Listen for connections on a socket.

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 Returns

• On success, zero is returned. On error, -1 is returned

accept#

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

Accept a connection on a socket.

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

• On success, return with the socket id for accepted socket, on error -1 is returned.

connect#

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

Initiate a connection on a socket.

Connects the socket referred to by the socketid to the address specified by addr. Returns

• If the connection or binding succeeds, zero is returned. On error, -1 is returned.

send#

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

Send a message on a socket,.

It is preferred with connection-oriented sockets (TCP). Returns

• On success, these calls return the number of bytes sent. On error, -1 is returned

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 on a socket.

It is preferred in datagram mode (UDP). Returns

• On success, these calls return the number of bytes sent. On error, -1 is returned

recv#

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

Receive a message from a socket.

It should be used for connection-oriented protocol (TCP) Returns

• return the number of bytes received, or -1 if an error occurred

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.

It can be used to receive data on a socket whether or not it is connection-oriented. Returns

• return the number of bytes received, or -1 if an error occurred

setsockopt#

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

Set socket option.

This function can set socket properties. There are some limitation in Wi-SUN domain: optlen and level args are not used. optname and optval are casted to the corresponding Wi-SUN types: sl_wisun_socket_option_t and sl_wisun_socket_option_data_t. sl_wisun_socket_option_data_t is a union type to include all of implemented Wi-SUN socket options Returns

• Return 0 on succes, other wise -1

getsockopt#

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

Get socket option.

The function gets socket option by optname, and copy option data to optval ptr Returns

• Return 0 on success, other wise -1

htonl#

static uint32_t htonl (uint32_t hostlong)

Long host byte order to network order.

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

• Long network integer

htons#

static uint16_t htons (uint16_t hostshort)

Short host byte order to network order.

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

• Short network integer

ntohl#

static uint32_t ntohl (uint32_t netlong)

Long network byte order to host byte order.

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

• Long host integer

ntohs#

static uint16_t ntohs (uint16_t netshort)

Short network byte order to host byte order.

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

• Short host integer

inet_pton#

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

Convert IPv4 and IPv6 addresses from text to binary form.

It converts the character string src into a network address structure in the af address family, then copies the network address structure to dst For AF_WISUN or AF_INET6, stoip6(src, len, dst) called within the implementation AF_INET (IPv4) case not implemented. Returns

• 1 on succes, -1 on error (POSIX described the 0 value too)

inet_ntop#

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

Convert IPv4 and IPv6 addresses from binary to text form.

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. For AF_WISUN or AF_INET6, stoip6(src, len, dst) called within the implementation AF_INET (IPv4) case not implemented. Returns

• It returns a non-null pointer to dst. NULL is returned if there was an error

SOCKADDR_WISUN_FAMILY_OFFSET#

#define SOCKADDR_WISUN_FAMILY_OFFSET

(offsetof(wisun_addr_t, sin6_family))

Wi-SUN address structure offsets.

SOCKADDR_WISUN_PORT_OFFSET#

#define SOCKADDR_WISUN_PORT_OFFSET

(offsetof(wisun_addr_t, sin6_port))

SOCKADDR_WISUN_FLOWINFO_OFFSET#

#define SOCKADDR_WISUN_FLOWINFO_OFFSET

(offsetof(wisun_addr_t, sin6_flowinfo))

SOCKADDR_WISUN_ADDRESS_OFFSET#

#define SOCKADDR_WISUN_ADDRESS_OFFSET

(offsetof(wisun_addr_t, sin6_addr))

SOCKADDR_WISUN_SCOPEID_OFFSET#

#define SOCKADDR_WISUN_SCOPEID_OFFSET

(offsetof(wisun_addr_t, sin6_scope_id))

INADDR_ANY#

#define INADDR_ANY

(0UL)

Definition of any address for IPv4.