WebSocketFrameContext Struct Reference

Frame encoding/decoding context. More...

#include <web_socket.h>

Data Fields

WebSocketSubState state
WebSocketFrameType dataFrameType
 FSM state. More...
WebSocketFrameType controlFrameType
 Control frame type. More...
bool_t fin
 Final fragment in a message. More...
bool_t mask
 Defines whether the payload data is masked. More...
uint8_t maskingKey [4]
 Masking key. More...
size_t payloadLen
 Payload length. More...
size_t payloadPos
 Current position. More...
uint8_t buffer [WEB_SOCKET_BUFFER_SIZE]
 Data buffer. More...
size_t bufferLen
 Length of the data buffer. More...
size_t bufferPos
 Current position. More...

Detailed Description

Frame encoding/decoding context.

Definition at line 394 of file web_socket.h.

Field Documentation

◆ buffer

uint8_t buffer[WEB_SOCKET_BUFFER_SIZE]

Data buffer.

Definition at line 404 of file web_socket.h.

◆ bufferLen

size_t bufferLen

Length of the data buffer.

Definition at line 405 of file web_socket.h.

◆ bufferPos

size_t bufferPos

Current position.

Definition at line 406 of file web_socket.h.

◆ controlFrameType

WebSocketFrameType controlFrameType

Control frame type.

Definition at line 398 of file web_socket.h.

◆ dataFrameType

WebSocketFrameType dataFrameType

FSM state.

Data frame type

Definition at line 397 of file web_socket.h.

◆ fin

bool_t fin

Final fragment in a message.

Definition at line 399 of file web_socket.h.

◆ mask

bool_t mask

Defines whether the payload data is masked.

Definition at line 400 of file web_socket.h.

◆ maskingKey

uint8_t maskingKey[4]

Masking key.

Definition at line 401 of file web_socket.h.

◆ payloadLen

size_t payloadLen

Payload length.

Definition at line 402 of file web_socket.h.

◆ payloadPos

size_t payloadPos

Current position.

Definition at line 403 of file web_socket.h.

◆ state

Definition at line 396 of file web_socket.h.

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