Skip to content
This repository has been archived by the owner on Jul 9, 2019. It is now read-only.

Latest commit

 

History

History
61 lines (39 loc) · 1.14 KB

README.md

File metadata and controls

61 lines (39 loc) · 1.14 KB

WebSocket

A PHP implementation of WebSocket.

Installing

$ composer require overtrue/websocket -vvv

Usage

Server

use Overtrue\WebSocket\Server;

$options = [
    // 'port' => 8000,
    // 'timeout' => 0,
    // ...
];
$server = new Server($options);

$server->accept();

// receive
$message = $server->reveive();

// send
$server->send('Hello overtrue.');

Client

use Overtrue\WebSocket\Client;

$client = new Client('ws://127.0.0.1:8000');

// send
$client->send('Hello overtrue.');

// receive
$message = $client->reveive();

Contributing

You can contribute in one of three ways:

  1. File bug reports using the issue tracker.
  2. Answer questions or fix bugs on the issue tracker.
  3. Contribute new features or update the wiki.

The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable.

License

MIT