SiWx91x Sockets#

sl_si91x_socket_async#

int sl_si91x_socket_async (int family, int type, int protocol, receive_data_callback callback)

This sl_si91x_socket_async() function creates an asynchronous socket and registers the provided callback.

Returns

• int

sl_si91x_socket#

int sl_si91x_socket (int family, int type, int protocol)

The sl_si91x_socket() function creates a new socket.

Returns

• int

sl_si91x_setsockopt_async#

int sl_si91x_setsockopt_async (int32_t sockID, int level, int option_name, const void * option_value, socklen_t option_len)

The sl_si91x_setsockopt_async() function's purpose would be to set the specified socket option on the identified socket asynchronously.

Returns

• int

sl_si91x_bind#

int sl_si91x_bind (int socket, const struct sockaddr * addr, socklen_t addr_len)

The sl_si91x_bind() api assigns the local protocol address to a socket.

Returns

• int

sl_si91x_listen#

int sl_si91x_listen (int socket, int max_number_of_clients)

The sl_si91x_listen() function listen for socket connections.

Returns

• int

sl_si91x_accept#

int sl_si91x_accept (int socket, const struct sockaddr * addr, socklen_t addr_len)

The purpose of the sl_si91x_accept function is to block until a client attempts to connect to the server socket, once a connection request is received.

Returns

• int

sl_si91x_accept_async#

int sl_si91x_accept_async (int socket, accept_callback callback)

The sl_si91x_accept_async() api primary purpose is to set up the server socket to listen for incoming connections and immediately return without blocking the main program's execution.

Returns

• int

sl_si91x_connect#

int sl_si91x_connect (int socket, const struct sockaddr * addr, socklen_t addr_len)

The purpose of this sl_si91x_connect() function is to initiate a connection to a remote socket specified by the addr parameter.

Returns

• int

sl_si91x_send#

int sl_si91x_send (int socket, const uint8_t * buffer, size_t buffer_length, int32_t flags)

The sl_si91x_send() function is used to transmit one or more messages to a socket.

The sl_si91x_send() function may be used only when the socket is in a connected state. Returns

• int

Note

• The argument flags are not supported currently.

sl_si91x_send_async#

int sl_si91x_send_async (int socket, const uint8_t * buffer, size_t buffer_length, int32_t flags, data_transfer_complete_handler callback)

The sl_si91x_send_async() function is used to transmit one or more messages to a socket asynchronously.

The sl_si91x_send_async() function may be used only when the socket is in a connected state. Returns

• int

Note

• The argument flags are not supported currently.

sl_si91x_sendto#

int sl_si91x_sendto (int socket, uint8_t * buffer, size_t buffer_length, int32_t flags, const struct sockaddr * addr, socklen_t addr_len)

The sl_si91x_sendto() function is used to transmit one or more messages to another socket.

The function can also be called from an unconnected socket typically like a UDP socket. Returns

• int

Note

• The argument flags are not supported currently.

sl_si91x_sendto_async#

int sl_si91x_sendto_async (int socket, uint8_t * buffer, size_t buffer_length, int32_t flags, const struct sockaddr * to_addr, socklen_t to_addr_len, data_transfer_complete_handler callback)

The sl_si91x_sendto_async() function is used to transmit one or more messages to another socket asynchronously.

The function can also be called from an unconnected socket typically like a UDP socket. Returns

• int

Note

• The argument flags are not supported currently.

sl_si91x_send_large_data#

int sl_si91x_send_large_data (int socket, const uint8_t * buffer, size_t buffer_length, int32_t flags)

Basically sl_si91x_send_large_data() function is used to send the data that is greater than MSS size.

Returns

• int

Note

• The argument flags are not supported currently.

sl_si91x_recv#

int sl_si91x_recv (int socket, uint8_t * buffer, size_t bufferLength, int32_t flags)

The purpose of the sl_si91x_recv function is to receive data from a connected socket.

Returns

• int

Note

• The argument flags are not supported currently.

sl_si91x_recvfrom#

int sl_si91x_recvfrom (int socket, uint8_t * buffer, size_t buffersize, int32_t flags, struct sockaddr * fromAddr, socklen_t * fromAddrLen)

The purpose of the sl_si91x_recvfrom function is to receive data from an unconnected socket typically like a UDP socket.

Returns

• int

Note

• The argument flags are not supported currently.

sl_si91x_shutdown#

int sl_si91x_shutdown (int socket, int how)

The purpose of the sl_si91x_shutdown is to disable sends or receives on a socket.

Note

• In case of socket being a server socket, the "how" parameter would be ignored and socket shall always be closed based on port number.

sl_si91x_select#

int sl_si91x_select (int nfds, fd_set * readfds, fd_set * writefds, fd_set * exceptfds, struct timeval * timeout, select_callback callback)

The purpose of the sl_si91x_select function is to monitor multiple file descriptors, including sockets, for various I/O events, such as readiness for reading or writing, and exceptional conditions.

It allows you to efficiently manage multiple sockets and determine when they are available for specific I/O operations. Returns

• int

Note

• The readfds, writefds are modified incase of callback being NULL. exceptfds are not currently being supported.

sl_si91x_set_remote_termination_callback#

void sl_si91x_set_remote_termination_callback (remote_socket_termination_callback callback)

A function to register callback for remote socket termination event.