cboden/ratchet

PHP WebSocket library

Tuesday, March 6, 2018
by cboden
Repository
230 Watchers
4231 Stars
2,138,251 Installations

PHP
164 Dependents
8 Suggesters
506 Forks
77 Open issues
29 Versions
7 % Grown

The README.md

Ratchet

[][GA Link] , _(*1)

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., _(*2)

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 for ways to help out. ❤️, _(*3)

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., _(*4)

Documentation

User and API documentation is available on Ratchet's website: http://socketo.me, _(*5)

See https://github.com/cboden/Ratchet-examples for some out-of-the-box working demos using Ratchet., _(*6)

Need help? Have a question? Want to provide feedback? Write a message on the Google Groups Mailing List., _(*7)

A quick example

<?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, array('*'));
    $app->route('/echo', new Ratchet\Server\EchoServer, array('*'));
    $app->run();

$ php chat.php

    // 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!'); };

The Versions

06/03 2018

dev-master

9999999-dev http://socketo.me

PHP WebSocket library

library ratchet

PHP WebSocket library

cboden/ratchet

The README.md

Ratchet

Reviving Ratchet!

Requirements

Documentation

A quick example

The Versions

dev-master

The Requires

The Development Requires

by Chris Boden

v0.4.1

The Requires

The Development Requires

by Chris Boden

dev-fix-#516

The Requires

The Development Requires

by Chris Boden

dev-router-race-fix

The Requires

The Development Requires

by Chris Boden

v0.4

The Requires

The Development Requires

by Chris Boden

0.4.x-dev

The Requires

The Development Requires

by Chris Boden

v0.3.6

The Requires

by Chris Boden

v0.3.5

The Requires

by Chris Boden

v0.3.4

The Requires

by Chris Boden

v0.3.3

The Requires

by Chris Boden

v0.3.2

The Requires

by Chris Boden

v0.3.1

The Requires

by Chris Boden

v0.3.0

The Requires

by Chris Boden

v0.2.8

The Requires

by Chris Boden

dev-wamp-sync-bug

The Requires

by Chris Boden

v0.2.7

The Requires

by Chris Boden

v0.2.6

The Requires

by Chris Boden

v0.2.5

The Requires

by Chris Boden

v0.2.4

The Requires

by Chris Boden

v0.2.3

The Requires

by Chris Boden

v0.2.2

The Requires

by Chris Boden

v0.2.1