aboutsummaryrefslogtreecommitdiffhomepage
path: root/assets/php/vendor/cboden/ratchet/README.md
diff options
context:
space:
mode:
authormarvin-borner@live.com2018-04-16 21:09:05 +0200
committermarvin-borner@live.com2018-04-16 21:09:05 +0200
commitcf14306c2b3f82a81f8d56669a71633b4d4b5fce (patch)
tree86700651aa180026e89a66064b0364b1e4346f3f /assets/php/vendor/cboden/ratchet/README.md
parent619b01b3615458c4ed78bfaeabb6b1a47cc8ad8b (diff)
Main merge to user management system - files are now at /main/public/
Diffstat (limited to 'assets/php/vendor/cboden/ratchet/README.md')
-rwxr-xr-xassets/php/vendor/cboden/ratchet/README.md83
1 files changed, 0 insertions, 83 deletions
diff --git a/assets/php/vendor/cboden/ratchet/README.md b/assets/php/vendor/cboden/ratchet/README.md
deleted file mode 100755
index 3f1a345..0000000
--- a/assets/php/vendor/cboden/ratchet/README.md
+++ /dev/null
@@ -1,83 +0,0 @@
-# Ratchet
-
-[![Build Status](https://secure.travis-ci.org/ratchetphp/Ratchet.png?branch=master)](http://travis-ci.org/ratchetphp/Ratchet)
-[![Autobahn Testsuite](https://img.shields.io/badge/Autobahn-passing-brightgreen.svg)](http://socketo.me/reports/ab/index.html)
-[![Latest Stable Version](https://poser.pugx.org/cboden/ratchet/v/stable.png)](https://packagist.org/packages/cboden/ratchet)
-
-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.
-
-## 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](http://socketo.me/docs/deploy#serverconfiguration).
-
-### 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.
-
-Need help? Have a question? Want to provide feedback? Write a message on the [Google Groups Mailing List](https://groups.google.com/forum/#!forum/ratchet-php).
-
----
-
-### A quick example
-
-```php
-<?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);
- $app->route('/echo', new Ratchet\Server\EchoServer, array('*'));
- $app->run();
-```
-
- $ php chat.php
-
-```javascript
- // 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!'); };
-```