We stand united with the people of Ukraine

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.

Parse WAMP Message Middleware

The BabDev\WebSocket\Server\WAMP\Middleware\ParseWAMPMessage class is a server middleware which parses an incoming WAMP message to be consumed by a message handler.

The middleware also allows enabling a keepalive ping-pong for the server.

Customizing The Server Identity

Per the WAMP version 1 specification, a server may identify itself with the serverIdent parameter in its response to the WELCOME message. By default, the middleware uses the BabDev\WebSocket\Server\Server::VERSION constant as its identity, but this can be customized by updating the server identity for the middleware instance.

<?php declare(strict_types=1);

use BabDev\WebSocket\Server\WAMP\Middleware\ParseWAMPMessage;

$middleware = new ParseWAMPMessage($decoratedMiddleware, $topicRegistry);
$middleware->setServerIdentity(''); // An empty string is allowed to not disclose any identity

Position in Middleware Stack

It is recommended that this middleware is decorated by the BabDev\WebSocket\Server\WebSocket\Middleware\EstablishWebSocketConnection 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 placed anywhere after the HTTP request has been parsed and does not expect one of the server middleware sub-interfaces.

It is also recommended that this middleware decorates the use BabDev\WebSocket\Server\WAMP\Middleware\UpdateTopicSubscriptions middleware, but it can decorate any WAMP server middleware.