WebSocket Server


Version Not Yet Released

You are viewing the documentation for the 1.x branch of the WebSocket Server package which has not yet been released. Be aware that the API for this version may change before release.

Dispatch Message To Handler Middleware

The BabDev\WebSocket\Server\WAMP\Middleware\DispatchMessageToHandler class is a server middleware which is responsible for routing the WAMP message to its message handler.

This middleware also supports emitting events using a PSR-14 compatible event dispatcher when a connection is opened, closed, or an error occurs.

This middleware requires the Symfony's Routing component to serve as the websocket server's router.

Please see the Symfony documentation for more information on how to use their API.

Available Events

  • BabDev\WebSocket\Server\Connection\Event\ConnectionClosed - dispatched when a client has closed their connection
  • BabDev\WebSocket\Server\Connection\Event\ConnectionError - dispatched when there is a client error or an unhandled exception on the server
  • BabDev\WebSocket\Server\Connection\Event\ConnectionOpened - dispatched when a new client has connected to the server

Position in Middleware Stack

It is recommended that this middleware is decorated by the BabDev\WebSocket\Server\WebSocket\Middleware\UpdateTopicSubscriptions middleware in your application (see the message flow section from the architecture documentation to see the recommended stack with all optional middleware), however it can be decorated by any WAMP server middleware.

This middleware is intended to be the innermost middleware in your application, and as such, does not support decorating other middleware.