https://github.com/warriorxk/phpwebsockets

A PHP 7.3+ library to accept and create websocket connections
https://github.com/warriorxk/phpwebsockets

daemon php php-daemon php73 php74 websocket websocket-client websocket-connection websocket-connections websocket-server websocket-servers websockets

Last synced: 4 months ago
JSON representation

A PHP 7.3+ library to accept and create websocket connections

• Host: GitHub
• URL: https://github.com/warriorxk/phpwebsockets
• Owner: WarriorXK
• License: mit
• Created: 2016-07-01T07:14:20.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-06-29T12:11:36.000Z (over 1 year ago)
• Last Synced: 2024-09-29T19:42:57.460Z (5 months ago)
• Topics: daemon, php, php-daemon, php73, php74, websocket, websocket-client, websocket-connection, websocket-connections, websocket-server, websocket-servers, websockets
• Language: PHP
• Homepage:
• Size: 605 KB
• Stars: 11
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHPWebSockets

[![Code documented](https://codedocs.xyz/WarriorXK/PHPWebSockets.svg)](https://codedocs.xyz/WarriorXK/PHPWebSockets/) Master: [![Build Status](https://travis-ci.com/WarriorXK/PHPWebSockets.svg?branch=master)](https://travis-ci.com/WarriorXK/PHPWebSockets) Develop: [![Build Status](https://travis-ci.com/WarriorXK/PHPWebSockets.svg?branch=develop)](https://travis-ci.com/WarriorXK/PHPWebSockets)

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](http://autobahn.ws/testsuite/) 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](https://tools.ietf.org/html/rfc7692) 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:

```php

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:

```php

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]);

}

```