37d1339359
AbFuzzyServer is now first class EchoServer Updated meta files Cleaned up a WAMP unit test slightly composer alpha7
88 lines
3.1 KiB
Markdown
88 lines
3.1 KiB
Markdown
#Ratchet
|
|
|
|
[](http://travis-ci.org/cboden/Ratchet)
|
|
|
|
A PHP 5.3 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.
|
|
|
|
##WebSocket Compliance
|
|
|
|
* Supports the RFC6455, HyBi-10+, and Hixie76 protocol versions (at the same time)
|
|
* Tested on Chrome 13 - 26, Firefox 6 - 19, Safari 5.0.1 - 6, iOS 4.2 - 6
|
|
* Ratchet [passes](http://socketo.me/reports/ab/) the [Autobahn Testsuite](http://autobahn.ws/testsuite) (non-binary messages)
|
|
|
|
##Requirements
|
|
|
|
Shell access is required and root access is recommended.
|
|
To avoid proxy/firewall blockage it's recommended WebSockets are run on port 80, which requires root access.
|
|
In order to do this, along with your sync web stack, you can either use a proxy or two separate machines. You can find more details in the [server conf docs](http://socketo.me/docs/deploy#sconf).
|
|
|
|
|
|
Cookies from your domain will be passed to the socket server, allowing you to identify users.
|
|
Accessing your website's session data in Ratchet requires you to use [Symfony2 Sessions](http://symfony.com/doc/master/components/http_foundation/sessions.html) on your website.
|
|
PHP 5.3.9 (or higher) is required. If you have access, PHP 5.4 is *highly* recommended for its performance improvements.
|
|
|
|
### 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 server example
|
|
|
|
```php
|
|
<?php
|
|
use Ratchet\MessageComponentInterface;
|
|
use Ratchet\ConnectionInterface;
|
|
use Ratchet\Http\RoutedHttpServer;
|
|
use Ratchet\Server\IoServer;
|
|
use Ratchet\Tests\AbFuzzyServer;
|
|
|
|
require __DIR__ . '/vendor/autoload.php';
|
|
|
|
/**
|
|
* chat.php
|
|
* Send any incoming messages to all connected clients (except sender)
|
|
*/
|
|
class Chat 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
|
|
$router = new RoutedHttpServer;
|
|
$router->addRoute('/echo', new AbFuzzyServer);
|
|
$router->addRoute('/chat', new Chat);
|
|
|
|
$server = IoServer::factory($router, 8000);
|
|
$server->run();
|
|
```
|
|
|
|
$ php chat.php |