sinatra-websocketio
WebSocket component for Sinatra RocketIO
- Node.js like WebSocket I/O plugin for Sinatra
- https://github.com/shokai/sinatra-websocketio
- https://github.com/shokai/sinatra-websocketio/wiki
- Handle 10K+ clients on 1 process
Installation
% gem install sinatra-websocketio
Requirements
- Ruby 1.8.7 or 1.9.2 or 1.9.3 or 2.0.0
- Sinatra 1.3.0+
- EventMachine
- jQuery
Usage
Server --(WebSocket)--> Client
Server Side
require 'sinatra'
require 'sinatra/websocketio'
set :websocketio, :port => 9000
run Sinatra::Applicationio = Sinatra::WebSocketIO
io.push :temperature, 35 # to all clients
io.push :light, {:value => 150}, {:to => session_id} # to specific clientClient Side
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
<script src="<%= websocketio_js %>"></script>var io = new WebSocketIO().connect();
io.on("temperature", function(value){
console.log("server temperature : " + value);
}); // => "server temperature : 35"
io.on("light", function(data){
console.log("server light sensor : " + data.value);
}); // => "server light sensor : 150"Client --(WebSocket)--> Server
Client Side
io.on("connect", function{
io.push("chat", {name: "shokai", message: "hello"}); // client -> server
});Server Side
io.on :chat do |data, session|
puts "#{data['name']} : #{data['message']} <#{session}>"
end
## => "shokai : hello <12abcde345f6g7h8ijk>"On "connect" Event
Client Side
io.on("connect", function(session){
alert("connect!!");
});
io.on("disconnect", function(){
alert("disconnected");
});Server Side
io.on :connect do |session|
puts "new client <#{session}>"
io.push :hello, "hello!!"
end
io.on :disconnect do |session|
puts "client disconnected <#{session}>"
endOn "error" Event
Client Side
io.on("error", function(err){
console.error(err);
});Server Side
io.on :error do |e|
STDERR.puts e
endRemove Event Listener
Server Side
event_id = io.on :chat do |data, from|
puts "#{data} - from#{from}"
end
io.removeListener event_idor
io.removeListener :chat # remove all "chat" listenerClient Side
var event_id = io.on("error", function(err){
console.error("WebSocketIO error : "err);
});
io.removeListener(event_id);or
io.removeListener("error"); // remove all "error" listenerConfig
set :websocketio, :port => 9000or
% WS_PORT=9000 rackup config.ru
Sample App
chat app
Test
% gem install bundler
% bundle install
start server
% rake test_server
run test
% rake test
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request