You are viewing documentation for version:
WebSocket client configuration structure.
This structure holds the configuration parameters for initializing a WebSocket client.
Public Attributes#
char *
WebSocket server host (for example, "example.com").
char *
WebSocket resource path (for example, "/chat").
uint16_t
WebSocket server port number.
uint16_t
Local client port number.
char *
WebSocket server IP address.
sl_si91x_socket_receive_data_callback_t
Data receive callback function.
sl_si91x_socket_remote_termination_callback_t
Callback function for remote termination event.
bool
Enable SSL for WebSocket connection.
Public Attribute Documentation#
host#
char* sl_websocket_config_t::host
WebSocket server host (for example, "example.com").
resource#
char* sl_websocket_config_t::resource
WebSocket resource path (for example, "/chat").
server_port#
uint16_t sl_websocket_config_t::server_port
WebSocket server port number.
client_port#
uint16_t sl_websocket_config_t::client_port
Local client port number.
ip_address#
char* sl_websocket_config_t::ip_address
WebSocket server IP address.
data_cb#
sl_si91x_socket_receive_data_callback_t sl_websocket_config_t::data_cb
Data receive callback function.
remote_terminate_cb#
sl_si91x_socket_remote_termination_callback_t sl_websocket_config_t::remote_terminate_cb
Callback function for remote termination event.
enable_ssl#
bool sl_websocket_config_t::enable_ssl
Enable SSL for WebSocket connection.