faye/faye-websocket-ruby
1
0
Fork 0
mirror of https://github.com/faye/faye-websocket-ruby.git synced 2025-11-01 13:59:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

README tweaks.

Browse Source
This commit is contained in:
James Coglan
2011-11-22 19:15:12 +00:00
parent 87cd1e875f
commit 8603b342b7
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.rdoc
+10 -7
View File
@@ -2,18 +2,21 @@
This is a robust, general-purpose WebSocket implementation extracted from the
{Faye}[http://faye.jcoglan.com] project. It provides classes for easily building
WebSocket servers and clients in Ruby.
WebSocket servers and clients in Ruby. It does not provide a server itself, but
rather makes it easy to handle WebSocket connections within an existing
{Rack}[http://rack.rubyforge.org/] application running under
{Thin}[http://code.macournoyer.com/thin/]. It does not provide any abstraction
other than the standard {WebSocket API}[http://dev.w3.org/html5/websockets/].
Faye's WebSocket server can process {draft-75}[http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75],
The server-side socket can process {draft-75}[http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75],
{draft-76}[http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76],
{hybi-07}[http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07]
and later versions of the protocol. It selects protocol versions automatically
and presents the standard {WebSocket API}[http://dev.w3.org/html5/websockets/]
for you to program against. It supports both +text+ and +binary+ messages, and
automatically handles +ping+, +pong+, +close+ and fragmented messages.
and later versions of the protocol. It selects protocol versions automatically,
supports both +text+ and +binary+ messages, and transparently handles +ping+,
+pong+, +close+ and fragmented messages.
== Writing a WebSocket server
== Accepting WebSocket connections in Rack
You can handle WebSockets on the server side by listening for HTTP Upgrade
requests, and creating a new socket for the request. This socket object exposes