websockets::WebsocketsMessage Struct Reference

#include <message.h>

Classes
class	StreamBuilder

Public Member Functions
	WebsocketsMessage (MessageType msgType, const std::string &msgData, MessageRole msgRole=MessageRole::Complete)
	WebsocketsMessage ()
bool	isEmpty () const
MessageType	type () const
bool	isText () const
bool	isBinary () const
bool	isPing () const
bool	isPong () const
bool	isClose () const
MessageRole	role () const
bool	isComplete () const
bool	isPartial () const
bool	isFirst () const
bool	isContinuation () const
bool	isLast () const
std::string	data () const
const std::string &	rawData () const
const char *	c_str () const
uint32_t	length () const

Static Public Member Functions
static WebsocketsMessage	CreateFromFrame (internals::WebsocketsFrame frame, MessageType overrideType=MessageType::Empty)

Detailed Description

Definition at line 29 of file message.h.

Constructor & Destructor Documentation

WebsocketsMessage() [1/2]

websockets::WebsocketsMessage::WebsocketsMessage ( MessageType msgType, const std::string & msgData, MessageRole msgRole = MessageRole::Complete )

inline

Definition at line 30 of file message.h.

WebsocketsMessage() [2/2]

websockets::WebsocketsMessage::WebsocketsMessage ( )

inline

Definition at line 31 of file message.h.

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

Member Function Documentation

c_str()

const char * websockets::WebsocketsMessage::c_str ( ) const

inline

Definition at line 81 of file message.h.

CreateFromFrame()

static WebsocketsMessage websockets::WebsocketsMessage::CreateFromFrame ( internals::WebsocketsFrame frame, MessageType overrideType = MessageType::Empty )

inlinestatic

Definition at line 33 of file message.h.

References websockets::Complete, websockets::Continuation, websockets::Empty, websockets::First, websockets::internals::WebsocketsFrame::isBeginningOfFragmentsStream(), websockets::internals::WebsocketsFrame::isContinuesFragment(), websockets::internals::WebsocketsFrame::isEndOfFragmentsStream(), websockets::internals::WebsocketsFrame::isNormalUnfragmentedMessage(), websockets::Last, websockets::messageTypeFromOpcode(), websockets::internals::WebsocketsFrame::opcode, websockets::internals::WebsocketsFrame::payload, type(), and WebsocketsMessage().

data()

std::string websockets::WebsocketsMessage::data ( ) const

inline

Definition at line 79 of file message.h.

References websockets::internals::fromInternalString().

isBinary()

bool websockets::WebsocketsMessage::isBinary ( ) const

inline

Definition at line 61 of file message.h.

References websockets::Binary.

isClose()

bool websockets::WebsocketsMessage::isClose ( ) const

inline

Definition at line 66 of file message.h.

References websockets::Close.

isComplete()

bool websockets::WebsocketsMessage::isComplete ( ) const

inline

Definition at line 72 of file message.h.

References websockets::Complete.

isContinuation()

bool websockets::WebsocketsMessage::isContinuation ( ) const

inline

Definition at line 75 of file message.h.

References websockets::Continuation.

isEmpty()

bool websockets::WebsocketsMessage::isEmpty ( ) const

inline

Definition at line 55 of file message.h.

References websockets::Empty.

isFirst()

bool websockets::WebsocketsMessage::isFirst ( ) const

inline

Definition at line 74 of file message.h.

References websockets::First.

isLast()

bool websockets::WebsocketsMessage::isLast ( ) const

inline

Definition at line 76 of file message.h.

References websockets::Last.

isPartial()

bool websockets::WebsocketsMessage::isPartial ( ) const

inline

Definition at line 73 of file message.h.

References websockets::Complete.

isPing()

bool websockets::WebsocketsMessage::isPing ( ) const

inline

Definition at line 63 of file message.h.

References websockets::Ping.

isPong()

bool websockets::WebsocketsMessage::isPong ( ) const

inline

Definition at line 64 of file message.h.

References websockets::Pong.

isText()

bool websockets::WebsocketsMessage::isText ( ) const

inline

Definition at line 60 of file message.h.

References websockets::Text.

length()

uint32_t websockets::WebsocketsMessage::length ( ) const

inline

Definition at line 83 of file message.h.

rawData()

const std::string & websockets::WebsocketsMessage::rawData ( ) const

inline

Definition at line 80 of file message.h.

role()

MessageRole websockets::WebsocketsMessage::role ( ) const

inline

Definition at line 70 of file message.h.

type()

MessageType websockets::WebsocketsMessage::type ( ) const

inline

Definition at line 58 of file message.h.

Referenced by CreateFromFrame().

---

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

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