Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
PHP WebSocket library
branch: master

This branch is 285 commits behind ratchetphp:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
src/Ratchet
tests
.gitignore
.travis.yml
LICENSE
README.md
composer.json
composer.lock
phpunit.xml.dist

README.md

Ratchet

Build Status

A PHP 5.3 library for serving WebSockets and building socket based applications. 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 - 19, Firefox 6 - 12, Safari 5.0.1+, iOS 4.2, iOS 5

Requirements

Shell access is required and a dedicated machine with root access is recommended. To avoid proxy/firewall blockage it's recommended WebSockets are run on port 80, which requires root access. Note that you can not run two applications (Apache and Ratchet) on the same port, thus the requirement for a separate machine (for now). PHP 5.3.2 (or higher) is required with mbstring enabled (--enable-mbstring flag during compile time). PHP5.4 is recommended for its performance improvements.

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 on your website.

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.


A quick server example

<?php
use Ratchet\MessageComponentInterface;
use Ratchet\ConnectionInterface;
use Ratchet\Server\IoServer;
use Ratchet\WebSocket\WsServer;

/**
 * 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 8000
    $server = IoServer::factory(new WsServer(new Chat), 8000);
    $server->run();
$ php chat.php
Something went wrong with that request. Please try again.