faeez/mxmbsocket
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Repo. Project Releases Wiki Activity

Updating readme

Browse Source
This commit is contained in:
Chris Boden 2012-04-29 20:50:44 -04:00
parent f2c4a300f3
commit f1499ffb0e
1 changed files with 5 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -5,7 +5,6 @@
A PHP 5.3 (PSR-0 compliant) component library for serving sockets and building socket based applications. A PHP 5.3 (PSR-0 compliant) component library for serving sockets and building socket based applications.
Build up your application through simple interfaces using the decorator and command patterns. Build up your application through simple interfaces using the decorator and command patterns.
Re-use your application without changing any of its code just by combining different components. Re-use your application without changing any of its code just by combining different components.
Ratchet's primary intention is to be used as a WebSocket server.
##WebSockets ##WebSockets
@ -19,17 +18,14 @@ To avoid proxy/firewall blockage it's recommended WebSockets are run on port 80,
Note that you can not run two applications (Apache and Ratchet) on the same port, thus the requirement for a separate machine (for now). Note that you can not run two applications (Apache and Ratchet) on the same port, thus the requirement for a separate machine (for now).
Cookies from your domain will be passed to the socket server, allowing you to identify users. Cookies from your domain will be passed to the socket server, allowing you to identify users.
Accessing your website's session data in Ratchet is a [feature in the works](https://github.com/cboden/Ratchet/tree/symfony/sessions). Accessing your website's session data in Ratchet requires you to use [Symfony2 HttpFoundation Sessions](http://symfony.com/doc/master/components/http_foundation/sessions.html) on your website.
### 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. See https://github.com/cboden/Ratchet-examples for some out-of-the-box working demos using Ratchet.
###Future considerations
Ideally, soon, web servers will start supporting WebSockets to some capacity and PHP will no longer need to run its self from the command line.
In theory, the server (like Nginx) would recognize the HTTP handshake request to upgrade the protocol to WebSockets and run/pass data through to a user
configured PHP file. When this happens, you can keep your script the same, just remove the IOServerComponent wrapper and maybe eventually the
WebSocketComponent wrapper if the servers recognize the protocol message framing.
--- ---
###A quick server example ###A quick server example