warriorxk/phpwebsockets

A websocket library with support for IPC using socket pairs

3.1.3 2023-06-29 11:40 UTC

Requires

• php: ^7.4.0 || ^8.0.0
• ext-sockets: *
• psr/log: ^1.0

Requires (Dev)

• ext-json: *
• ext-pcntl: *
• phpunit/phpunit: ^9.6

MIT

• Kevin Meijer

• php
• websocket
• client
• server
• Socket
• ipc
• phpwebsockets

README

Master: Develop:

A PHP library to accept and create websocket connections, we aim to be 100% compliant with the websocket RFC and use the Autobahn test suite to ensure so. Currently the server and the client are 100% compliant with the autobahn testsuite minus a few non-strict notices, the compression extension for websockets will be implemented later

Server

For websocket servers a new \PHPWebSockets\Server instance should be created with a bind address and a port to listen on. For ease of use you can use the UpdatesWrapper class, this will trigger certain callables set on basic functions.

A basic websocket echo server would be:

require_once __DIR__ . '/vendor/autoload.php';

$wrapper = new \PHPWebSockets\UpdatesWrapper();
$wrapper->setMessageHandler(function(\PHPWebSockets\AConnection $connection, string $message, int $opcode) {

    echo 'Got message with length ' . strlen($message) . PHP_EOL;
    $connection->write($message, $opcode);

});


$server = new \PHPWebSockets\Server('tcp://0.0.0.0:9001');

while (TRUE) {
    $wrapper->update(0.1, $server->getConnections(TRUE));
}

If more control is required you can manually call $server->update(0.1); instead of using the wrapper, this will yield update objects which can be responded to.

Client

For connecting to a server the \PHPWebSockets\Client class should be constructed and the method connect($address, $port, $path) should be used to connect. For ease of use you can again use the UpdatesWrapper class or use $server->update(0.1); for better control.

A basic websocket echo client would be:

require_once __DIR__ . '/../vendor/autoload.php';

$wrapper = new \PHPWebSockets\UpdatesWrapper();
$wrapper->setMessageHandler(function(\PHPWebSockets\AConnection $connection, string $message, int $opcode) {

    echo 'Got message with length ' . strlen($message) . PHP_EOL;
    $connection->write($message, $opcode);

});


$client = new \PHPWebSockets\Client();
if (!$client->connect('tcp://localhost:9001/webSocket')) {
    die('Unable to connect to server: ' . $client->getLastError() . PHP_EOL);
}

while (TRUE) {
    $wrapper->update(0.1, [$client]);
}