Documentation updates
This commit is contained in:
parent
5689ba3bd0
commit
3b717eb5b8
15
README.md
15
README.md
@ -1,13 +1,12 @@
|
|||||||
# RFC6455 - The WebSocket Protocol
|
# RFC6455 - The WebSocket Protocol
|
||||||
|
|
||||||
This library is meant to be a protocol handler for the RFC6455 specification.
|
[](https://travis-ci.org/ratchetphp/RFC6455)
|
||||||
|
|
||||||
---
|
This library a protocol handler for the RFC6455 specification.
|
||||||
|
It contains components for both server and client side handshake and messaging protocol negotation.
|
||||||
|
|
||||||
### A rough roadmap
|
Aspects that are left open to interpertation in the specification are also left open in this library.
|
||||||
|
It is up to the implementation to determine how those interpertations are to be dealt with.
|
||||||
|
|
||||||
* v0.1 is the initial split from Ratchet/v0.3.2 as-is. In this state it currently relies on some of Ratchet's interfaces.
|
This library is independent, framework agnostic, and does not deal with any I/O.
|
||||||
* v0.2 will be more framework agnostic and will not require any interfaces from Ratchet. A dependency on Guzzle (or hopefully PSR-7) may be required.
|
HTTP upgrade negotiation integration points are handled with PSR-7 interfaces.
|
||||||
* v0.3 will look into performance tuning. No more expected exceptions.
|
|
||||||
* v0.4 extension support
|
|
||||||
* v1.0 when all the bases are covered
|
|
||||||
|
@ -2,17 +2,17 @@
|
|||||||
"name": "ratchet/rfc6455",
|
"name": "ratchet/rfc6455",
|
||||||
"type": "library",
|
"type": "library",
|
||||||
"description": "RFC6455 protocol handler",
|
"description": "RFC6455 protocol handler",
|
||||||
"keywords": ["WebSockets"],
|
"keywords": ["WebSockets", "websocket", "RFC6455"],
|
||||||
"homepage": "http://socketo.me",
|
"homepage": "http://socketo.me",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"authors": [
|
"authors": [{
|
||||||
{
|
"name": "Chris Boden"
|
||||||
"name": "Chris Boden", "email": "cboden@gmail.com", "role": "Developer"
|
, "email": "cboden@gmail.com"
|
||||||
}
|
, "role": "Developer"
|
||||||
],
|
}],
|
||||||
"support": {
|
"support": {
|
||||||
"forum": "https://groups.google.com/forum/#!forum/ratchet-php",
|
, "forum": "https://groups.google.com/forum/#!forum/ratchet-php"
|
||||||
"issues": "https://github.com/ratchetphp/RFC6455/issues",
|
, "issues": "https://github.com/ratchetphp/RFC6455/issues"
|
||||||
"irc": "irc://irc.freenode.org/reactphp"
|
"irc": "irc://irc.freenode.org/reactphp"
|
||||||
},
|
},
|
||||||
"autoload": {
|
"autoload": {
|
||||||
|
@ -161,7 +161,7 @@ function createReport() {
|
|||||||
$rawResponse = "";
|
$rawResponse = "";
|
||||||
$response = null;
|
$response = null;
|
||||||
|
|
||||||
/** @var \Ratchet\RFC6455\Messaging\Streaming\MessageBuffer $ms */
|
/** @var \Ratchet\RFC6455\Messaging\MessageBuffer $ms */
|
||||||
$ms = null;
|
$ms = null;
|
||||||
|
|
||||||
$stream->on('data', function ($data) use ($stream, &$rawResponse, &$response, &$ms, $cn, $deferred, &$context, $cnRequest) {
|
$stream->on('data', function ($data) use ($stream, &$rawResponse, &$response, &$ms, $cn, $deferred, &$context, $cnRequest) {
|
||||||
|
Loading…
Reference in New Issue
Block a user