* [ANN] Sunshowers - Web Sockets for Ruby, Rack+Rainbows!
@ 2009-12-13 23:43 Eric Wong
0 siblings, 0 replies; only message in thread
From: Eric Wong @ 2009-12-13 23:43 UTC (permalink / raw)
To: sunshowers-TBHja+091Wbby3iVrkZq2A, ruby-talk
Cc: rainbows-talk-GrnCvJ7WPxnNLxjTenLetw
Sunshowers is a Ruby library for Web Sockets. It exposes an easy-to-use
API that may be used in both clients and servers. On the server side,
it is designed to work with Rack::Request and Rainbows! concurrency
models that expose a synchronous application flow. On the client side,
it may be used as a standalone wrapper for IO-like objects.
* http://rainbows.rubyforge.org/sunshowers/
* sunshowers-TBHja+091Wbby3iVrkZq2A@public.gmane.org
* git://git.bogomips.org/sunshowers.git
It appears works well with the echo_client.py example shipped with
pywebsocket. It has not been tested against normal web browsers, though
there's no reason it shouldn't work.
== Features
* supports reads and writes of both UTF-8 and binary Web Socket frames
* compatible with Revactor, Rainbows::Fiber::IO and core Ruby IO objects
* pure Ruby implementation, should be highly portable, tested under 1.9
== Install
You may download the tarball from the Rainbows! project page on Rubyforge
and run setup.rb after unpacking it:
http://rubyforge.org/frs/?group_id=8977
You may also install it via RubyGems on Gemcutter:
gem install sunshowers
== Usage
Make sure you're using one of the following concurrency models
for Rainbows!:
* FiberSpawn
* FiberPool
* Revactor
* ThreadSpawn
* ThreadPool
# A simple echo server example
require "sunshowers"
use Rack::ContentLength
use Rack::ContentType
run lambda { |env|
req = Sunshowers::Request.new(env)
if req.ws?
req.ws_handshake!
ws_io = req.ws_io
ws_io.each do |record|
ws_io.write(record)
break if record == "Goodbye"
end
req.ws_quit! # Rainbows! should handle this quietly
end
[404, {}, []]
}
Already using a Rack::Request-derived class? Sunshowers::WebSocket may
also be included in any Rack::Request-derived class, so you can just
open it up and include it:
class Sinatra::Request < Rack::Request
include Sunshowers::WebSocket
end
See the examples/ directory in the source tree for a client example.
--
Eric Wong
_______________________________________________
Rainbows! mailing list - rainbows-talk-GrnCvJ7WPxnNLxjTenLetw@public.gmane.org
http://rubyforge.org/mailman/listinfo/rainbows-talk
Do not quote signatures (like this one) or top post when replying
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2009-12-13 23:43 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2009-12-13 23:43 [ANN] Sunshowers - Web Sockets for Ruby, Rack+Rainbows! Eric Wong
Code repositories for project(s) associated with this public inbox
https://yhbt.net/rainbows.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).