esp_transport_ws_config_t struct

WS transport configuration structure

Syntax

Show:

Summary

Declaration

from esp_transport_ws.h:32

typedef struct { const char *ws_path; const char *sub_protocol; const char *user_agent; const char *headers; const char *auth; bool propagate_control_frames; } esp_transport_ws_config_t;

Fields

Field

Declared as

Description

esp_transport_ws_config_t::ws_path

const char *

HTTP path to update protocol to websocket.

esp_transport_ws_config_t::sub_protocol

const char *

WS subprotocol.

esp_transport_ws_config_t::user_agent

const char *

WS user agent.

esp_transport_ws_config_t::headers

const char *

WS additional headers.

esp_transport_ws_config_t::auth

const char *

HTTP authorization header.

esp_transport_ws_config_t::propagate_control_frames

bool

If true, control frames are passed to the reader If false, only user frames are propagated, control frames are handled automatically during read operations.