Documentation / Middleware

Both Client and Server support adding middlewares. All added middlewares will be called when certain actions are performed.

Add middlewares by calling the addMiddleware method.

$client
    ->addMiddleware(new WebSocket\Middleware\CloseHandler())
    ->addMiddleware(new WebSocket\Middleware\PingResponder())
    ;

$server
    ->addMiddleware(new WebSocket\Middleware\CloseHandler())
    ->addMiddleware(new WebSocket\Middleware\PingResponder())
    ;

Standard middlewares

These two middlewares provide standard operability according to WebSocket protocol, and should be added unless you write your own implementation of close and ping/pong handling.

• CloseHandler - Automatically acts on incoming and outgoing Close requests, as specified in WebSocket protocol
• PingResponder - Responds with Pong message when receiving a Ping message, as specified in WebSocket protocol

Optional middlewares

These middlewares are included in library and can be added to provide additional functionality.

• Callback - Apply provided callback function on specified actions
• FollowRedirect - Follow redirect during handshake (Client only)
• PingInterval - Used to automatically send Ping messages at specified interval
• SubprotocolNegotiation - Helper middleware that negotiate subprotocol

Creating your own middleware

You can create your own middleware by implementing relevant interfaces. A middleware may handle WebSocket message transfers, HTTP handshake operations, and Tick operability.

• Creating - How to create a Middleware