This article was migrated from http://rails.office.drecom.jp/takiuchi/archive/189

MeteorStrikeはRailsプラグインとして実装されたShootingStarクライアントです。ShootingStarに同梱されており、下記コマンドによってインストールされます。

$ cd /path/to/rails/application/dir
$ shooting_star init
$ ./script/generate meteor
$ rake db:migrate

MeteorStrikeは、MeteorController、Meteorモデル、Meteorビューの3つのコンポーネントと一つのヘルパーメソッド（meteor_strike）から構成されます。

ShootingStarアプリケーションを作成する場合、meteor_strikeメソッドをrhmltファイルに書き込むことで、Cometサーバとのやり取りを行います。

以下に、meteor_strikeメソッドに関する情報をまとめます。

　meteor_strike(channel, options = {})

channel:
　Cometサーバとの通信を行うChannel名を文字列で指定します。
　チャンネルごとに一つのHTTP接続が消費されます。

options:
以下のパラメータを設定します。いずれも省略可能です。

　:uid　ユーザ識別子。通常、session[:user].id等を指定します。
　:tag　同一チャンネル内で、イベントの通知範囲を限定するのに使用します。
　　　　HTTP接続数を節約するための軽量Channelとして扱われます。
　　　　文字列の配列を指定します。空配列はChannel全体にマッチします。
　:connected Cometサーバとの接続が確立された後で呼び出される
　　　　JavaScriptを指定します。
　:event イベントの処理を行うJavaScriptを指定します。
　　　　イベントハンドラの中から、以下の変数にアクセスできます。
　　　params.event: イベントの種類。'enter', 'leave', 'update'のいずれかの文字列。
　　　params.tags: イベントが関連するタグ
　　　params.uid: イベントに関連するユーザ識別子

MeteorStrike JavaScript API

続いて、MeteorStrikeを制御するJavaScript APIを紹介します。

meteorStrike['channel-name'].update(uid, tags)
　クライアントのユーザ識別子およびタグを変更します。tagsはタグ文字列の配列です。

meteorStrike['channel-name'].tuneIn(tags)
　現在のタグにtagsで指定したタグを追加します。

meteorStrike['channel-name'].tuneOut(tags)
　現在のタグからtagsで指定したタグを取り除きます。

meteorStrike['channel-name'].getTags()
　現在のタグを取得します。

This article was migrated from http://rails.office.drecom.jp/takiuchi/archive/189