diff options
Diffstat (limited to 'assets/php/vendor/cboden/ratchet/README.md')
-rwxr-xr-x | assets/php/vendor/cboden/ratchet/README.md | 83 |
1 files changed, 0 insertions, 83 deletions
diff --git a/assets/php/vendor/cboden/ratchet/README.md b/assets/php/vendor/cboden/ratchet/README.md deleted file mode 100755 index 3f1a345..0000000 --- a/assets/php/vendor/cboden/ratchet/README.md +++ /dev/null @@ -1,83 +0,0 @@ -# Ratchet - -[](http://travis-ci.org/ratchetphp/Ratchet) -[](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. - -## 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#serverconfiguration). - -### 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 Ratchet\MessageComponentInterface; -use Ratchet\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); - $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!'); }; -``` |