名前¶

Net::Server::PreForkSimple - Net::Serverのパーソナリティ

概要¶

  use Net::Server::PreForkSimple;
  @ISA = qw(Net::Server::PreFork);

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

  __PACKAGE__->run();

説明¶

まず始めにNet::ServerのPODを読まれたし。このモジュールは パーソナリティ(personality)、すなわちNet::Serverの拡張 （サブクラス）である。

このサーバは一つ以上のポートにbindし、それから max_servers個の子プロセスをforkする。サーバは常に max_servers個のクライアントリクエストを受け付けられることを 保証する。子プロセスはそれぞれmax_requests個のクライアント 接続を処理する。このタイプはアクセスの激しいサイトに適して おり、サーバ処理のためにmax_server個のプロセスを維持できる。 （複数ポートを受け付けるためにデフォルトでflockを使って 子プロセスを直列化する）

サンプルコード¶

Net::Serverのサンプルリストを参照のこと。

コマンドラインからの引数¶

ベースとなるNet::Serverクラスのコマンドライン引数に加えて、 Net::Server::PreForkはいくつかの設定用パラメータを含む。

  Key               Value                   Default
  max_servers       \d+                     50
  max_requests      \d+                     1000

  serialize         (flock|semaphore|pipe)  undef
  # multi_portかSolarisでの直列化はflockがデフォルト
  lock_file         "filename"              POSIX::tmpnam

  check_for_dead    \d+                     30

  max_dequeue       \d+                     undef
  check_for_dequeue \d+                     undef

max_servers

The maximum number of child servers to start and maintain. This does not apply to dequeue processes.

開始及び維持する子サーバの最大数。dequeueプロセスには 適用されない。

max_requests

The number of client connections to receive before a child terminates.

子プロセスが終了するまえに受信するクライアント接続数。

serialize

Determines whether the server serializes child connections. Options are undef, flock, semaphore, or pipe. Default is undef. On multi_port servers or on servers running on Solaris, the default is flock. The flock option uses blocking exclusive flock on the file specified in lock_file (see below). The semaphore option uses IPC::Semaphore (thanks to Bennett Todd) for giving some sample code. The pipe option reads on a pipe to choose the next. the flock option should be the most bulletproof while the pipe option should be the most portable. (Flock is able to reliquish the block if the process dies between accept on the socket and reading of the client connection - semaphore and pipe do not)

サーバが子プロセスの接続を直列化(serialize)するかどうか決める。 オプションはundef、flock、semaphore、ないしはpipe。デフォルトは undef。multi_portサーバ上、あるいはSolarisで実行されるサーバ上 では、デフォルトはflockになる。flockオプションは、lock_file （後述）で指定されたファイルに対するflockの排他的ブロックを 利用する。semaphoreオプションはIPC::Semaphore（Bennett Todd）を 使って、いくつかのサンプルコードを与えている。pipeオプションは pipe上で読み込むことによって次のものを選択する。flockオプション は最も堅牢で、一方、pipeオプションは最もお手軽だろう。 （ソケットの受付とクライアント接続の読み込みとの間にプロセスが dieしてしまった場合、flockはブロックを解除することができる。 - これはsemaphoreとpipeではできないことだ。）

lock_file

Filename to use in flock serialized accept in order to serialize the accept sequece between the children. This will default to a generated temporary filename. If default value is used the lock_file will be removed when the server closes.

flockによる受付の直列化で使うファイル名。これにより、 子プロセス間で連続する受付を直列化する。デフォルトでは 一時的なファイル名を生成する。もしデフォルト値が使用された 場合、lock_fileはサーバが閉じた時に削除される。

check_for_dead

Seconds to wait before checking to see if a child died without letting the parent know.

親プロセスに知らせずに子プロセスが死んでしまったかどうかを チェックするまでの待ち時間の秒数。

max_dequeue

The maximum number of dequeue processes to start. If a value of zero or undef is given, no dequeue processes will be started. The number of running dequeue processes will be checked by the check_for_dead variable.

dequeue処理を始める最大数。もし値に0かundefを与えたなら、 dequeue処理は開始されない。実行しているdequeue処理の数は check_for_dead変数に応じてチェックされる。

check_for_dequeue

Seconds to wait before forking off a dequeue process. The run_dequeue hook must be defined when using this setting. It is intended to use the dequeue process to take care of items such as mail queues. If a value of undef is given, no dequeue processes will be started.

dequeue処理をfork offするまでに待機する秒数。 これはメールキューのような要素を取り扱う dequeue処理を使用する。もしも値にundefが与えられたら dequeueプロセスは開始されない。

設定ファイル¶

Net::Server::PreForkはサーバのパラメータを読み込むために 設定ファイルを利用することができる。設定ファイルの書式は 単純なキーと値の組だ。コメントと空白は無視される。

  #-------------- file test.conf --------------

  ### サーバ情報
  max_servers   80

  max_requests  1000

  ### 変更されるuserとgroup
  user        somebody
  group       everybody

  ### ログを記録するか？
  log_file    /var/log/server.log
  log_level   3
  pid_file    /tmp/server.pid

  ### アクセスコントロール
  allow       .+\.(net|com)
  allow       domain\.com
  deny        a.+

  ### バックグラウンドで実行するか？
  background  1

  ### bindするポート
  host        127.0.0.1
  port        localhost:20204
  port        20205

  ### 逆引きをするか？
  # reverse_lookups on

  #-------------- file test.conf --------------

処理の流れ¶

処理の流れはloop段階までNet::Serverと同じである。 この時点でmax_servers個のプロセスがforkされて接続待機に 入る。子プロセスが接続を受け付けるとき、クライアントの処理を 終えるとき、exitするとき、その情報は親プロセスに中継される。 これにより親プロセスは追跡し、常にmax_servers個の子サーバ が実行されていることを保証する。

HOOKS¶

PreForkSimpleサーバは基本クラスであるNet::Serverの提供する hookに以下のものを付け加える。 Net::Serverを参照。

$self->child_init_hook()

This hook takes place immeditately after the child process forks from the parent and before the child begins accepting connections. It is intended for any addiotional chrooting or other security measures. It is suggested that all perl modules be used by this point, so that the most shared memory possible is used.

このhookは、親プロセスから子プロセスがforkされた直後で、かつ、 その子プロセスが接続を受け付け始める前に発生する。これは chrootやその他のセキュリティ手段を追加することを意図している。 この時点で、全てのperlモジュールが利用される。これにより 可能なほとんどの共有メモリが使われる。

$self->child_finish_hook()

This hook takes place immediately before the child tells the parent that it is exiting. It is intended for saving out logged information or other general cleanup.

このhookは、子プロセスがexitすることを親プロセスに伝える直前に 発生する。これはログ情報の保存や、その他一般的なクリーンアップを 意図している。

$self->run_dequeue()

This hook only gets called in conjuction with the check_for_dequeue setting.

このhookは、check_for_dequeueのセッティングと共に 呼び出される。

TO DO¶

Net::Serverを参照。

作者¶

Paul T. Seamons [email protected]

謝辞¶

See Net::Server

参考¶

以下も参照して欲しい。

Net::Server::Fork, Net::Server::INET, Net::Server::PreFork, Net::Server::MultiType, Net::Server::Single Net::Server::SIG Net::Server::Daemonize Net::Server::Proto