Socket API#

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_protocol#

socket_protocol

IP protocols.

socket_type#

socket_type

Socket types.

cmsghdr_t#

typedef struct cmsghdr cmsghdr_t

Control messages.

in6_addr_t#

typedef struct in6_addr in6_addr_t

IPv6 Internet address.

in6_pktinfo_t#

typedef struct in6_pktinfo in6_pktinfo_t

Structure to store the IPv6 packet information.

iovec_t#

typedef struct iovec iovec_t

Structure to store scatter/gather array elements.

ip6_mtuinfo_t#

typedef struct ip6_mtuinfo ip6_mtuinfo_t

Structure to store the IPv6 MTU (Maximum Transmission Unit) information.

ipv6_mreq_t#

typedef struct ipv6_mreq ipv6_mreq_t

Structure to specify the multicast group and the interface.

msghdr_t#

typedef struct msghdr msghdr_t

The msghdr structure is used by the recvmsg() and sendmsg() functions.

sa_family_t#

typedef uint32_t sa_family_t

Address family.

sl_socket_domain_t#

typedef enum socket_domain sl_socket_domain_t

Supported address families.

sl_socket_protocol_t#

typedef enum socket_protocol sl_socket_protocol_t

IP protocols.

sl_socket_type_t#

typedef enum socket_type sl_socket_type_t

Socket types.

sl_wisun_socket_id_t#

typedef int sl_wisun_socket_id_t

Socket id.

sockaddr_in6_t#

typedef struct sockaddr_in6 sockaddr_in6_t

IPv6 address format.

socklen_t#

typedef uint32_t socklen_t

Socket address length type definition.

in6addr_any#

const in6_addr_t in6addr_any

IPv6 wildcard address.

accept#

int accept (int 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.

bind#

int bind (int 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.

close#

int close (int sockid)

Close a socket.

Returns

• 0 on success, -1 on failure.

Close a socket and remove from the socket handler storage.

connect#

int connect (int 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.

getpeername#

int getpeername (int socket, struct sockaddr *restrict address, socklen_t *restrict address_len)

Get the address of the peer connected to the socket.

This function retrieves the address of the peer connected to the specified socket. The peer's address is stored in the provided 'address' structure, and the length of the address is stored in 'address_len'.

Returns

• 0 on success, -1 on failure and sets errno appropriately.

getsockname#

int getsockname (int socket, struct sockaddr *restrict address, socklen_t *restrict address_len)

Retrieves the local address of a socket.

Returns

• On success, returns zero. On failure, returns -1 and sets errno appropriately.

This function retrieves the local address associated with a socket. It populates the provided address structure with the local address information.

getsockopt#

int getsockopt (int sockid, int level, int 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.

listen#

int listen (int sockid, int 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.

recv#

ssize_t recv (int sockid, void * buf, size_t len, int 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)

recvfrom#

ssize_t recvfrom (int sockid, void * buf, size_t len, int 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.

recvmsg#

ssize_t recvmsg (int socket, struct msghdr * message, int flags)

Receive a message from a socket.

Returns

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

This function is typically used with connectionless-mode sockets because it permits the application to retrieve the source address of received data.

send#

ssize_t send (int sockid, const void * buff, size_t len, int 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).

sendmsg#

ssize_t sendmsg (int socket, const struct msghdr * message, int flags)

Send a message through a connection-mode or connectionless-mode socket.

Returns

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

sendto#

ssize_t sendto (int sockid, const void * buff, size_t len, int 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).

setsockopt#

int setsockopt (int sockid, int level, int 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.

socket#

int socket (int domain, int type, int protocol)

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

Returns

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