react-websocket/README.md

ReactPHP WebSockets

This is a library that implements WebSocket support on top of ReactPHPs HttpServer. In the process, the underlaying request and endpoint info is made available to your code. What happens next is up to you.

Missing Features

The following features are missing, or work in progress:

• Idle timeout and ping timeout
• Protocol errors should close with error codes
• Exceptions
• Full tested support for fragmented frames

Installing

Install using composer:

$ composer require noccylabs/react-websocket:^0.1.0

Note that you may need additional permissions to be able to access the repository. If so, clone it locally:

$ git clone https://dev.noccylabs.info/noccy/react-websocket ~/react-websocket
$ composer config repositories.react-websocket vcs ~/react-websocket
$ composer require noccylabs/react-websocket:^0.1.0 # ^0.1.0 or @dev

Server

The WebSocket handler is built as a HttpServer middleware. This makes sense as WebSocket as a protocol is running over HTTP. Connections are set up by the middleware and exposed via the connect event.

Data is written and read as with any DuplexStream, use the write() method to send data to the client, and listen for the text and binary events on the connection.

Note that the write() method sends text frames, if you want to send a binary frame use writeBinary().

Example

// This is the middleware that will intercept WebSocket handshakes
$websocket = new NoccyLabs\React\WebSocket\WebSocketMiddleware();

// Connect event handler, receives a WebSocketInterface.
// Ratchet handles security for you, this library does not. You should
// check everything important in the connect handler and reject anything
// that does not smell right. Here we just echo everything.
$websocket->on('connection', function (NoccyLabs\React\WebSocket\WebSocketInterface $connection) {
    $websocket->on('text', function ($text) use ($websocket) {
        $websocket->write($text);
    });
});

// The HTTP router that will handle other requests
$router = function (Psr\Http\Message\ServerRequestInterface $request) {
    return React\Http\Message\Response::plaintext("This is a websocket server");
};

// Create a HttpServer and insert the middleware
$http = new React\Http\HttpServer(
    $websocket,
    $router
);

// Create a socket and listen as you're used to
$socket = new React\Socket\SocketServer('0.0.0.0:8000');
$http->listen($socket); 

WebSocketMiddleware Events

connection

function (WebSocketInterface $member)

This event is emitted when a new WebSocket request has been accepted. The WebSocketConnection is passed as the first argument.

WebSocketConnection events

ping

function (string $payload)

This event will be emitted upon receiving a frame with a ping opcode. The pong response has already been sent automatically, unless 'no_auto_pong' is set in the context.

pong

function (string $payload)

This event will be emitted upon receiving a frame with a pong opcode.

text

function (string $payload)

This event will be emitted when a text data frame have been received and decoded.

binary

function (string $payload)

This event will be emitted when a binary data frame have been received and decoded.

close

function ()

error

function (?string $reason, ?int $code)

GroupManager events

create

function (ConnectionGroup $group)

destroy

function (ConnectionGroup $group)

ConnectionGroup events

join

function (WebSocketInterface $member)

leave

function (WebSocketInterface $member)