名前¶

HTTP::Daemon - 簡単な http サーバクラス

概要¶

  use HTTP::Daemon;
  use HTTP::Status;

  my $d = HTTP::Daemon->new || die;
  print "Please contact me at: <URL:", $d->url, ">\n";
  while (my $c = $d->accept) {
      while (my $r = $c->get_request) {
          if ($r->method eq 'GET' and $r->url->path eq "/xyzzy") {
              # remember, this is *not* recommended practice :-)
              $c->send_file_response("/etc/passwd");
          }
          else {
              $c->send_error(RC_FORBIDDEN)
          }
      }
      $c->close;
      undef($c);
  }

説明¶

HTTP::Daemon のインスタンスは、リクエストがやってくるソケットを listen する HTTP/1.1 サーバです。 HTTP::Daemon は IO::Socket::INET クラスのサブクラスなので、 そのため直接ソケット操作を行うことも出来ます。

accept() メソッドはクライアントからの接続が利用可能になると返ります。 返された値は HTTP::Daemon::ClientConn クラスのオブジェクトで、 それはもう一つの IO::Socket::INET のサブクラスです。 このオブジェクトに get_request() メソッドを呼ぶと、クライアントから データを読み込み、HTTP::Request オブジェクトを返します。 様々なレスポンスを送り返すために ClientConn オブジェクトも提供されます。

この HTTP デーモンはあなたの代わりに fork(2) をしません。 あなたのアプリケーション、つまり HTTP::Daemon のユーザは、必要なら フォークすることに責任を持たなければなりません。 またユーザは HTTP/1.1 プロトコルに従ったレスポンスを作成することに責任を 持たなければなりません。

以下 の HTTP::Daemon メソッドは IO::Socket::INET 基底クラスとの 比較で、新しい (もしくは拡張された) ものです:

$d = HTTP::Daemon->new

$d = HTTP::Daemon->new( %opts )

The constructor method takes the same arguments as the IO::Socket::INET constructor, but unlike its base class it can also be called without any arguments. The daemon will then set up a listen queue of 5 connections and allocate some random port number.

コンストラクタメソッドは IO::Socket::INET コンストラクタと同じ 引数を取りますが、基底クラスとは違って、 何も引数を指定せずに呼び出すことも出来ます。 デーモンは五つの接続の listen キューを設定し、いくつかのランダムな ポート番号を占有します。

A server that wants to bind to some specific address on the standard HTTP port will be constructed like this:

ある特定のアドレスの標準の HTTP ポートでバインドしたいサーバは 以下のように組み立てます:

  $d = HTTP::Daemon->new(
           LocalAddr => 'www.thisplace.com',
           LocalPort => 80,
       );

See IO::Socket::INET for a description of other arguments that can be used configure the daemon during construction.

コンストラクタでデーモンを設定するために使われるその他の引数の 説明については IO::Socket::INET を参照してください。

$c = $d->accept

$c = $d->accept( $pkg )

($c, $peer_addr) = $d->accept

This method works the same the one provided by the base class, but it returns an HTTP::Daemon::ClientConn reference by default. If a package name is provided as argument, then the returned object will be blessed into the given class. It is probably a good idea to make that class a subclass of HTTP::Daemon::ClientConn.

このメソッドは基底クラスと同様ですが、デフォルトでは HTTP::Daemon::ClientConn リファレンスを返します。 引数としてパッケージ名が渡されると、返されるオブジェクトは与えられた クラスで bless されます。 このクラスを HTTP::Daemon::ClientConn のサブクラスにするのは おそらく良い考えでしょう。

The accept method will return undef if timeouts have been enabled and no connection is made within the given time. The timeout() method is described in IO::Socket.

accept メソッドは、タイムアウトが有効で、与えられた時間内に接続が ない場合は undef が返されます。 timeout() メソッドは IO::Socket に記述されています。

In list context both the client object and the peer address will be returned; see the description of the accept method IO::Socket for details.

リストコンテキストでは、クライアントオブジェクトと接続先アドレスの 両方が返されます; 詳しくは IO::Socket の accept メソッドの 説明を参照してください。

$d->url

Returns a URL string that can be used to access the server root.

サーバルートにアクセスするために使われる URL 文字列を返します。

$d->product_tokens

Returns the name that this server will use to identify itself. This is the string that is sent with the Server response header. The main reason to have this method is that subclasses can override it if they want to use another product name.

このサーバがそれ自身を識別するために使う名前を返します。 これは Server レスポンスヘッダで送信される文字列です。 このメソッドを持っている主な理由は、他のプロダクト名を使いたいとき サブクラスがオーバーライドすることができるからです。

The default is the string "libwww-perl-daemon/#.##" where "#.##" is replaced with the version number of this module.

デフォルトは "libwww-perl-daemon/#.##" という文字列です; "#.##" は このモジュールのバージョン番号で置き換えられます。

HTTP::Daemon::ClientConn は IO::Socket::INET のサブクラスです。 このクラスのインスタンスは HTTP::Daemon の accept() メソッドにより 返されます。 以下のメソッドが提供されます:

$c->get_request

$c->get_request( $headers_only )

This method read data from the client and turns it into an HTTP::Request object which is returned. It returns undef if reading fails. If it fails, then the HTTP::Daemon::ClientConn object ($c) should be discarded, and you should not try call this method again on it. The $c->reason method might give you some information about why $c->get_request failed.

このメソッドはクライアントからデータを読み込み、返される HTTP::Request オブジェクトに変換します。 読み込みに失敗すれば、undef を返します。 もし失敗すれば、HTTP::Daemon::ClientConn オブジェクト ($c) は 捨てられます。 そしてこのメソッドを再び呼びだそうとしてはいけません。 $c->reason メソッドは、なぜ $c->get_request が失敗したかについての情報を 与えてくれるかもしれません。

The get_request() method will normally not return until the whole request has been received from the client. This might not be what you want if the request is an upload of a large file (and with chunked transfer encoding HTTP can even support infinite request messages - uploading live audio for instance). If you pass a TRUE value as the $headers_only argument, then get_request() will return immediately after parsing the request headers and you are responsible for reading the rest of the request content. If you are going to call $c->get_request again on the same connection you better read the correct number of bytes.

get_request() メソッドは通常はすべてのリクエストがクライアントから 受信できるまで戻りません。 もしリクエストが大きいファイルをアップロードする (そしてチャンクされた 転送エンコーディングで HTTP が無限のリクエストメッセージをサポートすること - 例えばライブな音声のアップロード - が出来たとしても) のであれば、 これは望ましいことではないかもしれません。 $headers_only 引数として TRUE を渡すと、get_request() は、 リクエストヘッダを解析するとすぐに戻ります。 そしてリクエスト内容の残りを読むかどうかの責任はあなたにあります。 もし同じ接続に $c->get_request を再び呼び出せば、正しいバイト数を 読み込みます。

$c->read_buffer

$c->read_buffer( $new_value )

Bytes read by $c->get_request, but not used are placed in the read buffer. The next time $c->get_request is called it will consume the bytes in this buffer before reading more data from the network connection itself. The read buffer is invalid after $c->get_request has failed.

$c->get_request により読み込まれたけれども read buffer に置かれたバイト列。 次に $c->get_request が呼ばれると、ネットワーク接続自身からより多くのデータを 読み込む前に、このバッファの中のバイト列を消費するでしょう。 $c->get_requestが失敗した後は、読み込みバッファは不正です。

If you handle the reading of the request content yourself you need to empty this buffer before you read more and you need to place unconsumed bytes here. You also need this buffer if you implement services like 101 Switching Protocols.

あなた自身でリクエストのコンテンツの読み込みを扱うならば、さらに読み込む 前にはこのバッファを空にする必要があります。 そして消費されないバイトをここに置く必要があります。 101 Switching Protocols のようなサービスを実装するのであっても、この バッファが必要です。

This method always return the old buffer content and can optionally replace the buffer content if you pass it an argument.

このメソッドは常に古いバッファの内容を返します。 引数を渡せば、オプションでバッファを置きかえることも出来ます。

$c->reason

When $c->get_request returns undef you can obtain a short string describing why it happened by calling $c->reason.

$c->get_request が undef を返すとき、$c->reason を呼び出すことにより、 なぜそうなったかを説明する短い文字列を取得できます。

$c->proto_ge( $proto )

Return TRUE if the client announced a protocol with version number greater or equal to the given argument. The $proto argument can be a string like "HTTP/1.1" or just "1.1".

クライアントがプロトコルのバージョン番号が与えられた引数よりも大きいか 同じだといっている場合、TRUE を返します。 $proto 引数は "HTTP/1.1" や単に "1.1" のような文字列にすることが出来ます。

$c->antique_client

Return TRUE if the client speaks the HTTP/0.9 protocol. No status code and no headers should be returned to such a client. This should be the same as !$c->proto_ge("HTTP/1.0").

クライアントが HTTP/0.9 プロトコルを話していれば TRUE を返します。 そのようなクライアントにはステータスコードやヘッダを返しません。 これは !$c->proto_ge("HTTP/1.0") と同じです。

$c->head_request

Return TRUE if the last request was a HEAD request. No content body must be generated for these requests.

最後のリクエストが HEAD だった場合は TRUE を返します。 これらのリクエストではコンテントボディは生成できません。

$c->force_last_request

Make sure that $c->get_request will not try to read more requests off this connection. If you generate a response that is not self delimiting, then you should signal this fact by calling this method.

$c->get_request がこの接続にさらにリクエストをしないことを保証します。 自分自身が分割しないレスポンスをつくると、このメソッドを 呼び出すことにより、このことを知らせなければいけません。

This attribute is turned on automatically if the client announces protocol HTTP/1.0 or worse and does not include a "Connection: Keep-Alive" header. It is also turned on automatically when HTTP/1.1 or better clients send the "Connection: close" request header.

属性はクライアントプロトコルが HTTP/1.0 またはそれより悪く、 "Connection;", "Keep-Alive" ヘッダを含まないといっていれば、 この属性は自動的にオンに切り替わります。 また HTTP/1.1 またはそれよりもよいクライアントが "Connection:close" リクエストヘッダを送信するときにも自動的にオンに 切り替わります。

$c->send_status_line

$c->send_status_line( $code )

$c->send_status_line( $code, $mess )

$c->send_status_line( $code, $mess, $proto )

Send the status line back to the client. If $code is omitted 200 is assumed. If $mess is omitted, then a message corresponding to $code is inserted. If $proto is missing the content of the $HTTP::Daemon::PROTO variable is used.

クライアントにステータス行を送信します。 $code が省略されると、200 が仮定されます。 $mess が省略されると、$code に対応するメッセージが挿入されます。 $proto が省略されると、$HTTP::Daemon::PROTO 変数の内容が使われます。

$c->send_crlf

Send the CRLF sequence to the client.

クライアントに CRLF の並びを送信します。

$c->send_basic_header

$c->send_basic_header( $code )

$c->send_basic_header( $code, $mess )

$c->send_basic_header( $code, $mess, $proto )

Send the status line and the "Date:" and "Server:" headers back to the client. This header is assumed to be continued and does not end with an empty CRLF line.

ステータス行と "Date:" と" Server:" ヘッダをクライアントに送信します。 このヘッダは続いていて、空の CRLF 行で終わらないことを仮定しています。

See the description of send_status_line() for the description of the accepted arguments.

受け付ける引数の説明については send_status_line() を参照してください。

$c->send_response( $res )

Write a HTTP::Response object to the client as a response. We try hard to make sure that the response is self delimiting so that the connection can stay persistent for further request/response exchanges.

クライアントにレスポンスとして HTTP::Response オブジェクトを書きます。 接続がさらなるリクエスト／レスポンス交換のため永続化できるように、 レスポンスが自己分割することを保証するようにしています。

The content attribute of the HTTP::Response object can be a normal string or a subroutine reference. If it is a subroutine, then whatever this callback routine returns is written back to the client as the response content. The routine will be called until it return an undefined or empty value. If the client is HTTP/1.1 aware then we will use chunked transfer encoding for the response.

HTTP::Response オブジェクトの content 属性は通常の文字列または サブルーチンリファレンスにすることができます。 もしサブルーチンであれば、このコールバックルーチンが返すものは何であれ、 レスポンスコンテンツとしてクライアントに書き戻されます。 ルーチンはそれが未定義あるいは空の値を返すまで呼ばれます。 もしクライアントが HTTP/1.1 がわかれば、レスポンスにチャンクされた 転送エンコーディングを使います。

$c->send_redirect( $loc )

$c->send_redirect( $loc, $code )

$c->send_redirect( $loc, $code, $entity_body )

Send a redirect response back to the client. The location ($loc) can be an absolute or relative URL. The $code must be one the redirect status codes, and defaults to "301 Moved Permanently"

クライアントにリダイレクトレスポンスを送信します。 ロケーション ($loc) は絶対あるいは相対 URL を指定することが出来ます。 $code はリダイレクトステータスコードの一つでなければなりません。 そしてデフォルトは "301 Moved Permanently" です。

$c->send_error

$c->send_error( $code )

$c->send_error( $code, $error_message )

Send an error response back to the client. If the $code is missing a "Bad Request" error is reported. The $error_message is a string that is incorporated in the body of the HTML entity body.

クライアントにエラーレスポンスを送信します。 $code がなければ "Bad Request" エラーが報告されます。 $error_message は HTML エンティティボディのボディに結合さた文字列です。

$c->send_file_response( $filename )

Send back a response with the specified $filename as content. If the file is a directory we try to generate an HTML index of it.

指定された $filename をコンテンツとしたレスポンスを返します。 もし file がディレクトリであれば、その HTML インデックスを作ろうとします。

$c->send_file( $filename )

$c->send_file( $fd )

Copy the file to the client. The file can be a string (which will be interpreted as a filename) or a reference to an IO::Handle or glob.

クライアントにファイルをコピーします。 ファイルは文字列 (ファイル名として解釈されます) または IO::Handle への リファレンスまたは glob のいずれかを指定することが出来ます。

$c->daemon

Return a reference to the corresponding HTTP::Daemon object.

対応する HTTP::Daemon オブジェクトへのリファレンスを返します。

SEE ALSO¶

RFC 2616

IO::Socket::INET, IO::Socket

コピーライト¶

Copyright 1996-2003, Gisle Aas

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.