Menu

Reference

Http\WebSocket

Interfaces

HandlerEvent callbacks for a connection, as an alternative to a foreach loop.

Classes

ConnectionOne open WebSocket, server or client side.
ConnectionClosedExceptionThrown by Connection::send(), sendBinary() and ping() when the connection is already closed or closing, or when the write fails.
HandshakeExceptionThrown by connect() when the WebSocket opening handshake does not complete.
HubA set of connections that a message can be sent to at once.
MessageOne received message.
OptionsSettings for a WebSocket connection, server or client side.

Functions

connect()Open a WebSocket client connection to a ws:// or wss:// URL.
handler()Turn a Handler into a session callback for upgrade().
run()Drive a connection through a Handler until it ends.
upgrade()Answer a WebSocket upgrade request inside an Http\Server handler.