橋本商会

RocketIOではevent_emitterという（node.jsのを参考にして作った）イベント管理機構を使っている（Ruby用、JavaScript用）


event_emitterの全てのイベントを取得する手段がある


Ruby

user.on :* do |event_name, args|

  puts event_name  # 呼び出されたイベント名

  p args

end

JavaScript

user.on('*', function(event_name, data){

  console.log(event_name + ' was called');

  console.log(data);

});

RocketIOでも、これを使っているので

Sinatra::RocketIO.on :* do |event_name, args|

  puts "#{event_name} - #{args.inspect}"

end

とするとサーバー側で起こったイベント全部取れるし

var io = new RocketIO().connect();

io.on("*", function(event_name, args){

  console.log(event_name);

  console.log(args);

});

これでクライアント側のイベント全部取れる。


関係ないクライアントにデータ送信してるかも、とか、余計なイベント送ってるかも等の調査に便利。

nodeのSocket.ioっぽい物のRuby版を作った。

https://github.com/shokai/sinatra-rocketio

依存

EventMachineが有効なWebサーバー（thinとか）と、jQueryが必要。
Rubyは1.8.7〜2.0.0まで動く。

Sinatraで使う

インストール

gem install sinatra-rocketio

ブラウザとか回線に応じてWebSocketとCometの使える方が自動的に選ばれる。
切断されても定期的に再接続を試みるようになってる。


sinatraに読みこむだけで使える。sinatraのプロセス内にwebsocketサーバーも組み込まれる。

require 'sinatra'

require 'sinatra/rocketio'

modular styleではclass内でregisterすればok

class MyApp < Sinatra::Base

  register Sinatra::RocketIO

  ## 略

end

サーバーからブラウザにpushするの簡単にできる

Sinatra側

io = Sinatra::RocketIO



io.push :temperature, 35  # 全てのクライアントに送信

io.push :light, {:value => 150}, {:to => session_id} # 特定のクライアントへ

pushはsinatraのgetとかpostの中に書いてもいい。どこに書いてもpushできる。


クライアント側。JSライブラリを読み込む。

<script src="<%= rocketio_js %>"></script>

hamlの場合はこう

%script{:src => rocketio_js}

そしてJavaScriptに受信イベント書く

var io = new RocketIO().connect(); // WebSocketとCometの適当な方が使われる

io.on("temperature", function(value){

  console.log("温度 : " + value);

}); // => "温度 : 35"

io.on("light", function(data){

  console.log("明るさ : " + data.value);

}); // => "明るさ : 150"

通信というより、クライアント側でイベント登録しておいてサーバーから呼び出せる感じ。

クライアントからサーバーへ送信

JS側

io.on("connect", function(){

  io.push("chat", {name: "shokai", message: "hello"});

});

Ruby側

io.on :chat do |data, client|

  puts "#{data['name']} : #{data['message']}  <#{client.session}> type:#{client.type}"

  io.push :chat, data  # 全クライアントに返送

end

逆も同じ要領でできる。”chat”というイベントを登録しておいて受信してみた。
チャットなので全クライアントに返送もする。

サーバーは、クライアントのセッションIDとtype(websocketかcometか)も取れる。

通信方法のまとめ

サーバー側
Sinatra::RocketIO.on “イベント名” でイベント登録して受信。
Sinatra::RocketIO.push “イベント名”, “データ” で送信。

クライアント側
var io = new RocketIO().connect(); で得たio（RocketIOのインスタンス）を使う。
io.on(“イベント名”, コールバック関数) でイベント登録して受信。
io.push(“イベント名”, データ) でサーバーに送信。


だいたいこんな感じで使える。

試しにチャットを作ってみた

http://rocketio-chat.herokuapp.com/
herokuなのでwebsocketが使えなくて全員cometで接続される。

http://dev.shokai.org:4000/
さくらVPSサーバーなのでwebsocket＆comet両方とも使える。


ソースコードはここ https://github.com/shokai/rocketio-chat-sample
サーバー側Ruby 25行、クライアント側JS 39行でチャット作れてた。

構成

Comet部分はSinatra CometIOという独立したSinatraプラグインで実装してある。これを一番最初に作った。
WebSocket部分もSinatra::WebSocketIOという、Cometと同じAPIで使えるやつで実装した。
RocketIOはこれらをまとめた。


イベント登録して発火する部分は、event_emitter.jsとevent_emitter.rbというJSとRubyそれぞれで使えるイベント管理ライブラリを作った。

性能

2年前に買ったMacMini上のVMWareで動かしてるUbuntuで
WebSocketは1万5千クライアント、Cometは500クライアントぐらい同時接続して普通に動いた。
WebSocketは1万クライアント接続して、そのうち1つがサーバーにpush、サーバーが全クライアントに返送し終わるまで平均0.7秒ぐらい。
CPUが良ければもっといけると思う。

同時接続数を1万以上やるにはOSのファイルディスクリプタの設定とか必要。
https://github.com/shokai/sinatra-websocketio/wiki/C10K

これ → 64bit Ubuntu+Arduino UNOでarduino_firmataが動かないらしい

なおった。Raspberry Piでも安定して動くようになった。

serialport gemの read_nonblockとwrite_nonblockを使っていると、DebianやUbuntuで動かなくなっていたのでデフォルトでnonblock使わないようにした。


今まで通りノンブロッキングIOで使いたい人は接続時に

arduino = ArduinoFirmata.connect "/dev/tty.usb-device-name", :nonblock_io => true

で接続すればいい

Arduino Firmata on Ruby

2年前に作ったim.kayac.comのgemを久しぶりに見たら直したくてしょうがなくなったので直した。
APIを変えたので、対応するの面倒な人はGemfileに

gem "im-kayac", "< 0.1.0"

として古いの使ってください。

インストール

gem install im-kayac

gemの使い方

ユーザ名指定してgoogle talkやiphoneにメッセージを送れる。

require 'im-kayac'

ImKayac.to('username').post('hello world')

パスワード認証や秘密鍵認証も使える

ImKayac.to('username').password('your-password').post('hello')

ImKayac.to('username').secret('your-key').post('hello')

im-kayac コマンド

コマンドもつけてみた。gemインストールすれば使える。

% im-kayac --help

% im-kayac -to USERNAME "hello!!"

パスワード認証とかも対応している

% im-kayac -to USERNAME -password PASSWORD "はらへった"

% im-kayac -to USERNAME -secret SECRET_KEY "これは秘密鍵使ってる"

ruby の代わりに、 $HOME/.rvm/bin/ruby-1.9.2-p320 などを使えばいいらしい。
rvmそれぞれの環境でインストールしたrubygemsにもパスが通って使えるようになる。

このファイルは中身を見るとシェルスクリプトで、rvm use 1.9.2-p320しながら引数をrubyに渡す感じになってる。


俺普段Ruby1.9か2.0使ってるんだけど、今までなんか面倒くさくてRuby1.8でも動くようにプログラム書いてsystem rubyにも同じgemインストールして動かしてた。

前に書いた自動日記をtwitterに流すようにしたってやつも、こうしたらRuby1.9で毎日1時にtweetするようになった。

0 1 * * * cd $HOME/src/ruby/autodiary && $HOME/.rvm/bin/ruby-1.9.2-p320 autodiary.rb -tweet shokai > /dev/null 2>&1

autodiaryのディレクトリに置いてあるGemfileも読まれてちゃんと動く。good.
crontabの上の方で環境変数をゴニョゴニョするとかshellも全く必要なし。


参考：RVM: Ruby Version Manager – Using Cron with RVM