Pike v8.1 release 6

Class Protocols.EngineIO.Socket

Description

Runs a single Engine.IO session.


Variable request

final Protocols.WebSocket.Request Protocols.EngineIO.Socket.request

Description

Contains the last request seen on this connection. Can be used to obtain cookies etc.


Variable sid

final string Protocols.EngineIO.Socket.sid

Description

The unique session identifier (in the Engine.IO docs referred to as simply: id).


Method create

Protocols.EngineIO.Socket Protocols.EngineIO.Socket(Protocols.WebSocket.Request req, void|mapping options)

Parameter options

Optional options to override the defaults.

"pingTimeout" : int

If, the connection is idle for longer than this, the connection is terminated, unit in ms.

"pingInterval" : int

The browser-client will send a small ping message every pingInterval ms.

"allowUpgrades" : int

When true (default), it allows the server to upgrade the connection to a real Protocols.WebSocket connection.

"compressionLevel" : int

The gzip compressionlevel used to compress packets.

"compressionThreshold" : int

Packets smaller than this will not be compressed.