WEBSOCKET-based shell transport. More...

#include <zephyr/shell/shell_websocket.h>

Data Fields
shell_transport_handler_t	shell_handler
	Handler function registered by shell.
void *	shell_context
	Context registered by shell.
struct shell_websocket_line_buf	line_out
	Buffer for outgoing line.
struct zsock_pollfd	fds [1]
	Array for sockets used by the websocket service.
uint8_t	rx_buf [CONFIG_SHELL_CMD_BUFF_SIZE]
	Input buffer.
size_t	rx_len
	Number of data bytes within the input buffer.
struct k_mutex	rx_lock
	Mutex protecting the input buffer access.
struct k_work_delayable	send_work
	The delayed work is used to send non-lf terminated output that has been around for "too long".
struct k_work_sync	work_sync
bool	output_lock
	If set, no output is sent to the WEBSOCKET client.

Detailed Description

WEBSOCKET-based shell transport.

Field Documentation

◆ fds

struct zsock_pollfd shell_websocket::fds[1]

Array for sockets used by the websocket service.

◆ line_out

struct shell_websocket_line_buf shell_websocket::line_out

Buffer for outgoing line.

◆ output_lock

bool shell_websocket::output_lock

If set, no output is sent to the WEBSOCKET client.

◆ rx_buf

uint8_t shell_websocket::rx_buf[CONFIG_SHELL_CMD_BUFF_SIZE]

Input buffer.

◆ rx_len

size_t shell_websocket::rx_len

Number of data bytes within the input buffer.

◆ rx_lock

struct k_mutex shell_websocket::rx_lock

Mutex protecting the input buffer access.

◆ send_work

struct k_work_delayable shell_websocket::send_work

The delayed work is used to send non-lf terminated output that has been around for "too long".

This will prove to be useful to send the shell prompt for instance.

◆ shell_context

void* shell_websocket::shell_context

Context registered by shell.

◆ shell_handler

shell_transport_handler_t shell_websocket::shell_handler

Handler function registered by shell.

◆ work_sync

struct k_work_sync shell_websocket::work_sync

The documentation for this struct was generated from the following file:

zephyr/shell/shell_websocket.h

Data Fields