Interface WebsocketConnection_ConstructProps

Index

The type of connection (client/server).

extensions?: object

List of #SoupWebsocketExtension objects that are active in the connection.

io_stream?: IOStream

The underlying IO stream the WebSocket is communicating over.

The input and output streams must be pollable streams.

keepalive_interval?: number

Interval in seconds on when to send a ping message which will serve as a keepalive message. If set to 0 the keepalive message is disabled.

max_incoming_payload_size?: number

The maximum payload size for incoming packets the protocol expects or 0 to not limit it.

origin?: string

The client's Origin.

protocol?: string

The chosen protocol, or %NULL if a protocol was not agreed upon.

The URI of the WebSocket.

For servers this represents the address of the WebSocket, and for clients it is the address connected to.