SiWx91x Sockets#

receive_data_callback#

receive_data_callback )(uint32_t socket, uint8_t *buffer, uint32_t length, const sl_si91x_socket_metadata_t *firmware_socket_response)

This callback is used to read data asynchronously from a socket.

It is registered when the sl_si91x_socket_async API is called. Returns

• N/A

accept_callback#

accept_callback )(int32_t socket, struct sockaddr *addr, uint8_t ip_version)

This callback is used to provide the parameters of a newly accepted connection.

It is registered when the sl_si91x_accept_async API is called. Returns

• N/A

data_transfer_complete_handler#

data_transfer_complete_handler )(int32_t socket, uint16_t length)

This callback is used to indicate the status of a data transfer.

It is registered when either the sl_si91x_send_async or sl_si91x_sendto_async API is called. Returns

• N/A

select_callback#

select_callback )(fd_set *fd_read, fd_set *fd_write, fd_set *fd_except, int32_t status)

This callback is used to indicate when an asynchronous response reaches the select request.

It is registered when the sl_si91x_select API is called. Returns

• N/A

remote_socket_termination_callback#

remote_socket_termination_callback )(int socket, uint16_t port, uint32_t bytes_sent)

This callback is used to indicate when a remote socket is terminated.

It is registered when the sl_si91x_set_remote_termination_callback API is called. Returns

• N/A

sl_si91x_socket#

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

Creates a new socket.

Returns

• int

sl_si91x_socket_async#

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

Creates an asynchronous socket and registers the provided callback.

Returns

• int

sl_si91x_setsockopt_async#

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

Sets a 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)

Assigns a local protocol address to a socket.

Returns

• int

sl_si91x_listen#

int sl_si91x_listen (int socket, int max_number_of_clients)

Enables a socket to listen for remote connection requests in passive mode.

Returns

• int

sl_si91x_accept#

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

Accepts a connection request from a remote peer.

This function blocks until a client attempts to connect to the server socket. After receiving a connection request, it proceeds.

Returns

• int

sl_si91x_accept_async#

int sl_si91x_accept_async (int socket, accept_callback callback)

Accepts a connection request from the remote peer and registers a callback.

This function sets up the server socket to listen for incoming connections and immediately returns 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)

Initiates 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)

Sends the data to the remote peer on the given socket.

This should be used only when the socket is in a connected state.

Returns

• int

Note

• The flags parameter is not currently supported.

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)

Transmits one or more messages to a socket asynchronously.

This should be used only when the socket is in a connected state.

Returns

• int

Note

• The flags parameter is not currently supported.

sl_si91x_sendto#

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

Transmits 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 flags parameter is not currently supported.

sl_si91x_sendto_async#

int sl_si91x_sendto_async (int socket, const 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)

Transmits one or more messages to another socket asynchronously and receives acknowledgement through the registered callback.

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

Returns

• int

Note

• The flags parameter is not currently supported.

sl_si91x_send_large_data#

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

Sends the data that is greater than MSS size.

Returns

• int

Note

• The flags parameter is not currently supported.

sl_si91x_recv#

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

Receives data from a connected socket.

Returns

• int

Note

• The flags parameter is not currently supported.

sl_si91x_recvfrom#

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

Receives data from an unconnected socket typically like a UDP socket.

Returns

• int

Note

• The flags parameter is not currently supported.

sl_si91x_shutdown#

int sl_si91x_shutdown (int socket, int how)

Disables send or receive on a socket.

Returns

• int

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, const struct timeval * timeout, select_callback callback)

Monitors multiple file descriptors, including sockets, for various I/O events, such as readiness for reading or writing, and exceptional conditions.

select() allows a program to monitor multiple file descriptors, waiting until one or more of the file descriptors become "ready" for some class of I/O operation (e.g., input possible). A file descriptor is considered ready if it is possible to perform a corresponding I/O operation without blocking.

Returns

• int

Note

• The readfds and writefds parameters are modified in the case of callback being NULL. The exceptfds parameter is not currently supported.

sl_si91x_set_remote_termination_callback#

void sl_si91x_set_remote_termination_callback (remote_socket_termination_callback callback)

Register callback for remote socket termination event.

sl_si91x_set_custom_sync_sockopt#

int sl_si91x_set_custom_sync_sockopt (int socket_id, int option_level, int option_name, const void * option_value, socklen_t option_length)

Set SiWx91X specific socket options.

Returns

• 
  Returns 0 on success or -1 on error (in which case, errno is set appropriately).

sl_si91x_get_custom_sync_sockopt#

int sl_si91x_get_custom_sync_sockopt (int socket_id, int option_level, int option_name, void * option_value, socklen_t * option_length)

Get SiWx91X specific socket options.

Returns

• 
  Returns 0 on success, or -1 on error (in which case, errno is set appropriately).

sl_si91x_get_socket_info#

sl_status_t sl_si91x_get_socket_info (sl_si91x_socket_info_response_t * socket_info_response)

Retrieve information about currently opened sockets from the network stack.

Returns

• sl_status_t

Note

• The socket IDs in the response are specific to the firmware and should not be used as file descriptors in socket APIs.

sl_si91x_get_socket_mss#

int16_t sl_si91x_get_socket_mss (int32_t socketIndex)

Retrieves the Maximum Segment Size (MSS) for a specific socket.

The MSS is the largest amount of data, specified in bytes, that a computer or communications device can handle in a single, unfragmented piece. Returns

• Returns an int16_t value representing the MSS of the specified socket in bytes.