名前¶

Net::Server::Multiplex - 一つのプロセス内の多重化接続

概要¶

  package MyPlexer;

  use base 'Net::Server::Multiplex';

  sub mux_input {
     #...コード...
  }

  __PACKAGE__->run();

説明¶

このパーソナリティは、一つのプロセスで複数接続全てを処理する ように設計されている。パケットベースで素早い応答が可能である ことを保証しているプロトコルを伴う場合にのみ、このモジュールを 使用するべきである。あるレスポンスを決定するのにしばらく かかる、あるいはどのくらいかかるのかわからない場合、既に確立 された全ての接続は、そのレスポンスが完了するまでブロックする。 この状況が発生するようなら、このパーソナリティは恐らく使うべき ではない。

このモジュールはNet::Serverの優れた特徴（ソケット立ち上げ、 設定ファイルの処理、安全なシグナル処理、便利なinetスタイルの STDIN/STDOUT処理、ログの記録、デーモン化とpidの追跡、 そして再起動可能 - SIGHUP）と、IO::Multiplexの優れた特徴（ 自動的にバッファされるIOとファイルハンドル毎のオブジェクト）を 持ち、簡単に使えるインターフェースとしてそれらを結合している。

Net::Serverと一緒に配布されるexamples/samplechat.plを参照。 そこにはこれらの機能のいくつかを利用した簡単なチャットサーバの 例がある。

処理の流れ¶

処理の流れは、オープンでオーバーライドしやすく、hookが 簡単なように書かれている。基本的な流れは次のようになる。

  $self->configure_hook;

  $self->configure(@_);

  $self->post_configure;

  $self->post_configure_hook;

  $self->pre_bind;

  $self->bind;

  if( Restarting server ){
     $self->restart_open_hook();
  }

  $self->post_bind_hook;

  $self->post_bind;

  $self->pre_loop_hook;

  $self->loop; # 基本的にIO::Multiplex::loopを実行しているだけ
  # ルーチンは$self->loop内部
  # 下のクライアント処理(CLIENT PROCESSING)を参照

  $self->pre_server_close_hook;

  $self->post_child_cleanup_hook;

  $self->server_close;

  if( Restarting server ){
     $self->restart_close_hook();
     $self->hup_server;
     # Redo process again starting with configure_hook
     # configure_hookを開始して、再び処理を繰り返す
  }

それからサーバは終了する。

クライアント処理¶

以下は、クライアント処理プログラムの流れを示している：

  $self->{server}->{client} = Net::Server::Proto::TCP->accept();  # 注意：下のmux_input()で多重化されている

  if (check_for_dequeue seconds have passed) {
    $self->run_dequeue();
  }

  $self->get_client_info;

  $self->post_accept_hook; # Net::Server型

  if( $self->allow_deny

      && $self->allow_deny_hook ){

    # (Net::Serverの$self->process_request()は決して呼ばれない)

    # この時点で、全てのmux_*メソッド用に
    # 一意なクライアントを指定するオブジェクトが生成される
    $self = __PACKAGE__->new($self, client);

    $self->mux_connection; # IO::Multiplex型

    for (every packet received) {
      $self->mux_input;  # 注意：上のaccept()で多重化
    }

  }else{

    $self->request_denied_hook;


    # allow_denyかallow_deny_hookのどちらかが失敗した場合、
    # new(), mux_connection(), とmux_input() は決して呼ばれない
    # mux_eof() と mux_close() はまだ呼ばれる。しかしユニークな
    # クライアント指定オブジェクトの代わりに、共通のlistenソケット
    # コールバックオブジェクトが利用される。
  }

  $self->mux_eof;

  $self->post_process_request_hook;

  $self->mux_close;

このプロセスはそれから、次の接続用のaccept()と、入力が届いた 時にブロックするのを回避するためのmux_input()との間をループ する。

HOOKS¶

上で述べられた*_hookメソッドは、もしあなたが追加の機能を 提供したいなら、あなたのサブルーチンでオーバーライドされる。

Net::Serverのloop()メソッドはオーバーライドされて、代わりに IO::Multiplexのループルーチンが実行される。Net::Serverの メソッドは、もし必要なら、$self->{mux}を使って IO::Multipleオブジェクトにアクセスするかもしれない。 IO::Multipleメソッドは、必要なら、$self->{net_server}を 使ってNet::Serverオブジェクトにアクセスするかもしれない。

process_request()メソッドはこのパーソナリティでは決して使わない。

その他のNet::Serverのhookとメソッドは同じように働く。

$self->run_dequeue()

This hook only gets called in conjuction with the check_for_dequeue setting. It will run every check_for_dequeue seconds. Since no forking is done, this hook should run fast in order to prevent blocking the rest of the processing.

このhookは、check_for_dequeueのセッティングと共に呼び出されるだけ である。check_for_dequeue秒毎に実行される。forkは実行されないので、 このhookは処理の残りがブロックされるのを避けるよう、素早く実行 するべきである。

タイムアウト¶

set_timeout¶

IO::Multiplexのオプションであるタイムアウト機能を利用するために set_timeoutメソッドを使ってタイムアウトを指定する必要がある。

$self->{net_server}->{mux}->set_timeout($fh, $seconds_from_now);

$fhはクライアントソケットか、mux内のlisten socketファイルの記述子 のどちらかになる。$seconds_from_nowはより正確なタイムアウトに達する 分数。mux_timeoutと共に使う。mux_timeoutは自ら定義する必要がある。

mux_timeout¶

メインのloop()ルーチンはset_timeoutで指定されたタイムアウト時間に 達したとき、$obj->mux_timeout($mux, $fh)を呼び出す。そこでの $fhはset_timeout()で指定されたものと同じである。そして、 $objは対応するオブジェクトである（ユニークなクライアント指定の オブジェクトか、メインとなるlistenコールバックオブジェクトの どちらか）。そして、$muxはメインのIO::Multiplexオブジェクトそのもの である。

コールバックインターフェース¶

コールバックオブジェクト次のにインターフェースをサポートしている。 あなたはこれら全てのメソッドを提供する必要はない。興味のあるもの だけでいい。これらは正にIO::Multiplexのhookのようなものだ。ただし、 STDOUTが対応するクライアントソケットハンドルにtieされているのを 除いてだが。これにより便利に、また、よりNet::Serverモデルをエミュレート するようになる。しかし、他のNet::Serverパーソナリティとは違って、 直接STDINから読み込むことはできない。次のメソッドを一つ以上定義する べきだ。

mux_connection ($mux,$fh)¶

（オプション） allow_denyをパスして、最初にクライアント接続がなされたときに一度だけ 実行される。$self->{net_server}->{server}プロパティハッシュは、 Net::Serverを通じて将来の接続により修正されるかもしれないことに注意。 後でオブジェクトが使うも知れないこの中の値は、その時点のオブジェクト自身 の中でコピーされる必要がある。

Example: $self->{peerport} = $self->{net_server}->{server}->{peerport};

mux_input ($mux,$fh,\$data)¶

（必須） パケットが読まれるたびに実行される。$dataの文字列は左側から消費され、 消費されなかったデータは将来mux_inputを呼び出すためにスカラーに残る。

mux_eof ($mux,$fh,\$data)¶

（オプション） クライアントが書き出した時に一度だけ実行される。$dataの 残りを消費するべきだ。というのも、mux_input()は決して再実行 されないだろうからだ。

mux_close ($mux,$fh)¶

（オプション） 完全にクライアント接続が閉じた後に実行される。そのクライアント やSTDOUTに対しては読み書きを試みてはいけない。

mux_timeout ($mux,$fh)¶

（オプション） 先に説明したset_timeoutの有効期限が切れたときに一度だけ 実行される。

バグ¶

これはTCPサーバとして動作することが知られているだけだ。

もしもIO::Multiplexのset_timeout / mux_timeoutインタフェースを 利用したいなら、Net:Serverのcheck_for_dequeue / run_dequeue インターフェースを使うことは出来ない。もしcheck_for_dequeue オプションが指定されていても動作しない。run_dequeueメソッドは、 Net::Server::Forkのrun_dequeueに対応する互換用インタフェースである。 だがこのrun_dequeueメソッドは、IO::Multiplexのset_timeoutと mux_timeoutメソッドの観点で実装されている。

あなたが見つけたその他の問題や課題を、作者である私にお知らせ願いたい。

作者¶

Copyright (C) 2001-2003, Rob Brown <[email protected]>

This package may be distributed under the terms of either the GNU General Public License or the Perl Artistic License

All rights reserved.

参考¶

Net::Server by Paul Seamons <[email protected]>,

IO::Multiplex by Bruce Keeler <[email protected]>.