WebSocketFramer

#include <websocket.h>

class WebSocketFramer

Defined in src/http/include/icy/http/websocket.h:156

Friends

Name	Description
`WebSocketAdapter`
`wsFramerTestAccess`
`wsFramerGetFlags`

WebSocketAdapter

friend class WebSocketAdapter

Defined in src/http/include/icy/http/websocket.h:253

wsFramerTestAccess

friend void wsFramerTestAccess(WebSocketFramer & f, int state)

Defined in src/http/include/icy/http/websocket.h:256

wsFramerGetFlags

friend int wsFramerGetFlags(const WebSocketFramer & f)

Defined in src/http/include/icy/http/websocket.h:257

Public Methods

Return	Name	Description
	`WebSocketFramer`	Creates a WebSocketFramer operating in the given endpoint mode. Client-side framers mask outgoing payloads; server-side framers do not.
	`~WebSocketFramer` virtual
`size_t`	`writeFrame` virtual	Encodes `data` into a WebSocket frame and writes it to `frame`.
`uint64_t`	`readFrame` virtual	Decodes a single WebSocket frame from `frame`.
`bool`	`handshakeComplete` const nodiscard	Returns true if the WebSocket handshake has completed successfully.
`void`	`acceptServerRequest`	Server side.
`void`	`createClientHandshakeRequest`	Client side.
`bool`	`checkClientHandshakeResponse`	Validates the server's 101 Switching Protocols response.
`void`	`completeClientHandshake`	Completes the client-side handshake by verifying Connection, Upgrade and Sec-WebSocket-Accept headers. Advances internal state to "complete".

WebSocketFramer

WebSocketFramer(ws::Mode mode)

Defined in src/http/include/icy/http/websocket.h:162

Creates a WebSocketFramer operating in the given endpoint mode. Client-side framers mask outgoing payloads; server-side framers do not.

Parameters

Parameter	Type	Description
`mode`	`ws::Mode`	ServerSide or ClientSide.

~WebSocketFramer

virtual

virtual ~WebSocketFramer()

Defined in src/http/include/icy/http/websocket.h:164

writeFrame

virtual

virtual size_t writeFrame(const char * data, size_t len, int flags, BitWriter & frame)

Defined in src/http/include/icy/http/websocket.h:173

Encodes data into a WebSocket frame and writes it to frame.

Returns

Total number of bytes written to the frame buffer (header + payload).

Parameters

Parameter	Type	Description
`data`	`const char *`	Pointer to the payload data.
`len`	`size_t`	Payload length in bytes.
`flags`	`int`	Frame flags: ws::SendFlags::Text, ws::SendFlags::Binary, or a control frame opcode combined with FrameFlags::Fin.
`frame`	`BitWriter` &	BitWriter to write the encoded frame into.

readFrame

virtual

virtual uint64_t readFrame(BitReader & frame, char *& payload)

Defined in src/http/include/icy/http/websocket.h:184

Decodes a single WebSocket frame from frame.

The payload is unmasked in-place in the source buffer; no copy is made. payload is set to point at the start of the payload within frame's buffer.

Returns

Payload length in bytes.

Parameters

Parameter	Type	Description
`frame`	`BitReader` &	BitReader positioned at the start of a frame.
`payload`	`char *&`	Set to point at the start of the decoded payload. Not null-terminated.

Exceptions

Exception	Description
`std::runtime_error`	on protocol violations or if the buffer is too small.

handshakeComplete

const nodiscard

[[nodiscard]] bool handshakeComplete() const

Defined in src/http/include/icy/http/websocket.h:187

Returns true if the WebSocket handshake has completed successfully.

acceptServerRequest

void acceptServerRequest(http::Request & request, http::Response & response)

Defined in src/http/include/icy/http/websocket.h:197

Server side.

Validates the client upgrade request and writes a 101 Switching Protocols response. Sets the internal state to mark the handshake as complete.

Parameters

Parameter	Type	Description
`request`	`http::Request &`	Incoming HTTP upgrade request.
`response`	`http::Response &`	HTTP response to populate with the handshake reply.

Exceptions

Exception	Description
`std::runtime_error`	if the request is not a valid WebSocket upgrade.

createClientHandshakeRequest

void createClientHandshakeRequest(http::Request & request)

Defined in src/http/include/icy/http/websocket.h:205

Client side.

Populates request with the WebSocket upgrade headers (Connection, Upgrade, Sec-WebSocket-Key, Sec-WebSocket-Version) to initiate the handshake.

Parameters

Parameter	Type	Description
`request`	`http::Request &`	HTTP request to add upgrade headers to.

checkClientHandshakeResponse

bool checkClientHandshakeResponse(http::Response & response)

Defined in src/http/include/icy/http/websocket.h:211

Validates the server's 101 Switching Protocols response.

Returns

true if the handshake succeeded and data can flow.

Parameters

Parameter	Type	Description
`response`	`http::Response &`	The HTTP response received from the server.

Exceptions

Exception	Description
`std::runtime_error`	if the server rejected or mishandled the upgrade.

completeClientHandshake

void completeClientHandshake(http::Response & response)

Defined in src/http/include/icy/http/websocket.h:217

Completes the client-side handshake by verifying Connection, Upgrade and Sec-WebSocket-Accept headers. Advances internal state to "complete".

Parameters

Parameter	Type	Description
`response`	`http::Response &`	The 101 Switching Protocols response from the server.

Exceptions

Exception	Description
`std::runtime_error`	if any required header is missing or incorrect.

Protected Methods

Return	Name	Description
`int`	`frameFlags` const nodiscard	Returns the frame flags of the most recently received frame. Set by readFrame()
`bool`	`mustMaskPayload` const nodiscard	Returns true if the payload must be masked. Used by writeFrame()
`ws::Mode`	`mode` const nodiscard

frameFlags

const nodiscard

[[nodiscard]] int frameFlags() const

Defined in src/http/include/icy/http/websocket.h:222

Returns the frame flags of the most recently received frame. Set by readFrame()

mustMaskPayload

const nodiscard

[[nodiscard]] bool mustMaskPayload() const

Defined in src/http/include/icy/http/websocket.h:226

Returns true if the payload must be masked. Used by writeFrame()

mode

const nodiscard

[[nodiscard]] ws::Mode mode() const

Defined in src/http/include/icy/http/websocket.h:228

Private Attributes

Return	Name	Description
`ws::Mode`	`_mode`
`int`	`_frameFlags`
`int`	`_headerState`
`bool`	`_maskPayload`
`Random`	`_rnd`
`std::string`	`_key`
`bool`	`_fragmented`	Currently receiving a fragmented message.
`int`	`_fragmentOpcode`	Opcode of the first frame in the fragment sequence.
`Buffer`	`_fragmentBuffer`	Accumulated payload from continuation frames.
`Buffer`	`_incompleteFrame`	Buffer for incomplete frame data across TCP segments.

_mode

ws::Mode _mode

Type: ws::Mode

Defined in src/http/include/icy/http/websocket.h:238

_frameFlags

int _frameFlags

Defined in src/http/include/icy/http/websocket.h:239

_headerState

int _headerState

Defined in src/http/include/icy/http/websocket.h:240

_maskPayload

bool _maskPayload

Defined in src/http/include/icy/http/websocket.h:241

_rnd

Random _rnd

Defined in src/http/include/icy/http/websocket.h:242

_key

std::string _key

Defined in src/http/include/icy/http/websocket.h:243

_fragmented

bool _fragmented {false}

Defined in src/http/include/icy/http/websocket.h:246

Currently receiving a fragmented message.

_fragmentOpcode

int _fragmentOpcode {0}

Defined in src/http/include/icy/http/websocket.h:247

Opcode of the first frame in the fragment sequence.

_fragmentBuffer

Buffer _fragmentBuffer

Type: Buffer

Defined in src/http/include/icy/http/websocket.h:248

Accumulated payload from continuation frames.

_incompleteFrame

Buffer _incompleteFrame

Type: Buffer

Defined in src/http/include/icy/http/websocket.h:251

Buffer for incomplete frame data across TCP segments.