shell_websocket.h File Reference

Websocket shell backend. More...

#include <zephyr/net/socket.h>
#include <zephyr/net/http/server.h>
#include <zephyr/net/http/service.h>
#include <zephyr/shell/shell.h>

Go to the source code of this file.

Data Structures
struct	shell_websocket_line_buf
	Line buffer structure. More...
struct	shell_websocket
	WEBSOCKET-based shell transport. More...

Macros
#define	SHELL_WEBSOCKET_SERVICE_COUNT   CONFIG_SHELL_WEBSOCKET_BACKEND_COUNT
#define	GET_WS_NAME(_service)
#define	GET_WS_SHELL_NAME(_name)
#define	GET_WS_TRANSPORT_NAME(_service)
#define	GET_WS_DETAIL_NAME(_service)
#define	SHELL_WEBSOCKET_DEFINE(_service)
#define	SHELL_WS_PORT_NAME(_service)
#define	SHELL_WS_BUF_NAME(_service)
#define	SHELL_WS_TEMP_RECV_BUF_SIZE   256
#define	DEFINE_WEBSOCKET_HTTP_SERVICE(_service)
#define	DEFINE_WEBSOCKET_SERVICE(_service)
#define	WEBSOCKET_CONSOLE_DEFINE(_service, _sec_tag_list, _sec_tag_list_size)
#define	WEBSOCKET_CONSOLE_ENABLE(_service)

Functions
int	shell_websocket_setup (int ws_socket, struct http_request_ctx *request_ctx, void *user_data)
int	shell_websocket_enable (const struct shell *sh)

Variables
const struct shell_transport_api	shell_websocket_transport_api

Detailed Description

Websocket shell backend.

Macro Definition Documentation

DEFINE_WEBSOCKET_HTTP_SERVICE

#define DEFINE_WEBSOCKET_HTTP_SERVICE

(

_service

)

Value:

uint8_t SHELL_WS_BUF_NAME(_service)[SHELL_WS_TEMP_RECV_BUF_SIZE];       \
struct http_resource_detail_websocket                                   \
    GET_WS_DETAIL_NAME(_service) = {                                    \
        .common = {                                                     \
                .type = HTTP_RESOURCE_TYPE_WEBSOCKET,                   \
                                                                        \
                /* We need HTTP/1.1 GET method for upgrading */         \
                .bitmask_of_supported_http_methods = BIT(HTTP_GET),     \
        },                                                              \
        .cb = shell_websocket_setup,                                    \
        .data_buffer = SHELL_WS_BUF_NAME(_service),                     \
        .data_buffer_len = sizeof(SHELL_WS_BUF_NAME(_service)),         \
        .user_data = &GET_WS_NAME(_service),                            \
};                                                                      \
HTTP_RESOURCE_DEFINE(ws_resource_##_service, _service,                  \
                     "/" CONFIG_SHELL_WEBSOCKET_ENDPOINT_URL,           \
                     &GET_WS_DETAIL_NAME(_service))

DEFINE_WEBSOCKET_SERVICE

#define DEFINE_WEBSOCKET_SERVICE

(

_service

)

Value:

SHELL_WEBSOCKET_DEFINE(_service);                                       \
SHELL_DEFINE(shell_websocket_##_service,                                \
             CONFIG_SHELL_WEBSOCKET_PROMPT,                             \
             &GET_WS_TRANSPORT_NAME(_service),                          \
             CONFIG_SHELL_WEBSOCKET_LOG_MESSAGE_QUEUE_SIZE,             \
             CONFIG_SHELL_WEBSOCKET_LOG_MESSAGE_QUEUE_TIMEOUT,          \
             SHELL_FLAG_OLF_CRLF);                                      \
DEFINE_WEBSOCKET_HTTP_SERVICE(_service)

GET_WS_DETAIL_NAME

#define GET_WS_DETAIL_NAME

(

_service

)

Value:

ws_res_detail_##_service

GET_WS_NAME

#define GET_WS_NAME

(

_service

)

Value:

ws_ctx_##_service

GET_WS_SHELL_NAME

#define GET_WS_SHELL_NAME

(

_name

)

Value:

shell_websocket_##_name

GET_WS_TRANSPORT_NAME

#define GET_WS_TRANSPORT_NAME

(

_service

)

Value:

transport_shell_ws_##_service

SHELL_WEBSOCKET_DEFINE

#define SHELL_WEBSOCKET_DEFINE

(

_service

)

Value:

static struct shell_websocket GET_WS_NAME(_service);                    \
static struct shell_transport GET_WS_TRANSPORT_NAME(_service) = {       \
        .api = &shell_websocket_transport_api,                          \
        .ctx = &GET_WS_NAME(_service),                                  \
}

SHELL_WEBSOCKET_SERVICE_COUNT

#define SHELL_WEBSOCKET_SERVICE_COUNT   CONFIG_SHELL_WEBSOCKET_BACKEND_COUNT

SHELL_WS_BUF_NAME

#define SHELL_WS_BUF_NAME

(

_service

)

Value:

ws_recv_buffer_##_service

SHELL_WS_PORT_NAME

#define SHELL_WS_PORT_NAME

(

_service

)

Value:

http_service_##_service

SHELL_WS_TEMP_RECV_BUF_SIZE

#define SHELL_WS_TEMP_RECV_BUF_SIZE   256

WEBSOCKET_CONSOLE_DEFINE

#define WEBSOCKET_CONSOLE_DEFINE	(		_service,
			_sec_tag_list,
			_sec_tag_list_size )

Value:

static uint16_t SHELL_WS_PORT_NAME(_service) =                  \
        CONFIG_SHELL_WEBSOCKET_PORT;                            \
HTTP_SERVICE_DEFINE(_service,                                   \
                    CONFIG_SHELL_WEBSOCKET_IP_ADDR,             \
                    &SHELL_WS_PORT_NAME(_service),              \
                    SHELL_WEBSOCKET_SERVICE_COUNT,              \
                    SHELL_WEBSOCKET_SERVICE_COUNT,              \
                    NULL, NULL, NULL);                          \
DEFINE_WEBSOCKET_SERVICE(_service)

WEBSOCKET_CONSOLE_ENABLE

#define WEBSOCKET_CONSOLE_ENABLE

(

_service

)

Value:

(void)shell_websocket_enable(&GET_WS_SHELL_NAME(_service))

Function Documentation

shell_websocket_enable()

int shell_websocket_enable

(

const struct shell *

sh

)

shell_websocket_setup()

int shell_websocket_setup	(	int	ws_socket,
		struct http_request_ctx *	request_ctx,
		void *	user_data )

Variable Documentation

shell_websocket_transport_api

const struct shell_transport_api shell_websocket_transport_api

extern