websockets::internals::WebsocketsFrame Struct Reference

#include <data_frame.h>

Collaboration diagram for websockets::internals::WebsocketsFrame:

Public Member Functions
bool	isControlFrame ()
bool	isEmpty ()
bool	isBeginningOfFragmentsStream () const
bool	isContinuesFragment () const
bool	isEndOfFragmentsStream () const
bool	isNormalUnfragmentedMessage () const

Public Attributes
uint8_t	fin: 1
uint8_t	opcode: 4
uint8_t	mask: 1
uint8_t	mask_buf [4]
uint64_t	payload_length
std::string	payload

Detailed Description

Definition at line 22 of file data_frame.h.

Member Function Documentation

isBeginningOfFragmentsStream()

bool websockets::internals::WebsocketsFrame::isBeginningOfFragmentsStream ( ) const

inline

Definition at line 38 of file data_frame.h.

References fin, and opcode.

Referenced by websockets::WebsocketsMessage::CreateFromFrame(), and websockets::WebsocketsMessage::StreamBuilder::first().

isContinuesFragment()

bool websockets::internals::WebsocketsFrame::isContinuesFragment ( ) const

inline

Definition at line 42 of file data_frame.h.

References fin, and opcode.

Referenced by websockets::WebsocketsMessage::StreamBuilder::append(), and websockets::WebsocketsMessage::CreateFromFrame().

isControlFrame()

bool websockets::internals::WebsocketsFrame::isControlFrame ( )

inline

Definition at line 30 of file data_frame.h.

References fin, and opcode.

isEmpty()

bool websockets::internals::WebsocketsFrame::isEmpty ( )

inline

Definition at line 34 of file data_frame.h.

References fin, opcode, and payload_length.

isEndOfFragmentsStream()

bool websockets::internals::WebsocketsFrame::isEndOfFragmentsStream ( ) const

inline

Definition at line 46 of file data_frame.h.

References fin, and opcode.

Referenced by websockets::WebsocketsMessage::CreateFromFrame(), and websockets::WebsocketsMessage::StreamBuilder::end().

isNormalUnfragmentedMessage()

bool websockets::internals::WebsocketsFrame::isNormalUnfragmentedMessage ( ) const

inline

Definition at line 50 of file data_frame.h.

References fin, and opcode.

Referenced by websockets::WebsocketsMessage::CreateFromFrame().

Member Data Documentation

fin

uint8_t websockets::internals::WebsocketsFrame::fin

Definition at line 23 of file data_frame.h.

Referenced by isBeginningOfFragmentsStream(), isContinuesFragment(), isControlFrame(), isEmpty(), isEndOfFragmentsStream(), and isNormalUnfragmentedMessage().

mask

uint8_t websockets::internals::WebsocketsFrame::mask

Definition at line 25 of file data_frame.h.

mask_buf

uint8_t websockets::internals::WebsocketsFrame::mask_buf[4]

Definition at line 26 of file data_frame.h.

opcode

uint8_t websockets::internals::WebsocketsFrame::opcode

Definition at line 24 of file data_frame.h.

Referenced by websockets::WebsocketsMessage::CreateFromFrame(), websockets::WebsocketsMessage::StreamBuilder::first(), isBeginningOfFragmentsStream(), isContinuesFragment(), isControlFrame(), isEmpty(), isEndOfFragmentsStream(), and isNormalUnfragmentedMessage().

payload

std::string websockets::internals::WebsocketsFrame::payload

Definition at line 28 of file data_frame.h.

Referenced by websockets::WebsocketsMessage::StreamBuilder::append(), websockets::WebsocketsMessage::CreateFromFrame(), websockets::WebsocketsMessage::StreamBuilder::end(), and websockets::WebsocketsMessage::StreamBuilder::first().

payload_length

uint64_t websockets::internals::WebsocketsFrame::payload_length

Definition at line 27 of file data_frame.h.

Referenced by isEmpty().

---

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

• lib/communication/src/websockets/data_frame.h