WebSocketFrame Class Reference

A representation of a single WebSocket frame. More...

#include <libmythupnp/websocket.h>

Public Types
enum	OpCode : std::uint8_t {   kOpContinuation = 0x0, kOpTextFrame = 0x1, kOpBinaryFrame = 0x2, kOpClose = 0x8,   kOpPing = 0x9, kOpPong = 0xA }

Public Member Functions
	WebSocketFrame ()
	~WebSocketFrame ()
void	reset (void)

Public Attributes
bool	m_finalFrame {false}
QByteArray	m_payload
uint64_t	m_payloadSize {0}
OpCode	m_opCode {kOpTextFrame}
bool	m_isMasked {false}
QByteArray	m_mask
bool	m_fragmented {false}

Detailed Description

A representation of a single WebSocket frame.

Definition at line 76 of file websocket.h.

Member Enumeration Documentation

OpCode

enum WebSocketFrame::OpCode : std::uint8_t

Enumerator
kOpContinuation
kOpTextFrame
kOpBinaryFrame
kOpClose
kOpPing
kOpPong

Definition at line 102 of file websocket.h.

Constructor & Destructor Documentation

WebSocketFrame()

WebSocketFrame::WebSocketFrame ( )

inline

Definition at line 79 of file websocket.h.

~WebSocketFrame()

WebSocketFrame::~WebSocketFrame ( )

inline

Definition at line 84 of file websocket.h.

Member Function Documentation

reset()

void WebSocketFrame::reset ( void  )

inline

Definition at line 90 of file websocket.h.

Referenced by WebSocketWorker::HandleDataFrame(), and WebSocketWorker::ProcessFrames().

Member Data Documentation

m_finalFrame

bool WebSocketFrame::m_finalFrame {false}

Definition at line 114 of file websocket.h.

Referenced by WebSocketWorker::HandleDataFrame(), WebSocketWorker::ProcessFrames(), and reset().

m_payload

QByteArray WebSocketFrame::m_payload

Definition at line 115 of file websocket.h.

Referenced by WebSocketWorker::HandleDataFrame(), WebSocketMythEvent::HandleTextFrame(), WebSocketWorker::ProcessFrames(), reset(), and ~WebSocketFrame().

m_payloadSize

uint64_t WebSocketFrame::m_payloadSize {0}

Definition at line 116 of file websocket.h.

Referenced by WebSocketWorker::HandleDataFrame(), WebSocketWorker::ProcessFrames(), and reset().

m_opCode

OpCode WebSocketFrame::m_opCode {kOpTextFrame}

Definition at line 117 of file websocket.h.

Referenced by WebSocketWorker::HandleDataFrame(), WebSocketWorker::ProcessFrames(), and reset().

m_isMasked

bool WebSocketFrame::m_isMasked {false}

Definition at line 118 of file websocket.h.

Referenced by WebSocketWorker::ProcessFrames().

m_mask

QByteArray WebSocketFrame::m_mask

Definition at line 119 of file websocket.h.

Referenced by WebSocketWorker::ProcessFrames(), reset(), WebSocketFrame(), and ~WebSocketFrame().

m_fragmented

bool WebSocketFrame::m_fragmented {false}

Definition at line 120 of file websocket.h.

Referenced by WebSocketWorker::HandleDataFrame(), WebSocketWorker::ProcessFrames(), and reset().

---

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

• mythtv/libs/libmythupnp/websocket.h