Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ollyxar/websockets
PHP WebSocket server
https://github.com/ollyxar/websockets
composer ollyxar-websockets php php-websocket-server php7 php71 unix-socket websocket-application websocket-library websocket-server websockets
Last synced: 3 months ago
JSON representation
PHP WebSocket server
- Host: GitHub
- URL: https://github.com/ollyxar/websockets
- Owner: ollyxar
- License: mit
- Created: 2017-10-16T17:22:02.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-08T18:23:37.000Z (over 6 years ago)
- Last Synced: 2024-09-29T19:41:34.890Z (3 months ago)
- Topics: composer, ollyxar-websockets, php, php-websocket-server, php7, php71, unix-socket, websocket-application, websocket-library, websocket-server, websockets
- Language: PHP
- Size: 53.7 KB
- Stars: 31
- Watchers: 6
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP WebSocket server
[](https://travis-ci.org/ollyxar/websockets)
Simple and multifunctional PHP WebSocket server
#### Live chat example
#### Performance
## Installing WebSockets
The recommended way to install WebSockets is through [Composer](http://getcomposer.org).
```bash
# Install Composer
curl -sS https://getcomposer.org/installer | php
```
Next, run the Composer command to install the latest stable version of WebSockets:
```bash
php composer.phar require ollyxar/websockets
```
After installing, you need to require Composer's autoloader:
```php
require 'vendor/autoload.php';
```
## Simple WebSocket server
### MyHandler.php
```php
use Generator;
use Ollyxar\LaravelAuth\FileAuth;
use Ollyxar\WebSockets\{
Frame,
Handler as BaseHandler,
Dispatcher
};
class MyHandler extends BaseHandler
{
/**
* MyHandler constructor.
* @param $server
* @param $master
*/
public function __construct($server, $master)
{
parent::__construct($server, $master);
echo "I'm: #{$this->pid}\n";
}
/**
* @param $client
* @return Generator
*/
protected function onConnect($client): Generator
{
yield Dispatcher::async($this->broadcast(Frame::encode(json_encode([
'type' => 'system',
'message' => 'User {' . (int)$client . '} Connected.'
]))));
}
/**
* @param $clientNumber
* @return Generator
*/
protected function onClose($clientNumber): Generator
{
yield Dispatcher::async($this->broadcast(Frame::encode(json_encode([
'type' => 'system',
'message' => "User {$clientNumber} disconnected."
]))));
}
/**
* @param string $message
* @param int $socketId
* @return Generator
*/
protected function onClientMessage(string $message, int $socketId): Generator
{
$message = json_decode($message);
if (!empty($message)) {
$userName = $message->name;
$userMessage = $message->message;
$response = Frame::encode(json_encode([
'type' => 'usermsg',
'name' => $userName,
'message' => $userMessage
]));
yield Dispatcher::async($this->broadcast($response));
}
}
}
```
### User validation
Base `Handler` has own method to validate user to be logged in. By default it is always return true. You should provide your own implementation of method to authorize users.
```php
/**
* Use this method for custom user validation
*
* @param array $headers
* @param $socket
* @return bool
*/
protected function validateClient(array $headers, $socket): bool
{
return true;
}
```
### ws-server.php
```php
/**
* Lets start our server
*/
(new Server('0.0.0.0', 2083, 6, true))
->setCert()
->setPassPhrase()
->setHandler(MyHandler::class)
->run();
```
### Nginx reverse proxy
```nginx
# choose location path
location /websocket/ {
# use same host and port from your settings!
proxy_pass http://0.0.0.0:2082/;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_read_timeout 86400;
}
```
### Realtime testing (logging)
The server has internal logger that can output info into console.
All that you need is just to enable logging before launching server.
```php
Logger::enable();
```
### Communicate with server outside the wss protocol
```php
use Ollyxar\WebSockets\Server as WServer;
use Ollyxar\WebSockets\Frame;
$socket = socket_create(AF_UNIX, SOCK_STREAM, 0);
socket_connect($socket, WServer::$connector);
$data = new stdClass();
$data->type = 'system';
$data->message = 'hello World!';
$msg = Frame::encode(json_encode($data));
socket_write($socket, $msg);
socket_close($socket);
```