valtzu/guzzle-websocket-middleware

0.3.0 2024-12-27 17:00 UTC

Requires

• guzzlehttp/guzzle: ^7.7

Requires (Dev)

• phpunit/phpunit: ^10.3

MIT

README

NOTE: Only StreamHandler supported (so not CurlHandler!).

Installation

composer install valtzu/guzzle-websocket-middleware

Usage

Guzzle's synchronous option is used to configure the stream blocking option.

Synchronous usage

$handlerStack = new HandlerStack(new StreamHandler());
$handlerStack->unshift(new WebSocketMiddleware());

$guzzle = new Client(['handler' => $handlerStack]);

$handshakeResponse = $guzzle->request('GET', 'wss://ws.postman-echo.com/raw');
$ws = $handshakeResponse->getBody();

$ws->write("Hello world");
$helloWorld = $ws->read(); // This will block until the reply frame is received

Asynchronous usage

$handlerStack = new HandlerStack(new StreamHandler());
$handlerStack->unshift(new WebSocketMiddleware());

$guzzle = new Client(['handler' => $handlerStack]);

$handshakeResponse = $guzzle->requestAsync('GET', 'wss://ws.postman-echo.com/raw')->wait();
$ws = $handshakeResponse->getBody();

$ws->write("Hello world");
$helloWorld = $ws->read(); // Here you may get an empty string if data wasn't received yet

Connection upkeep / ping-pong

Whenever you read from a websocket stream, instead of receiving a text/binary frame, you may receive "ping" instead. When this happens, we automatically respond with "pong". However, due to being PHP (usually) being single-threaded, this means that you must make sure read (even with 0 length) is done frequently enough.

It's also possible to manually send a ping – however, it does not wait for the other party to reply.

$ws->ping();

Contributing

1. If you have an issue with package, or you have a feature request, please open an issue
2. If you want to contribute code, you may submit a Pull Request. Just remember to add tests.