名前¶

Net::Server - Perlによる拡張可能な汎用サーバエンジン

概要¶

  #!/usr/bin/perl -w -T
  package MyPackage;

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

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

  MyPackage->run(port => 160);
  exit;

取得方法¶

http://seamons.com/ に最新バージョンがある

特徴¶

 * Single Server Mode
 * Inetd Server Mode
 * Preforking Simple Mode (PreForkSimple)
 * Preforking Managed Mode (PreFork)
 * Forking Mode
 * Multiplexing Mode using a single process
 * Multi port accepts on Single, Preforking, and Forking modes
 * Simultaneous accept/recv on tcp, udp, and unix sockets
 * Safe signal handling in Fork/PreFork avoids perl signal trouble
 * User customizable hooks
 * Chroot ability after bind
 * Change of user and group after bind
 * Basic allow/deny access control
 * Customized logging (choose Syslog, log_file, or STDERR)
 * HUP able server (clean restarts via sig HUP)
 * Dequeue ability in all Fork and PreFork modes.
 * Taint clean
 * Written in Perl
 * Protection against buffer overflow
 * Clean process flow
 * Extensibility

 * シングルサーバモード
 * Inetdサーバモード
 * 単純なプリフォークモード (PreForkSimple)
 * 管理されたプリフォークモード (PreFork)
 * フォークモード
 * 単一プロセスを利用した多重化モード
 * シングル、プリフォーク、フォークモードで複数ポートにacceptできる
 * tcp、udp、unixソケットに対し同時にaccept/recvできる
 * Fork/PreForkで安全にシグナルを扱うことによってPerlのシグナルトラブルを回避
 * hookを使ってユーザカスタマイズが可能
 * bind後にchroot可能
 * bind後にuserとgroupを変更
 * 基本的な allow/deny アクセスコントロール
 * ログ取りのカスタマイズ（Syslog、logファイル、あるいはSTDERRから選択）
 * HUP可能なサーバ（HUPシグナルを通じてクリーンに再起動）
 * 全てのフォーク及びプリフォークモードでキューの取り出しが可能
 * 汚染チェックモード(Taint)で正しく動作する
 * Perlで書かれている
 * バッファオーバーフローから守られる
 * クリーンなプロセス制御
 * 拡張可能

説明¶

Net::Serverは拡張可能な汎用Perlサーバエンジンである。 Net::ServerはNet::Daemon (0.34)とNetServer::Generic (1.03)、 そしてNet::FTPServer (1.0)の持っている優れた性質と、さらには Apache Webサーバにおける様々なコンセプトとを結合している。

Net::ServerはNet::DaemonとNetServer::Genericのような 汎用サーバになることを試みる。これには以下のような機能が含まれる。 すなわち、inetdプロセス（Net::Server::INET）、シングルコネクション サーバ（Net::ServerあるいはNet::Server::Single）、フォークサーバ （Net::Server::Fork）、予めforkされた子プロセスを一定数維持する プリフォークサーバ（Net::Server::PreForkSimple）、あるいはサーバへの 負荷に応じて子プロセス数を制御するプリフォークサーバ （Net::Server::PreFork）として実行することができる。inetdタイプを 除いて、全てのサーバは一つ以上のポートをコネクトすることができる。

Net::Serverは拡張性を提供するためにNet::FTPServerの理念を利用している。 追加されるサーバタイプは"パーソナリティ"(personalities)、すなわち Net::Serverのサブクラスを通じて可能となる。メインとなる Net::Serverクラスからマルチタイプのサーバへと移行することによって、 Net::Serverのコンセプトは容易に別のタイプへと拡張される （我々は近い将来、"スレッド"パーソナリティを追加したいと思っている）。

Net::ServerはApache Webサーバから幾つかの概念を借りている。 ベースとなるNet::Serverクラスの上に積み重ねるために SMTP、HTTP、POP3のようなカスタムサーバを可能にするよう、 "フック"(hooks)を利用する。加えて、Net::Server::PreForkクラスは min_start_servers、max_servers、そしてmin_waiting_serversという概念を 借りている。また、Net::Server::PreForkは複数のポートに対して待ち受けを 行う際に、flockによる直列化されたacceptという考えも利用している （PreForkは直列化を制御するために、flock、IPC::Semaphore、そしてパイプの いずれかを選ぶことができる）。

パーソナリティ¶

Net::Serverは共通クラス（Net::Server）の周囲に構築される。 そしてサブクラス、すなわちpersonalitiesを利用して拡張される。 各パーソナリティは基底クラスのメソッドを継承・オーバーライド、 エンハンスする。

Net::Serverパッケージには幾つかのベースパーソナリティが含まれているが、 それらは皆、独自の利用をする。

Fork

Found in the module Net/Server/Fork.pm (see Net::Server::Fork). This server binds to one or more ports and then waits for a connection. When a client request is received, the parent forks a child, which then handles the client and exits. This is good for moderately hit services.

Net/Server/Fork.pmに基づく（Net::Server::Forkを参照）。 このサーバは一つ以上のポートにbindし、コネクションを待つ。 クライアントのリクエストを受け取ると、親プロセスは子プロセスを forkし、子プロセスがクライアントの処理を制御し、exitする。 これはサーバへのアクセスが穏やかな場合に適している。

INET

Found in the module Net/Server/INET.pm (see Net::Server::INET). This server is designed to be used with inetd. The pre_bind, bind, accept, and post_accept are all overridden as these services are taken care of by the INET daemon.

Net/Server/INET.pmに基づく（Net::Server::INETを参照）。 このサーバはinetdを利用するように設計されている。 pre_bind、bind、acceptそしてpost_acceptは全て INETデーモンによって扱われるサービスとしてオーバーライドされる。

MultiType

Found in the module Net/Server/MultiType.pm (see Net::Server::MultiType). This server has no server functionality of its own. It is designed for servers which need a simple way to easily switch between different personalities. Multiple server_type parameters may be given and Net::Server::MultiType will cycle through until it finds a class that it can use.

Net/Server/MultiType.pmに基づく（Net::Server::MultiTypeを参照）。 このサーバはそれ自身としてサーバの機能は持たない。 様々なパーソナリティを簡単に切り替えるための単純な方法を必要とする サーバのためにデザインされている。複数の server_typeパラメータが 与えられると、利用可能なクラスが見つかるまで、Net::Server::MultiTypeは順に 探していく。

Multiplex

Found in the module Net/Server/Multiplex.pm (see Net::Server::Multiplex). This server binds to one or more ports. It uses IO::Multiplex to multiplex between waiting for new connections and waiting for input on currently established connections. This personality is designed to run as one process without forking. The process_request method is never used but the mux_input callback is used instead (see also IO::Multiplex). See examples/samplechat.pl for an example using most of the features of Net::Server::Multiplex.

Net/Server/Multiplex.pmに基づく（Net::Server::Multiplexを参照）。 このサーバは一つ以上のポートにbindする。新しいコネクションのための待機と、 現在確立されたコネクションからの入力待ちとを多重化するために、 IO::Multiplexを利用する。このパーソナリティはforkを使わないで一つの プロセスとして実行するために設計されている。process_requestメソッドは 決して使われず、代わりにmux_inputコールバックが利用される （IO::Multiplexも参照）。Net::Server::Multiplexのほとんどの機能を使っている サンプルコードexamples/samplechat.plを参照のこと。

PreForkSimple

Found in the module Net/Server/PreFork.pm (see Net::Server::PreFork). This server binds to one or more ports and then forks max_servers child process. The server will make sure that at any given time there are always max_servers available to receive a client request. Each of these children will process up to max_requests client connections. This type is good for a heavily hit site that can dedicate max_server processes no matter what the load. It should scale well for most applications. Multi port accept is accomplished using either flock, IPC::Semaphore, or pipe to serialize the children. Serialization may also be switched on for single port in order to get around an OS that does not allow multiple children to accept at the same time. For a further discussion of serialization see Net::Server::PreFork.

Net/Server/PreForkSimple.pmに基づく（Net::Server::PreForkSimpleを参照）。 このサーバは一つ以上のポートにbindし、max_servers個の子プロセスを forkする。サーバは常にmax_servers個のクライアントリクエストを 受け付けられることを保証する。このタイプはアクセスの激しいサイトに適して おり、負荷に関わりなくmax_server個のプロセスを実行できる。 これはほとんどのアプリケーション用に適しているといえる。複数のポートを 受け付けるために、flock、IPC::Semaphore、ないしはパイプのいずれかを利用 して子プロセスを直列化する。複数の子プロセスが同時にacceptするのを許可 しないOSに対処するため、直列化を単一ポート用に切り替えるかもしれない。 今後の直列化についての議論についてははNet::Server::PreForkを見よ。

PreFork

Found in the module Net/Server/PreFork.pm (see Net::Server::PreFork). This server binds to one or more ports and then forks min_servers child process. The server will make sure that at any given time there are at least min_spare_servers but not more than max_spare_servers available to receive a client request, up to max_servers. Each of these children will process up to max_requests client connections. This type is good for a heavily hit site, and should scale well for most applications. Multi port accept is accomplished using either flock, IPC::Semaphore, or pipe to serialize the children. Serialization may also be switched on for single port in order to get around an OS that does not allow multiple children to accept at the same time. For a further discussion of serialization see Net::Server::PreFork.

Net/Server/PreFork.pmに基づく（Net::Server::PreForkを参照）。 このサーバは一つ以上のポートにbindし、min_servers個の子プロセスを forkする。サーバは常に、少なくともmin_spare_servers個以上、 max_spare_servers以下のクライアントリクエストを受け付け、 最大max_serversまで受付られることを保証する。 これらの子プロセスは皆、max_requests個までのクライアントコネクションを 処理する。このタイプはアクセスの激しいサイトに適しており、ほとんどの アプリケーションにとってちょうど良いものとなる。複数のポートを 受け付けるために、flock、IPC::Semaphore、ないしはパイプのいずれかを利用 して子プロセスを直列化する。複数の子プロセスが同時にacceptするのを許可 しないOSに対処するため、直列化を単一ポート用に切り替えるかもしれない。 今後の直列化についての議論についてははNet::Server::PreForkを見よ。

Single

All methods fall back to Net::Server. This personality is provided only as parallelism for Net::Server::MultiType.

全てのメソッドはNet::Serverに還元される。このパーソナリティは Net::Server::MultiTypeに対応したものとしてのみ提供される。

Net::Serverは部分的ではるが、新たなパーソナリティを追加しやすい ように書かれている。オープンなアーキテクチャを基に構築された独立の モジュールを使うことによって、新しい機能、別個に開発されたプロセス、 そしてコアモジュールから膨れ出したために縮めることになったコードを 容易に追加できる。

ソケットアクセス¶

ひとたび開始されると、Net::Serverはポートのbindとコネクションのための 待機に取り掛かる。コネクションを受け取るとNet::Serverはソケットを受け入れ、 その結果（クライアントコネクション）を$self->{server}->{client}に 保持する。このプロパティはIO::SocketクラスにblessされたSocketである。 UDPサーバは少し違っていて、acceptの代わりにrecvで処理を行なう。

より簡単にプログラミングするために、post_accept段階の間は、 STDINとSTDOUTをクライアントコネクションに開く。これによりプログラムは<STDIN>を使って書き込まれ、print "out\n"で クライアントコネクションに書き込むことができる。 UDPは->sendの呼び出しが必要となる。

サンプルコード¶

以下は非常にシンプルなサーバ例である。中心となる機能は下記に示した process_requestメソッドの呼び出し部分である。 読み取り中のサービス拒否攻撃を防ぐためにタイムアウトを利用している 点に注目（Net::Serverで使用しているほかの例はこの ディストリビューションを含んでいる可能性がある、ないしはそうしている）。

  #!/usr/bin/perl -w -T
  #--------------- file test.pl ---------------

  package MyPackage;

  use strict;
  use vars qw(@ISA);
  use Net::Server::PreFork; # どのパーソナリティでも行う

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

  MyPackage->run();
  exit;

  ### 下のサブルーチンをオーバーライドする

  sub process_request {
    my $self = shift;
    eval {

      local $SIG{ALRM} = sub { die "Timed Out!\n" };
      my $timeout = 30; # 行入力に30秒の時間を与える

      my $previous_alarm = alarm($timeout);
      while( <STDIN> ){
        s/\r?\n$//;
        print "You said \"$_\"\r\n";
        alarm($timeout);
      }
      alarm($previous_alarm);

    };

    if( $@=~/timed out/i ){
      print STDOUT "Timed Out.\r\n";
      return;
    }

  }

  1;

  #--------------- file test.pl ---------------

コマンドラインからこのファイルを試してみるとPreForkパーソナリティを 使ったNet::Serverが起動する。Net::Serverの上層にサーバを構築する際、 DOS攻撃を防ぐためにこのようなタイムアウト機能を利用することが大切である。

引数¶

Net::Serverに引数を渡すには、四通りの方法がある。 コマンドラインから渡す、設定ファイルを使う、 runメソッドに渡す、runメソッドを呼び出すために 予め作成したオブジェクトを利用する がそれだ。

引数はキーと値のペアで構成される。コマンドライン上では、これらの ペアはPOSIX流の--key valueで行なうか、あるいはkey=valueでもよい。 設定ファイルを利用する場合、パラメータの引渡しは、次のような 正規表現でうまく表される：($key,$val)=~/^(\w+)\s+(\S+?)\s+$/ 。 runメソッドへ引数を渡すには次のようにする： Net::Server->run(key1 => 'val1') 。予め作成しておいたオブジェクトを 通じて引数を渡す方法は次のコードでうまく表される。

  #!/usr/bin/perl -w -T
  #--------------- file test2.pl ---------------
  package MyPackage;
  use strict;
  use vars (@ISA);
  use Net::Server;
  @ISA = qw(Net::Server);

  my $server = bless {
    key1 => 'val1',
    }, 'MyPackage';

  $server->run();
  #--------------- file test.pl ---------------

引数を渡す五通りの方法は全て同時に利用することが出来る。 ひとたび引数をセットすると、他の方法で同じ引数を渡しても 上書きされない。Net::Serverは以下の順番で引数を見ていく。

  1) Arguments contained in the prebuilt object.
  2) Arguments passed on command line.
  3) Arguments passed to the run method.
  4) Arguments passed via a conf file.
  5) Arguments set in the configure_hook.

  1) 予め作成されたオブジェクトに含まれる引数
  2) コマンドラインで渡された引数
  3) runメソッドに渡された引数
  4) 設定ファイルを通じて渡された引数
  5) configure_hookにセットされた引数

サーバによって利用されるKey/valueのペアは設定処理によって 取り除かれる。その結果Net::Server上に構築されたサーバは 引数を渡し、サーバ自身のパラメータを読み込むことができる。 今のところGetopt::Longは利用できない。次の引数はデフォルトの Net::Server、あるいはNet::Server::Singleモジュールで 利用可能なものだ（他のパーソナリティは追加のパラメータを 利用するかもしれないし、ベースクラスのパラメータをオプション としては利用しないかもしれない）。

  Key               Value                    Default
  conf_file         "filename"               undef

  log_level         0-4                      2
  log_file          (filename|Sys::Syslog)   undef

  ## syslogパラメータ
  syslog_logsock    (unix|inet)              unix
  syslog_ident      "identity"               "net_server"
  syslog_logopt     (cons|ndelay|nowait|pid) pid
  syslog_facility   \w+                      daemon

  port              \d+                      20203
  host              "host"                   "*"
  proto             (tcp|udp|unix)           "tcp"
  listen            \d+                      SOMAXCONN

  reverse_lookups   1                        undef
  allow             /regex/                  none
  deny              /regex/                  none

  ## デーモン関連のパラメータ
  pid_file          "filename"               undef
  chroot            "directory"              undef
  user              (uid|username)           "nobody"
  group             (gid|group)              "nobody"
  background        1                        undef
  setsid            1                        undef

  no_close_by_child (1|undef)                undef

  ## Net::Server::Proto::(TCP|UDP|UNIX|etc)を参照
  ## もっと多くのパラメータ例がある

conf_file

Filename from which to read additional key value pair arguments for starting the server. Default is undef.

サーバをスタートさせる際に、追加されたkey/valueの引数を このファイル名から読み取る。デフォルトはundef。

log_level

Ranges from 0 to 4 in level. Specifies what level of error will be logged. "O" means logging is off. "4" means very verbose. These levels should be able to correlate to syslog levels. Default is 2. These levels correlate to syslog levels as defined by the following key/value pairs: 0=>'err', 1=>'warning', 2=>'notice', 3=>'info', 4=>'debug'.

レベルは0から4までの範囲。どのレベルのエラーをログに記録するか 指定する。0は記録しないことを意味する。4は非常にやかましいぐらいに 記録する。このレベルはsyslogレベルに対応する。デフォルトは2。 以下のkey/valueによって定義されるsyslogレベルとも対応する： 0=>'err',1=>'warning', 2=>'notice', 3=>'info', 4=>'debug'

log_file

Name of log file to be written to. If no name is given and hook is not overridden, log goes to STDERR. Default is undef. If the magic name "Sys::Syslog" is used, all logging will take place via the Sys::Syslog module. If syslog is used the parameters syslog_logsock, syslog_ident, and syslog_logopt,and syslog_facility may also be defined. If a log_file is given or if setsid is set, STDIN and STDOUT will automatically be opened to /dev/null and STDERR will be opened to STDOUT. This will prevent any output from ending up at the terminal.

ログを書き込むファイル名。名前を与えず、かつhookがオーバーライド されていない場合、ログはSTDERRに出力される。デフォルトはundef。 "Sys::Syslog"という名前を使うとログの記録は全てSys::Syslog モジュールを通じて行なわれる。もしsyslogが使われるなら、 syslog_logsock, syslog_ident, syslog_logoptそして syslog_facilityも定義されるだろう。 log_fileが与えられるかsetsidがセットされると、 STDINとSTDOUTは自動的に/dev/nullに、そしてSTDERRはSTDOUTに 開かれる。これにより端末が終了した時に出力を抑制することができる。

pid_file

Filename to store pid of parent process. Generally applies only to forking servers. Default is none (undef).

親プロセスのpidを保持するファイルの名前。一般的にフォークサーバ にのみ適用される。デフォルトは何もなし（undef）。

syslog_logsock

Only available if log_file is equal to "Sys::Syslog". May be either "unix" of "inet". Default is "unix". See Sys::Syslog.

log_fileが"Sys::Syslog"となっているときにのみ利用できる。 "unix"か"inet"のどちらかをとる。デフォルトは"unix"。 Sys::Syslogを参照のこと。

syslog_ident

Only available if log_file is equal to "Sys::Syslog". Id to prepend on syslog entries. Default is "net_server". See Sys::Syslog.

log_fileが"Sys::Syslog"となっているときにのみ利用できる。 syslogエントリーにprependするID。[訳者：?] デフォルトは"net_server"。Sys::Syslogを参照のこと。

syslog_logopt

Only available if log_file is equal to "Sys::Syslog". May be either zero or more of "pid","cons","ndelay","nowait". Default is "pid". See Sys::Syslog.

log_fileが"Sys::Syslog"となっているときにのみ利用できる。 何も設定しないか、"pid"、"cons"、"ndelay"、"nowait"のどれかを 使う。デフォルトは"pid"。Sys::Syslgoを参照のこと。

syslog_facility

Only available if log_file is equal to "Sys::Syslog". See Sys::Syslog and syslog. Default is "daemon".

log_fileが"Sys::Syslog"となっているときにのみ利用できる。 See Sys::Syslogとsyslogを参照せよ。デフォルトは"daemon"。

port

See Net::Server::Proto. Local port/socket on which to bind. If low port, process must start as root. If multiple ports are given, all will be bound at server startup. May be of the form host:port/proto, host:port, port/proto, or port, where host represents a hostname residing on the local box, where port represents either the number of the port (eg. "80") or the service designation (eg. "http"), and where proto represents the protocol to be used. See Net::Server::Proto. If you are working with unix sockets, you may also specify socket_file|unix or socket_file|type|unix where type is SOCK_DGRAM or SOCK_STREAM. If the protocol is not specified, proto will default to the proto specified in the arguments. If proto is not specified there it will default to "tcp". If host is not specified, host will default to host specified in the arguments. If host is not specified there it will default to "*". Default port is 20203.

Net::Server::Protoを参照。 bindするローカルport/socket。低い番号のportを使うには プロセスをrootで開始しなければならない。複数のポートが与えられた 場合、サーバ起動時に全てがbindされる。可能な書式は host:port/proto,host:port,port/proto,あるいはport。 hostはそのコンピュータに属するホスト名。portはポート番号 （例："80"）かサービス名（例："http"）。そしてprotoは使用する プロトコルだ。Net::Server::Protoを見て欲しい。 もしもUNIX socketを使うなら、さらにsocket_file|unixか socket_file|type|unixを指定することになるだろう。typeとは SOCK_DGRAMかSOCK_STREAMのことだ。プロトコルが指定されない場合、 デフォルトは引数で指定したprotoになる。 もしそこでprotoが設定されていなければ、デフォルトは"tcp"になる。 hostが指定されていない場合、デフォルトは引数で指定されたhostに なる。そこでhostが指定されていなければ"*"になる。 ポートのデフォルトは20203だ。

host

Local host or addr upon which to bind port. If a value of '*' is given, the server will bind that port on all available addresses on the box. See Net::Server::Proto. See IO::Socket.

bindするローカルホスト、あるいはアドレス。価に"*"が与えられると、 サーバはコンピュータ上の利用可能なポート全てにbind使用とする。 Net::Server::Proto、IO::Socketを参照。

proto

See Net::Server::Proto. Protocol to use when binding ports. See IO::Socket. As of release 0.70, Net::Server supports tcp, udp, and unix. Other types will need to be added later (or custom modules extending the Net::Server::Proto class may be used).

Net::Server::Protoを参照。 ポートをbindするときに使うプロトコル。IO::Socketを見よ。 バージョン0.70でNet::Serverはtcp、udp、それにunixをサポートしている。 その他のタイプは今後追加していく必要があるかもしれない（あるいは Net::Server::Protoクラスを拡張した独自モジュールを利用する）。

listen

  See L<IO::Socket>.  Not used with udp protocol (or UNIX SOCK_DGRAM).

  L<IO::Socket>を参照。udpプロトコル（またはUNIX SOCK_DGRAM）では使用しない。

reverse_lookups

Specify whether to lookup the hostname of the connected IP. Information is cached in server object under peerhost property. Default is to not use reverse_lookups (undef).

接続してきたIPのホスト名をlookupするかどうか指定する。 情報はサーバオブジェクトのpeerhostプロパティにキャッシュされる。 デフォルトはundef（reverse_lookupsを使用しない）。

allow/deny

May be specified multiple times. Contains regex to compare to incoming peeraddr or peerhost (if reverse_lookups has been enabled). If allow or deny options are given, the incoming client must match an allow and not match a deny or the client connection will be closed. Defaults to empty array refs.

複数回指定できる。やってくるpeeraddrや（reverse_lookupsを有効に しているなら）peerhostと比較する正規表現を含む。もしallowかdeny オプションが与えられた場合、接続してきたクライアントはallowに マッチするかdenyにマッチしないかしなければならない。さもなければ クライアントコネクションは閉じられる。デフォルトは空配列への リファレンス。

chroot

Directory to chroot to after bind process has taken place and the server is still running as root. Defaults to undef.

bindプロセス発生後にchrootさせるディレクトリ。 サーバは依然rootで実行し続ける。デフォルトはundef。

user

Userid or username to become after the bind process has occured. Defaults to "nobody." If you would like the server to run as root, you will have to specify user equal to "root".

bindプロセス発生後に設定されるuseridあるいはusername。 デフォルトは"nobody"。もしサーバをrootで実行したいのなら userを"root"に指定しなければならない。

group

Groupid or groupname to become after the bind process has occured. Defaults to "nobody." If you would like the server to run as root, you will have to specify group equal to "root".

bindプロセス発生後に設定されるgroupidあるいはgroupname。 デフォルトは"nobody"。もしサーバをrootで実行したいのなら groupを"root"に指定しなければならない。

background

Specifies whether or not the server should fork after the bind method to release itself from the command line. Defaults to undef. Process will also background if setsid is set.

bindメソッドがコマンドラインから自らを解放した後、サーバが forkするかどうかを設定する。デフォルトはundef。setsidが セットされていればプロセスはバックグラウンドで走る。

setsid

Specifies whether or not the server should fork after the bind method to release itself from the command line and then run the POSIX::setsid() command to truly daemonize. Defaults to undef. If a log_file is given or if setsid is set, STDIN and STDOUT will automatically be opened to /dev/null and STDERR will be opened to STDOUT. This will prevent any output from ending up at the terminal.

bindメソッドがコマンドラインから自らを解放した後、サーバが forkするかどうかを設定する。その後サーバはPOSIX::setsid() を実行し、真のデーモンになる。デフォルトはundef。log_file が与えられているかsetsidがセットされていれば、STDINと STDOUTは自動的に/dev/nullに開かれる。そしてSTDERRはSTDOUTに 開かれる。これは端末機が終了した時の出力を抑制する。

no_close_by_child

Specifies whether or not a forked child process has permission or not to shutdown the entire server process. If set to 1, the child may NOT signal the parent to shutdown all children. Default is undef (not set).

forkされた子プロセスがサーバプロセスを完全にシャットダウンする 権限を持つかどうかを指定する。もし1をセットすれば子プロセスは親 プロセスが全ての子プロセスをシャットダウンさせるシグナルを送らない。 デフォルトはundef（セットされない）。

プロパティ¶

先に挙げた全ての引数は同じ名前でサーバオブジェクトの プロパティとなる。他の内部プロパティと同様、このプロパティは hookや他のメソッド呼び出しで使うことができる。

Net::Serverオブジェクトの構造を以下に示すと：

  $self = bless( {
                   'server' => {
                                 'key1' => 'val1',
                                 # more key/vals
                               }
                 }, 'Net::Server' );

この構造を選んだおかげで、サーバに関連する全てのプロパティは そのオブジェクトのハッシュリファレンスの単一キーに基づいて グループ化される。つまり他のオブジェクトがNet::Serverクラスの 上に重なることができる。そして依然ハッシュリファレンスの 名前空間はクリーンに保たれる。

二つの方法でプロパティを取得および設定できる。まず提示するのは 次のようにして直接プロパティにアクセスするやり方：

 my $val = $self->{server}->{key1};

直接プロパティにアクセスすればサーバの処理を速めることが できるだろう。二番目の方法はメソッドを信頼する オブジェクト指向なタイプだ。二番目の方法は次のようなメソッドで 行う：

  my $val = $self->get_property( 'key1' );
  my $self->set_property( key1 => 'val1' );

プロパティはいつでも変更できるが注意しなければならない （sockプロパティをundefしてはいけない。さもないとクライアント コネクションが閉じられてしまう）。

設定ファイル¶

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

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

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

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

  ### syslogディレクティブのオプション
  ### 上のlog_fileの代わりに使う場合
  #log_file       Sys::Syslog
  #syslog_logsock unix
  #syslog_ident   myserver
  #syslog_logopt  pid|cons

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

  ### プロセスをバックグランドで走らせるか？
  background  1

  ### bindするポート（こので例は
  ### 127.0.0.1:20205とlocalhost:20204にbindする)
  ### Net::Server::Protoを参照
  host        127.0.0.1
  port        localhost:20204
  port        20205

  ### 逆引き？
  # reverse_lookups on

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

処理の流れ¶

処理の流れはオープンで、オーバーライドしやすく hookしやすいような流儀で書かれている。基本的な流れは 以下で示す通り。

  $self->configure_hook;

  $self->configure(@_);

  $self->post_configure;

  $self->post_configure_hook;

  $self->pre_bind;

  $self->bind;

  $self->post_bind_hook;

  $self->post_bind;

  $self->pre_loop_hook;

  $self->loop;

  ### 標準的な$self->loop内部のルーチン
  # $self->accept;
  # $self->run_client_connection;
  # $self->done;

  $self->pre_server_close_hook;

  $self->server_close;

そしてサーバは終了する。

クライアント処理段階（$self->run_client_connection）では、 次のようなプログラムの流れになる：

  $self->post_accept;

  $self->get_client_info;

  $self->post_accept_hook;

  if( $self->allow_deny

      && $self->allow_deny_hook ){

    $self->process_request;

  }else{

    $self->request_denied_hook;

  }

  $self->post_process_request_hook;

  $self->post_process_request;

その後プロセスはループし、次の接続を待つ。さらに つっこんだ議論を望む向きは、ソースコードをご覧下あれ。

サーバがシャットダウンする段階（$self->server_close）では、 次のようなプログラムの流れになる：

  $self->close_children;  # もし子プロセスがあれば

  $self->post_child_cleanup_hook;

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

  exit;

HOOKS¶

Net::Serverは数多くの"hook"を提供する。これにより Net::Serverの上に形成されたサーバが様々な実行段階で応答する ことができる。

$self->configure_hook()

This hook takes place immediately after the ->run() method is called. This hook allows for setting up the object before any built in configuration takes place. This allows for custom configurability.

このhookは->run()メソッドが呼び出されるや直ちに発生する。 これにより設定処理によって何かがビルトされる前にオブジェクトを セットアップすることができる。これを利用して設定処理をカスタマイズできる。

$self->post_configure_hook()

This hook occurs just after the reading of configuration parameters and initiation of logging and pid_file creation. It also occurs before the ->pre_bind() and ->bind() methods are called. This hook allows for verifying configuration parameters.

このhookは設定用パラメータの読み込みと、初期化作業である ログ処理及びpid_file作成の直後に発生する。これはまた、 ->pre_bind()と->pre_bind()メソッド呼び出しの 前にも発生する。このhookを使えば設定用パラメータのチェックを 行うことができる。

$self->post_bind_hook()

This hook occurs just after the bind process and just before any chrooting, change of user, or change of group occurs. At this point the process will still be running as the user who started the server.

このhookはbindプロセスの直後、かつchroot、user変更、group変更 の直前に発生する。この時点では、まだプロセスはサーバを起動した userで実行されている。

$self->pre_loop_hook()

This hook occurs after chroot, change of user, and change of group has occured. It allows for preparation before looping begins.

このhookはchroot、user変更、group変更の後に発生する。 ループが始まる前の準備に利用できる。

$self->post_accept_hook()

This hook occurs after a client has connected to the server. At this point STDIN and STDOUT are mapped to the client socket. This hook occurs before the processing of the request.

このhookはクライアントがサーバに接続した後に発生する。 この時点でSTDINとSTDOUTはクライアントのソケットに マッピングされる。このhookはリクエスト処理の前に発生する。

$self->allow_deny_hook()

This hook allows for the checking of ip and host information beyond the $self->allow_deny() routine. If this hook returns 1, the client request will be processed, otherwise, the request will be denied processing.

このhookは$self->allow_deny()ルーチンを越えて ipとhost情報のチェックをすることができる。もしこのhookが 1を返せば、クライアントのリクエストは処理され、そうでなければ リクエストは拒否時の処理に入る。

$self->request_denied_hook()

This hook occurs if either the $self->allow_deny() or $self->allow_deny_hook() have taken place.

このhookは、$self->allow_deny()か $self->allow_deny_hook()が生じたときに発生する。 [訳注：どちらかが偽を返したときに発生する]

$self->post_process_request_hook()

This hook occurs after the processing of the request, but before the client connection has been closed.

このhookはリクエスト処理の後、ただしクライアント コネクションが閉じられてしまう前に発生する。

$self->pre_server_close_hook()

This hook occurs before the server begins shutting down.

このhookはサーバがシャットダウンに入る前に発生する。

$self->write_to_log_hook

This hook handles writing to log files. The default hook is to write to STDERR, or to the filename contained in the parameter log_file. The arguments passed are a log level of 0 to 4 (4 being very verbose), and a log line. If log_file is equal to "Sys::Syslog", then logging will go to Sys::Syslog and will bypass the write_to_log_hook.

このhookはログファイルへの書き込みを制御する。デフォルトの hookはSTDERRかlog_fileパラメータにあるファイル名に書き込む。 渡される引数は0から4までのログレベルと、一行のログである。 もしlog_fileが"Sys::Syslog"なら、ログ処理はSys::Syslogに移行し、 write_to_log_hookは無視される。

$self->fatal_hook

This hook occurs when the server has encountered an unrecoverable error. Arguments passed are the error message, the package, file, and line number. The hook may close the server, but it is suggested that it simply return and use the built in shut down features.

このhookはサーバが回復不能なエラーに遭遇した際に発生する。 渡される引数はエラーメッセージ、パッケージ名、ファイル名、 そして行数である。このhookはサーバを閉じるかもしれないが、 単にreturnし、組み込みのシャットダウン機能を利用するように 指示することができる。

$self->post_child_cleanup_hook

This hook occurs in the parent server process after all children have been shut down and just before the server either restarts or exits. It is intended for additional cleanup of information. At this point pid_files and lockfiles still exist.

このhookは全ての子プロセスがシャットダウンされた後、かつ、 サーバが再起動ないしは終了する直前に、親サーバのプロセスで 発生する。追加的なクリーンアップ情報を意味する。この時点では まだpid_fileとlcokfileが存在する。

$self->restart_open_hook

This hook occurs if a server has been HUPed (restarted via the HUP signal. It occurs just before reopening to the filenos of the sockets that were already opened.

このhookは、サーバがHUPされる（HUPシグナルを通じて再起動 すること）際に発生する。これは既に開かれていたソケットの ファイル記述子（fileno）を再び開く直前に発生する。

$self->restart_close_hook

This hook occurs if a server has been HUPed (restarted via the HUP signal. It occurs just before restarting the server via exec.

このhookは、サーバがHUPされる（HUPシグナルを通じて再起動 すること）際に発生する。これはexecでもってサーバが再起動 される直前に発生する。

再起動¶

サーバパーソナリティは（INETタイプを除いて）全てHUPシグナル （"kell -l" 参照）を通じて再起動をサポートしている。 HUPを受け取ると、サーバは（もしいれば）子プロセスを閉じ、 ソケットが開いたままであることを確認し、最初にサーバを起動 したときと同じコマンドラインパラメータを利用して再びexecする。 （注意：この理由から、->runが呼び出されるまで@ARGVを 変更しないことが重要である。）

TO DO¶

このソフトウェアがアルファ版でなくなる前に行なうべき仕事がいくつかある。

Use It

The best way to further the status of this project is to use it. There are immediate plans to use this as a base class in implementing some mail servers and banner servers on a high hit site.

この計画の状況を進めるもっともよい方法は、それ（it）を使う ことだ。これをアクセス数の多いサイト用のメールサーバと バナーサーバを実装するベースクラスとして利用する急ぎの計画がある。

Other Personalities

Explore any other personalities

他のパーソナリティの探求。

Net::Server::HTTP, etc

Create various types of servers. Possibly, port exising servers to user Net::Server as a base layer.

様々なタイプのサーバをつくる。もしかしたら、既存のサーバを ベース層としてユーザーのNet::Serverにポートするかも。

[訳注：このTODOは全般的に意味がわかりませんでした]

ファイル¶

  The following files are installed as part of this
  distribution.

  このパッケージの一部として次のファイルがインストールされる。

  Net/Server.pm
  Net/Server/Fork.pm
  Net/Server/INET.pm
  Net/Server/MultiType.pm
  Net/Server/PreForkSimple.pm
  Net/Server/PreFork.pm
  Net/Server/Single.pm
  Net/Server/Daemonize.pm
  Net/Server/SIG.pm
  Net/Server/Proto.pm
  Net/Server/Proto/*.pm

インストール¶

事前にtarballをダウンロードし、展開しておく。そして 以下のコマンドをベースとなるディレクトリで実行する：

  perl Makefile.PL
  make
  make test
  make install

RPMによるインストールなら、tarballをダウンロード してから、あなたの_topdirで以下のコマンドを実行：

  rpm -ta SOURCES/Net-Server-*.tar.gz
  rpm -ih RPMS/noarch/perl-Net-Server-*.rpm

作者¶

Paul T. Seamons <paul at seamons.com>

謝辞¶

Rob Brown <rbrown at about-inc.com>には、 Apache風のflockを使った直列化selectの追跡や、 マルチポートサーバを可能にするIO::Selectのリファレンス など種々色々な概念に関して助けてもらった。 そしてまた、execを使ってソケットを開いたままにしておく 方法（HUPを可能にする）の調査でも助けられた。

J. Miner <[email protected]>のおかげで、逆引きにおける 騒々しい問題の修正ができた。

Bennett Todd <bet at rahul.net>は Solaris 2.5.1では、一度に同じポートに対し複数の子プロセスが acceptできないという問題を指摘してくれた。また、 Viktor Duchovniはいくつかのサンプルコードを提示してくれた。 それは今、PreForkサーバの直列化でsemaphoreオプションとして 実現している。

http://perlmonks.orgのtravelerとmerlynは ソケット接続で利用するプロトコルを決定する際に正しい方向へと 私を導いてくれた。

Jeremy Howard <j+daemonize at howard.fm>には、多くの提案と Net::Server::Daemonizeの取り組みで助けられた。

Vadim <vadim at hardison.net>のおかげで、PreFork.pmでの 親子プロセス間通信の実装に対する修正ができた。

参考¶

以下も参照されたし。

Net::Server::Fork, Net::Server::INET, Net::Server::PreForkSimple, Net::Server::PreFork, Net::Server::MultiType, Net::Server::Single

著作権¶

  Copyright (C) 2001, Paul T Seamons
                      paul at seamons.com
                      http://seamons.com/

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

  All rights reserved.