Mohamad Faeez
50725bbf4c
Some checks are pending
CI / PHPUnit (highest, 5.4) (push) Waiting to run
CI / PHPUnit (highest, 5.5) (push) Waiting to run
CI / PHPUnit (highest, 5.6) (push) Waiting to run
CI / PHPUnit (highest, 7.0) (push) Waiting to run
CI / PHPUnit (highest, 7.1) (push) Waiting to run
CI / PHPUnit (highest, 7.2) (push) Waiting to run
CI / PHPUnit (highest, 7.3) (push) Waiting to run
CI / PHPUnit (highest, 7.4) (push) Waiting to run
CI / PHPUnit (lowest, 5.4) (push) Waiting to run
93 lines
3.3 KiB
Markdown
93 lines
3.3 KiB
Markdown
# Ratchet
|
|
|
|
[![GitHub Actions][GA Image]][GA Link]
|
|
[](http://socketo.me/reports/ab/index.html)
|
|
[](https://packagist.org/packages/cboden/ratchet)
|
|
|
|
A PHP library for asynchronously serving WebSockets.
|
|
Build up your application through simple interfaces and re-use your application without changing any of its code just by combining different components.
|
|
|
|
## Reviving Ratchet!
|
|
|
|
We're currently aiming to revive Ratchet to get it up to date with the latest versions and use this as a starting point for bigger updates to come.
|
|
We need your help to achieve this goal, see [ticket #1054](https://github.com/ratchetphp/Ratchet/issues/1054) for ways to help out. ❤️
|
|
|
|
## Requirements
|
|
|
|
Shell access is required and root access is recommended.
|
|
To avoid proxy/firewall blockage it's recommended WebSockets are requested on port 80 or 443 (SSL), which requires root access.
|
|
In order to do this, along with your sync web stack, you can either use a reverse proxy or two separate machines.
|
|
You can find more details in the [server conf docs](http://socketo.me/docs/deploy#server_configuration).
|
|
|
|
### Documentation
|
|
|
|
User and API documentation is available on Ratchet's website: http://socketo.me
|
|
|
|
See https://github.com/cboden/Ratchet-examples for some out-of-the-box working demos using Ratchet.
|
|
|
|
Need help? Have a question? Want to provide feedback? Write a message on the [Google Groups Mailing List](https://groups.google.com/forum/#!forum/ratchet-php).
|
|
|
|
---
|
|
|
|
### A quick example
|
|
|
|
```php
|
|
<?php
|
|
use mfmdevsystem\socket\MessageComponentInterface;
|
|
use mfmdevsystem\socket\ConnectionInterface;
|
|
|
|
// Make sure composer dependencies have been installed
|
|
require __DIR__ . '/vendor/autoload.php';
|
|
|
|
/**
|
|
* chat.php
|
|
* Send any incoming messages to all connected clients (except sender)
|
|
*/
|
|
class MyChat implements MessageComponentInterface {
|
|
protected $clients;
|
|
|
|
public function __construct() {
|
|
$this->clients = new \SplObjectStorage;
|
|
}
|
|
|
|
public function onOpen(ConnectionInterface $conn) {
|
|
$this->clients->attach($conn);
|
|
}
|
|
|
|
public function onMessage(ConnectionInterface $from, $msg) {
|
|
foreach ($this->clients as $client) {
|
|
if ($from != $client) {
|
|
$client->send($msg);
|
|
}
|
|
}
|
|
}
|
|
|
|
public function onClose(ConnectionInterface $conn) {
|
|
$this->clients->detach($conn);
|
|
}
|
|
|
|
public function onError(ConnectionInterface $conn, \Exception $e) {
|
|
$conn->close();
|
|
}
|
|
}
|
|
|
|
// Run the server application through the WebSocket protocol on port 8080
|
|
$app = new Ratchet\App('localhost', 8080);
|
|
$app->route('/chat', new MyChat, array('*'));
|
|
$app->route('/echo', new Ratchet\Server\EchoServer, array('*'));
|
|
$app->run();
|
|
```
|
|
|
|
$ php chat.php
|
|
|
|
```javascript
|
|
// Then some JavaScript in the browser:
|
|
var conn = new WebSocket('ws://localhost:8080/echo');
|
|
conn.onmessage = function(e) { console.log(e.data); };
|
|
conn.onopen = function(e) { conn.send('Hello Me!'); };
|
|
```
|
|
|
|
[GA Image]: https://github.com/ratchetphp/Ratchet/workflows/CI/badge.svg
|
|
|
|
[GA Link]: https://github.com/ratchetphp/Ratchet/actions?query=workflow%3A%22CI%22+branch%3Amaster
|