Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

WebSocketFrameContext Struct Reference

WebSocketFrameContext Struct Reference

Frame encoding/decoding context. More...

#include <web_socket.h>

Data Fields

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

Detailed Description

Frame encoding/decoding context.

Definition at line 387 of file web_socket.h.


Field Documentation

uint8_t buffer[WEB_SOCKET_BUFFER_SIZE]

Data buffer.

Definition at line 397 of file web_socket.h.

size_t bufferLen

Length of the data buffer.

Definition at line 398 of file web_socket.h.

size_t bufferPos

Current position.

Definition at line 399 of file web_socket.h.

Control frame type.

Definition at line 391 of file web_socket.h.

FSM state.

Data frame type

Definition at line 390 of file web_socket.h.

bool_t fin

Final fragment in a message.

Definition at line 392 of file web_socket.h.

bool_t mask

Defines whether the payload data is masked.

Definition at line 393 of file web_socket.h.

uint8_t maskingKey[4]

Masking key.

Definition at line 394 of file web_socket.h.

size_t payloadLen

Payload length.

Definition at line 395 of file web_socket.h.

size_t payloadPos

Current position.

Definition at line 396 of file web_socket.h.