# Poco::Net

# class WebSocket

Library: Net
Package: WebSocket
Header: Poco/Net/WebSocket.h

## Description

This class implements a WebSocket according to the WebSocket protocol specification in RFC 6455.

Both client-side and server-side WebSockets are supported.

Server-side WebSockets are usually created from within a HTTPRequestHandler.

Client-side WebSockets are created using a HTTPClientSession.

Note that special frames like PING must be handled at application level. In the case of a PING, a PONG message must be returned.

## Inheritance

Direct Base Classes: StreamSocket

All Base Classes: Socket, StreamSocket

## Member Summary

Member Functions: accept, completeHandshake, computeAccept, connect, createKey, getMaxPayloadSize, mode, operator =, receiveFrame, sendFrame, setMaxPayloadSize, shutdown

Inherited Functions: address, available, bind, close, connect, connectNB, destroyBufVec, error, getBlocking, getError, getKeepAlive, getLinger, getNoDelay, getOOBInline, getOption, getReceiveBufferSize, getReceiveTimeout, getReuseAddress, getReusePort, getSendBufferSize, getSendTimeout, impl, init, isDatagram, isNull, isRaw, isStream, lastError, lastErrorDesc, makeBufVec, makeBuffer, operator !=, operator <, operator <=, operator =, operator ==, operator >, operator >=, peerAddress, poll, receiveBytes, secure, select, sendBytes, sendUrgent, setBlocking, setKeepAlive, setLinger, setNoDelay, setOOBInline, setOption, setReceiveBufferSize, setReceiveTimeout, setReuseAddress, setReusePort, setSendBufferSize, setSendTimeout, shutdown, shutdownReceive, shutdownSend, sockfd, supportsIPv4, supportsIPv6, type

## Enumerations

### ErrorCodes

These error codes can be obtained from a WebSocketException to determine the exact cause of the error.

WS_ERR_NO_HANDSHAKE = 1

No Connection: Upgrade or Upgrade: websocket header in handshake request.

WS_ERR_HANDSHAKE_NO_VERSION = 2

No Sec-WebSocket-Version header in handshake request.

WS_ERR_HANDSHAKE_UNSUPPORTED_VERSION = 3

Unsupported WebSocket version requested by client.

WS_ERR_HANDSHAKE_NO_KEY = 4

No Sec-WebSocket-Key header in handshake request.

WS_ERR_HANDSHAKE_ACCEPT = 5

No Sec-WebSocket-Accept header or wrong value.

WS_ERR_UNAUTHORIZED = 6

The server rejected the username or password for authentication.

WS_ERR_PAYLOAD_TOO_BIG = 10

Payload too big for supplied buffer.

WS_ERR_INCOMPLETE_FRAME = 11

Incomplete frame received.

### FrameFlags

Frame header flags.

FRAME_FLAG_FIN = 0x80

FIN bit: final fragment of a multi-fragment message.

FRAME_FLAG_RSV1 = 0x40

Reserved for future use. Must be zero.

FRAME_FLAG_RSV2 = 0x20

Reserved for future use. Must be zero.

FRAME_FLAG_RSV3 = 0x10

Reserved for future use. Must be zero.

### FrameOpcodes

Frame header opcodes.

FRAME_OP_CONT = 0x00

Continuation frame.

FRAME_OP_TEXT = 0x01

Text frame.

FRAME_OP_BINARY = 0x02

Binary frame.

FRAME_OP_CLOSE = 0x08

Close connection.

FRAME_OP_PING = 0x09

Ping frame.

FRAME_OP_PONG = 0x0a

Pong frame.

FRAME_OP_BITMASK = 0x0f

Bit mask for opcodes.

FRAME_OP_SETRAW = 0x100

Set raw flags (for use with sendBytes() and FRAME_OP_CONT).

### Mode

WS_SERVER

Server-side WebSocket.

WS_CLIENT

Client-side WebSocket.

### SendFlags

Combined header flags and opcodes for use with sendFrame().

FRAME_TEXT = FRAME_FLAG_FIN | FRAME_OP_TEXT

Use this for sending a single text (UTF-8) payload frame.

FRAME_BINARY = FRAME_FLAG_FIN | FRAME_OP_BINARY

Use this for sending a single binary payload frame.

### StatusCodes

StatusCodes for CLOSE frames sent with shutdown().

WS_NORMAL_CLOSE = 1000

WS_ENDPOINT_GOING_AWAY = 1001

WS_PROTOCOL_ERROR = 1002

WS_PAYLOAD_NOT_ACCEPTABLE = 1003

WS_RESERVED = 1004

WS_RESERVED_NO_STATUS_CODE = 1005

WS_RESERVED_ABNORMAL_CLOSE = 1006

WS_MALFORMED_PAYLOAD = 1007

WS_POLICY_VIOLATION = 1008

WS_PAYLOAD_TOO_BIG = 1009

WS_EXTENSION_REQUIRED = 1010

WS_UNEXPECTED_CONDITION = 1011

WS_RESERVED_TLS_FAILURE = 1015

## Constructors

### WebSocket

WebSocket(
const Socket & socket
);

Creates a WebSocket from another Socket, which must be a WebSocket, otherwise a Poco::InvalidArgumentException will be thrown.

### WebSocket

WebSocket(
const WebSocket & socket
);

Creates a WebSocket from another WebSocket.

### WebSocket

WebSocket(
HTTPServerRequest & request,
HTTPServerResponse & response
);

Creates a server-side WebSocket from within a HTTPRequestHandler.

First verifies that the request is a valid WebSocket upgrade request. If so, completes the handshake by sending a proper 101 response.

Throws an exception if the request is not a proper WebSocket upgrade request.

### WebSocket

WebSocket(
HTTPClientSession & cs,
HTTPRequest & request,
HTTPResponse & response
);

Creates a client-side WebSocket, using the given HTTPClientSession and HTTPRequest for the initial handshake (HTTP Upgrade request).

Additional HTTP headers for the initial handshake request (such as Origin or Sec-WebSocket-Protocol) can be given in the request object.

The result of the handshake can be obtained from the response object.

The HTTPClientSession session object must no longer be used after setting up the WebSocket.

### WebSocket

WebSocket(
HTTPClientSession & cs,
HTTPRequest & request,
HTTPResponse & response,
HTTPCredentials & credentials
);

Creates a client-side WebSocket, using the given HTTPClientSession and HTTPRequest for the initial handshake (HTTP Upgrade request).

The given credentials are used for authentication if requested by the server.

Additional HTTP headers for the initial handshake request (such as Origin or Sec-WebSocket-Protocol) can be given in the request object.

The result of the handshake can be obtained from the response object.

The HTTPClientSession session object must no longer be used after setting up the WebSocket.

## Destructor

### ~WebSocket

virtual ~WebSocket();

Destroys the WebSocket.

## Member Functions

### getMaxPayloadSize

int getMaxPayloadSize() const;

Returns the maximum payload size for receiveFrame().

The default is std::numeric_limits<int>::max().

### mode

Mode mode() const;

Returns WS_SERVER if the WebSocket is a server-side WebSocket, or WS_CLIENT otherwise.

### operator =

WebSocket & operator = (
const Socket & socket
);

Assignment operator.

The other socket must be a WebSocket, otherwise a Poco::InvalidArgumentException will be thrown.

### operator =

WebSocket & operator = (
const WebSocket & socket
);

Assignment operator.

### receiveFrame

int receiveFrame(
void * buffer,
int length,
int & flags
);

Receives a frame from the socket and stores it in buffer. Up to length bytes are received. If the frame's payload is larger, a WebSocketException is thrown and the WebSocket connection must be terminated.

The frame's payload size must not exceed the maximum payload size set with setMaxPayloadSize(). If it does, a WebSocketException (WS_ERR_PAYLOAD_TOO_BIG) is thrown and the WebSocket connection must be terminated.

A WebSocketException will also be thrown if a malformed or incomplete frame is received.

Returns the number of payload bytes received. A return value of 0, with flags also 0, means that the peer has shut down or closed the connection. A return value of 0, with non-zero flags, indicates an reception of an empty frame (e.g., in case of a PING).

Throws a TimeoutException if a receive timeout has been set and nothing is received within that interval. Throws a NetException (or a subclass) in case of other errors.

The frame flags and opcode (FrameFlags and FrameOpcodes) is stored in flags.

### receiveFrame

int receiveFrame(
Poco::Buffer < char > & buffer,
int & flags
);

Receives a frame from the socket and stores it after any previous content in buffer. The buffer will be grown as necessary.

See the note below if you want the received data to be stored at the beginning of the buffer.

The frame's payload size must not exceed the maximum payload size set with setMaxPayloadSize(). If it does, a WebSocketException (WS_ERR_PAYLOAD_TOO_BIG) is thrown and the WebSocket connection must be terminated.

A WebSocketException will also be thrown if a malformed or incomplete frame is received.

If this method is used, a reasonable maximum payload size should be set with setMaxPayloadSize() to prevent a potential DoS attack (memory exhaustion) by sending a WebSocket frame header with a huge payload size.

Returns the number of payload bytes received. A return value of 0, with flags also 0, means that the peer has shut down or closed the connection. A return value of 0, with non-zero flags, indicates an reception of an empty frame (e.g., in case of a PING).

Throws a TimeoutException if a receive timeout has been set and nothing is received within that interval. Throws a NetException (or a subclass) in case of other errors.

The frame flags and opcode (FrameFlags and FrameOpcodes) is stored in flags.

Note: Since the data received from the WebSocket is appended to the given Poco::Buffer, the buffer passed to this method should be created with a size of 0, or resize(0) should be called on the buffer beforehand, if the expectation is that the received data is stored starting at the beginning of the buffer.

### sendFrame

int sendFrame(
const void * buffer,
int length,
int flags = FRAME_TEXT
);

Sends the contents of the given buffer through the socket as a single frame.

Values from the FrameFlags, FrameOpcodes and SendFlags enumerations can be specified in flags.

Returns the number of bytes sent, which may be less than the number of bytes specified.

Certain socket implementations may also return a negative value denoting a certain condition.

### setMaxPayloadSize

void setMaxPayloadSize(
int maxPayloadSize
);

Sets the maximum payload size for receiveFrame().

The default is std::numeric_limits<int>::max().

### shutdown

void shutdown();

Sends a Close control frame to the server end of the connection to initiate an orderly shutdown of the connection.

### shutdown

void shutdown(
Poco::UInt16 statusCode,
const std::string & statusMessage = ""
);

Sends a Close control frame to the server end of the connection to initiate an orderly shutdown of the connection.

### accept

static WebSocketImpl * accept(
HTTPServerRequest & request,
HTTPServerResponse & response
);

### completeHandshake

static WebSocketImpl * completeHandshake(
HTTPClientSession & cs,
HTTPResponse & response,
const std::string & key
);

### computeAccept

static std::string computeAccept(
const std::string & key
);

### connect

static WebSocketImpl * connect(
HTTPClientSession & cs,
HTTPRequest & request,
HTTPResponse & response,
HTTPCredentials & credentials
);

### createKey

static std::string createKey();

## Variables

### WEBSOCKET_VERSION

static const std::string WEBSOCKET_VERSION;

The WebSocket protocol version supported (13).