Pike v8.1 release 6

Module Protocols.EngineIO

Description

This is an implementation of the Engine.IO server-side communication's driver. It basically is a real-time bidirectional packet-oriented communication's protocol for communicating between a webbrowser and a server.

The driver mainly is a wrapper around Protocols.WebSocket with the addition of two fallback mechanisms that work around limitations imposed by firewalls and/or older browsers that prevent native Protocols.WebSocket connections from functioning.

This module supports the following features:

  • It supports both UTF-8 and binary packets.

    packet sizes are essentially unlimited. The fallback methods have a limit on packet sizes from browser to server, determined by the maximum POST request size the involved network components allow.

In most cases, Engine.IO is not used directly in applications. Instead one uses Socket.IO instead.

See also

Protocols.SocketIO, Protocols.WebSocket, http://github.com/socketio/engine.io-protocol, http://socket.io/


Variable options

final mapping Protocols.EngineIO.options

Description

Global options for all EngineIO instances.

See also

Socket.create(), Gz.compress()


Constant protocol

constant int Protocols.EngineIO.protocol

Description

Engine.IO protocol version.