WebSocket.Config

Group: foundational

Members

Variables

additionalHeaders
string[] additionalHeaders;

Additional headers to put in the HTTP request. These should be formatted Name: value, like for example:

cookies
string[string] cookies;

Cookies to send with the initial request. cookiesname = value;

initialReceiveBufferSize
size_t initialReceiveBufferSize;
likelyReceiveBufferSize
size_t likelyReceiveBufferSize;

These control the size of the receive buffer.

maximumMessageSize
size_t maximumMessageSize;

Maximum combined size of a message.

maximumReceiveBufferSize
size_t maximumReceiveBufferSize;

These control the size of the receive buffer.

origin
string origin;

Origin URL to send with the handshake, if desired.

pingFrequency
int pingFrequency;

Amount of time (in msecs) of idleness after which to send an automatic ping

protocol
string protocol;

the protocol header, if desired.

timeoutFromInactivity
Duration timeoutFromInactivity;

Amount of time to disconnect when there's no activity. Note that automatic pings will keep the connection alive; this timeout only occurs if there's absolutely nothing, including no responses to websocket ping frames. Since the default pingFrequency is only seconds, this one minute should never elapse unless the connection is actually dead.

verifyPeer
bool verifyPeer;

For https connections, if this is true, it will fail to connect if the TLS certificate can not be verified. Setting this to false will skip this check and allow the connection to continue anyway.

Meta