EventMachine

Posted by Technohippy Tue, 09 Jan 2007 06:32:00 GMT

http://eventmachine.rubyforge.org/wiki/wiki.pl勝手訳

Ruby/EventMachine

Ruby/EventMachineはシングルスレッドなネットワークソケットエンジンを提供する外部ライブラリです。これはReactorPatternを使ってネットワークI/Oをハンドルするように実装されています。EventMachineは特にパフォーマンスと使いやすさに注力しています。

バックグランド

EventMachineはRubyでネットワークを意識したプログラム、例えばIPC、分散システム、メッセージキュー、リモートオブジェクト呼び出しなど、を書く必要が出てきたことから作り始めました。私たちはC++のネットワークライブラリでよく見られるイベント駆動モデル(“リアクタ”パターン)を組み込んだRubyマシンを作ろうといろいろと試してみましたが、パフォーマンス上の問題や、Rubyラッパーを使ってどのようにネットワークレベルのエラーやブロッキングを実現したらよいかが不明なことから、それらの要素についてはC++エクステンションで書くことにしました。

イベント駆動ネットワークプログラミング

EventMachineはRubyプログラマに、ほとんどのプログラマが一般的に使っている単一コントロールフローな(命令型の)モデルではなく、イベント駆動なプログラミングモデルを提供します。異論も多くありますが、コントロールフローがクライアントを簡単に書けるのに対して、イベントモデルを使うとサーバーの開発が単純になるというのは、多くの場合、真実だと考えられています。EventMachineはサーバーとクライアントの両方の開発を比較的簡単にすることを目標にしています。

一般に、EventMachineを使うとプログラムが、プロトコルの細部を扱う代わりに、PDU(プロトコルデータユニット)を扱うことができるのでネットワークプログラミングが簡単になります。この利点は多くのプロトコルで有効です。

これまでにEventMachineを使ってLDAPクライアントとサーバー、SMTPサーバー、そのほかいくつかの小さなプログラムが作成されました。また現在開発中のプロジェクトとしてはメッセージルーターのキューイングとRubyオブジェクトのリモート呼び出しがあります。初期の経験を通して、他のI/Oを直接使うよりもEventMachineを使った方がネットワークサーバーをずっと簡単に書けることが分かりました。EventMachineを使うとクライアントも簡単に書けいますが、その利点はサーバーほど大きくありません。予備的なパフォーマンステストの結果、期待通りEventMachineは非常に高速でスケーラブルであることが分かっています。

(イベント駆動プログラミングについてもっと説明が必要？)

EventMachineはどうやって使うのか？

EventMachineでは、あなたの作るRubyプログラムからライブラリ自身の中で実装されたプロセスループを初期化するメソッドを呼び出します。実行中にそのプロセスループから適切なタイミングで(一分に一回以上)呼び出されるコールバックを定義します。コールバックのうちの一つのコードが終了するまでループは終了しません。最大でも一つのEventMachineプロセッシングループだけが特定の時点ではアクティブになることが許されますが、(マシンリソース次第では)単一のループが任意の数のネットワークコネクションを同時に扱うことができます。

どうやってネットワークサーバーを作ればいいのか？単純に書けば、EventMachineのメソッドを呼んでリスンするIPアドレスとポートを指定し、(オプションとして)プロトコルデータをハンドルするRubyモジュールも指定するだけです。異なるアドレス／ポートの組み合わせであれば、(リソース次第で)いくつでもTCPサーバーを実行できます。

クライアントはどうやってどうやってリモートサーバーに接続するのか？これも簡単で、EventMachineのメソッドを呼んでリモートホストのIPアドレスとポートを指定し、(オプションとして)プロトコルデータをハンドルするRubyモジュールも指定するだけ！簡単でしょ。

では、コールバックしてほしいコードがあるときは？クライアントとサーバーであなたの定義したイベントが発生したとき。あなたのコードは次の時に呼び出されます:

1. サーバーの内のいずれかに新しいコネクションがアクセプトされたとき
2. あなた自身のクライアントのいずれかがリモートホストからのデータパケットを受け取ったとき
3. 接続しているリモートクライアントがデータパケットを送信したときはいつでも
4. クライアントまたはサーバーが接続を終了したとき
5. (あなたの指定できる)タイマーが失効したとき

コールバックされたときに何ができるか？あらゆるコネクションにデータを送信でき、別のクライアントやサーバーを作成でき、任意の接続をクローズでき、イベントループを終了でき、好きなRubyコードを実行できます。

なお、EventMachineのプロセスモデルはシングルスレッドです。つまり、コールバックコードが再帰的に再入されたとしても、特定の時点で実行されるネットワークイベントは一つだけ、という事実に動作が依存してしまう可能性があります。(このデザインを選んだのには十分な理由があります: なぜそうしたかについて知りたければ質問してください)

簡単な例

以下はEventMachineで実装された完璧に動作するエコーサーバーです:

  require 'rubygems'
  require 'eventmachine'

  module EchoServer
    def receive_data data
      send_data ">>>you sent: #{data}"
      close_connection if data =~ /quit/i
    end
  end

  EventMachine::run {
    EventMachine::start_server "192.168.0.100", 8081, EchoServer
  }

なにが起きているのか？EchoServerモジュールを定義して、エコープロトコルのセマンティクスを実装しました(すぐにもう少し詳しく説明します)。最後の3行でイベントマシンそのものを呼び出して、コールバックのいずれかが終了を呼び出さない限りは走り続けるようにしています。EventMachine::runに渡すブロックはイベントマシンが初期化されるとすぐ、ループを開始する前に実行されるコードを記述します。ここはリスンするアドレスとポートを、データを処理するためのモジュールとともに指定して、TCPサーバーを起動するための場所です。

このEchoServerは極端に単純すぎるので、エコープロトコルに多くは望めません。基本的には何を送ってもリモートピアからそのまま送り返されることだけです。少しだけ面白くするために追加の小さな文章を追加して返すようにして、さらに受け取ったデータが”quit”という単語を含んでいたらコネクションをクローズするようにしました。

このEchoServerモジュールについては？ネットワークコネクションが開始すると(クライアントでもサーバーでも)常に、EventMachineは無名クラスをインスタンス化し、そこにあなたのモジュールをミキシンします。コネクションそれぞれに対して必ずそれらのクラスのインスタンスが作成されます。指定されたコネクションでイベントが発生すると、対応するオブジェクトが自動的に、モジュール内で再定義可能な、特定のインスタンスメソッドを呼び出します。モジュール内のコードは常にクラスインスタンスのコンテキストで実行されるため、望むならインスタンス変数を作成することもでき、それらは同じコネクション内のほかのコールバックに受け渡されます。

EchoServerをもう一度見直すと、receive_dataメソッドを定義していたことが分かり、(とても驚いたことに)そのメソッドがデータをリモート接続先から受け取ったときに常に呼び出されます。簡単でしょう？データ(Stringオブジェクト)を受け取り、それに対してなんでも好きなことができます。 今回はsend_dataメソッドを使用して受け取ったデータにすこし文章を追加して呼び出し側に返します。 そしてユーザーが”quit”という単語を送ったら、(もちろん)close_connectionを使ってコネクションをクローズします。(コネクションをクローズしても処理中のループは終了しないことに注意してください。そうじゃないとエコーサーバーがもうコネクションを受け付けられなくなってしまいます！)