Ratchet

To start a WebSocket server, instantiate Ratchet\App, define routes for your components, and call run().

Example workflow:

1. Create a class implementing MessageComponentInterface.
2. Initialize new Ratchet\App('host', port).
3. Use $app->route($path, $component, $selectors) to map URL paths to your logic.
4. Execute the script via the CLI.

<?php
use Ratchet\MessageComponentInterface;
use Ratchet\ConnectionInterface;

require __DIR__ . '/vendor/autoload.php';

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();
    }
}

$app = new Ratchet\App('localhost', 8080);
$app->route('/chat', new MyChat, array('*'));
$app->route('/echo', new Ratchet\Server\EchoServer, array('*'));
$app->run();

Run the server with:

php chat.php

To handle WebSocket logic, implement the Ratchet\MessageComponentInterface. This interface requires four methods to manage the lifecycle of a connection:

• onOpen(ConnectionInterface $conn): Called when a new connection is established. Use this to track the connection (e.g., adding it to an SplObjectStorage).
• onMessage(ConnectionInterface $from, $msg): Called when a message is received from a client. Use this to process data or broadcast to other clients.
• onClose(ConnectionInterface $conn): Called when a connection is closed. Use this to clean up stored connections.
• onError(ConnectionInterface $conn, \Exception $e): Called when an error occurs on a connection. Typically used to close the connection.

<?php
use Ratchet\MessageComponentInterface;
use Ratchet\ConnectionInterface;

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();
    }
}

The Ratchet\App class is an opinionated facade used to quickly set up a WebSocket server. It handles routing, origin checking, and Flash policy configuration by default.

Constructor Parameters

Use the route() method to map a URI path to a specific component (like a WebSocket message handler or a WAMP server).

Parameters

Behavior

• If the controller is a WampServerInterface or MessageComponentInterface, it is automatically wrapped in a WsServer with keep-alive enabled.
• If $allowedOrigins is not ['*'], an OriginCheck decorator is automatically applied to enforce security.