WsConn Struct Reference

WebSocket connection state stored in ws_pool[]. More...

#include <websocket.h>

Public Attributes
uint8_t	ws_id
	Index into ws_pool[] (set at init).
uint8_t	slot_id
	Owning TCP slot in conn_pool[].
bool	active
	True when this entry is in use.
WsParseState	parse_state
	Current frame parser state.
WsOpcode	opcode
	Opcode of the frame being parsed.
bool	fin
	FIN bit of the frame being parsed.
bool	masked
	True if client sent a masking key.
uint8_t	mask_key [4]
	Client masking key.
uint32_t	payload_len
	Expected payload byte count.
uint32_t	payload_idx
	Bytes received so far.
uint8_t	len64_count
	Bytes consumed from 64-bit length.
uint8_t	buf [WS_FRAME_SIZE+1]
	Unmasked payload, null-terminated.

Detailed Description

WebSocket connection state stored in ws_pool[].

Allocated when an HTTP upgrade handshake succeeds. slot_id ties this entry back to conn_pool[] and the ring buffer.

Definition at line 118 of file websocket.h.

Member Data Documentation

ws_id

uint8_t WsConn::ws_id

Index into ws_pool[] (set at init).

Definition at line 120 of file websocket.h.

Referenced by DetWebServer::handle(), ws_alloc(), ws_free(), and ws_init().

slot_id

uint8_t WsConn::slot_id

Owning TCP slot in conn_pool[].

Definition at line 121 of file websocket.h.

Referenced by ws_alloc(), ws_close(), ws_parse(), and ws_send_frame().

active

bool WsConn::active

True when this entry is in use.

Definition at line 122 of file websocket.h.

Referenced by ws_alloc().

parse_state

WsParseState WsConn::parse_state

Current frame parser state.

Definition at line 124 of file websocket.h.

Referenced by DetWebServer::handle(), ws_alloc(), ws_close(), ws_parse(), and ws_reset_frame().

opcode

WsOpcode WsConn::opcode

Opcode of the frame being parsed.

Definition at line 125 of file websocket.h.

Referenced by ws_parse(), and ws_reset_frame().

fin

bool WsConn::fin

FIN bit of the frame being parsed.

Definition at line 126 of file websocket.h.

Referenced by ws_parse(), and ws_reset_frame().

masked

bool WsConn::masked

True if client sent a masking key.

Definition at line 127 of file websocket.h.

Referenced by ws_parse(), and ws_reset_frame().

mask_key

uint8_t WsConn::mask_key[4]

Client masking key.

Definition at line 129 of file websocket.h.

Referenced by ws_parse(), and ws_reset_frame().

payload_len

uint32_t WsConn::payload_len

Expected payload byte count.

Definition at line 130 of file websocket.h.

Referenced by ws_parse(), and ws_reset_frame().

payload_idx

uint32_t WsConn::payload_idx

Bytes received so far.

Definition at line 131 of file websocket.h.

Referenced by ws_parse(), and ws_reset_frame().

len64_count

uint8_t WsConn::len64_count

Bytes consumed from 64-bit length.

Definition at line 132 of file websocket.h.

Referenced by ws_parse(), and ws_reset_frame().

buf

uint8_t WsConn::buf[WS_FRAME_SIZE+1]

Unmasked payload, null-terminated.

Definition at line 133 of file websocket.h.

Referenced by ws_parse(), and ws_reset_frame().

---

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

• src/network_drivers/websocket.h