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

Rdoc doesn't like using + for code-ifying multi-word blocks.

Browse Source
This commit is contained in:
James Coglan
2013-04-20 19:45:56 +01:00
parent 5af19e1f1e
commit bf148cda91
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.rdoc
+9 -9
View File
@@ -98,15 +98,15 @@ A simple example might be:
end
To explain what's going on here: the +WS+ class implements the +env+, +url+ and
+write(string)+ methods as required. When instantiated with a Rack environment,
it stores the environment and infers the complete URL from it. Having set up
the +env+ and +url+, it asks <tt>WebSocket::Protocol</tt> for a server-side
handler for the socket. Then it uses the Rack hijack API to gain access to the
TCP stream, and uses EventMachine to stream in incoming data from the client,
handing incoming data off to the handler for parsing. Finally, we tell the
handler to +start+, which will begin sending the handshake response. This will
invoke the <tt>WS#write</tt> method, which will send the response out over the
TCP socket.
<tt>write(string)</tt> methods as required. When instantiated with a Rack
environment, it stores the environment and infers the complete URL from it.
Having set up the +env+ and +url+, it asks <tt>WebSocket::Protocol</tt> for a
server-side handler for the socket. Then it uses the Rack hijack API to gain
access to the TCP stream, and uses EventMachine to stream in incoming data from
the client, handing incoming data off to the handler for parsing. Finally, we
tell the handler to +start+, which will begin sending the handshake response.
This will invoke the <tt>WS#write</tt> method, which will send the response out
over the TCP socket.
Having defined this class we could use it like this when handling a request: