libwww-perl-5.813 > HTTP::Message


HTTP::Message - HTTP style message (base class)

HTTP::Message - HTTP 形式のメッセージ (基底クラス)


 use base 'HTTP::Message';


An HTTP::Message object contains some headers and a content body. The following methods are available:

HTTP::Message オブジェクトには幾つかのヘッダとコンテンツの本体が 入っています。 以下のメソッドが利用できます:

$mess = HTTP::Message->new
$mess = HTTP::Message->new( $headers )
$mess = HTTP::Message->new( $headers, $content )

This constructs a new message object. Normally you would want construct HTTP::Request or HTTP::Response objects instead.

これは新しいメッセージオブジェクトを構築します。 普通は代わりに HTTP::Request または HTTP::Response オブジェクトを 構築したいでしょう。

The optional $header argument should be a reference to an HTTP::Headers object or a plain array reference of key/value pairs. If an HTTP::Headers object is provided then a copy of it will be embedded into the constructed message, i.e. it will not be owned and can be modified afterwards without affecting the message.

オプションの $header 引数は HTTP::Headers オブジェクトへのリファレンスか、 キー/値の組へのリファレンスの配列を取ります。 HTTP::Headers オブジェクトを指定した場合は、これのコピーが 構築されるメッセージに組み込まれます (つまり、後でオブジェクトを変更しても メッセージには影響を与えません)。

The optional $content argument should be a string of bytes.

オプションの $content 引数はバイト文字列であるべきです。

$mess = HTTP::Message->parse( $str )

This constructs a new message object by parsing the given string.

与えられた文字列をパースすることで新しいメッセージオブジェクトを 作成します。


Returns the embedded HTTP::Headers object.

埋め込まれた HTTP::Headers オブジェクトを返します。

$mess->headers_as_string( $eol )

Call the as_string() method for the headers in the message. This will be the same as

メッセージの中のヘッダのために as_string() を呼び出します。 これは以下のものと同様ですが


but it will make your program a whole character shorter :-)

あなたのプログラムの文字数が減ります :-)

$mess->content( $bytes )

The content() method sets the raw content if an argument is given. If no argument is given the content is not touched. In either case the original raw content is returned.

引数が与えられていれば、content() メソッドは生の内容を設定します。 引数が与えられなければ、内容は触られません。 いずれの場合も元の生の内容は返されます。

Note that the content should be a string of bytes. Strings in perl can contain characters outside the range of a byte. The Encode module can be used to turn such strings into a string of bytes.

内容はバイト文字列であるべきであることに注意してください。 Perl での文字列はバイトの範囲を超える文字を含むことができます。 そのような文字列をバイト文字列を変換するには Encode モジュールが 使えます。

$mess->add_content( $bytes )

The add_content() methods appends more data bytes to the end of the current content buffer.

add_content() メソッドは現在のコンテンツの末尾にさらにバイトデータを 追加します。

$mess->add_content_utf8( $string )

The add_content_utf8() method appends the UTF-8 bytes representing the string to the end of the current content buffer.

add_content_utf8() メソッドは、$string で表現される UTF-8 バイトを 現在の内容バッファの末尾に追加します。

$mess->content_ref( \$bytes )

The content_ref() method will return a reference to content buffer string. It can be more efficient to access the content this way if the content is huge, and it can even be used for direct manipulation of the content, for instance:

content_ref() メソッドは内容バッファ文字列へのリファレンスを返します。 コンテンツが巨大であれば、この方法でコンテンツにアクセスするのはより 効率的かもしれません。 そしてコンテンツの直接操作するためにすら使うことが出来ます。 例えば:

  ${$res->content_ref} =~ s/\bfoo\b/bar/g;

This example would modify the content buffer in-place.


If an argument is passed it will setup the content to reference some external source. The content() and add_content() methods will automatically dereference scalar references passed this way. For other references content() will return the reference itself and add_content() will refuse to do anything.

引数が渡されると、それを外部ソースへリファレンスとして内容を 設定します。 content() メソッドと add_content() メソッドは、この方法で渡された スカラリファレンスを自動的にデリファレンスします。 その他のリファレンスの場合、content() はリファレンス自身を返し、 add_content() は何もしません。

$mess->decoded_content( %options )

Returns the content with any Content-Encoding undone and the raw content encoded to perl's Unicode strings. If the Content-Encoding or charset of the message is unknown this method will fail by returning undef.

Content-Encoding が未処理の、perl の Unicode 文字列でエンコードされた 生の内容を返します。 メッセージの Content-Encoding あるいは charset が不明の場合、 このメソッドは undef を返して失敗します。

The following options can be specified.



This override the charset parameter for text content. The value none can used to suppress decoding of the charset.

これはテキストの内容の文字集合パラメータを上書きします。 文字セットのデコードを抑制するために none という値が使えます。


This override the default charset of "ISO-8859-1".

これはデフォルトの文字集合である "ISO-8859-1" を上書きします。


Abort decoding if malformed characters is found in the content. By default you get the substitution character ("\x{FFFD}") in place of malformed characters.

もし内容に不正な文字が見つかると、デコードを中断します。 デフォルトでは、不正な文字の位置には代わりの文字 ("\x{FFFD}") が 使われます。


If TRUE then raise an exception if not able to decode content. Reason might be that the specified Content-Encoding or charset is not supported. If this option is FALSE, then decoded_content() will return undef on errors, but will still set $@.

この値が真の場合、内容をデコードできない場合に例外が発生します。 理由は、Content-Encodingcharset に指定されたものに 対応していないことかもしれません。 この値が偽の場合、decoded_content() はエラー時には undef を 返しますが、それでも $@ は設定されます。


If TRUE then a reference to decoded content is returned. This might be more efficient in cases where the decoded content is identical to the raw content as no data copying is required in this case.

この値が真の場合、デコードされた内容へのリファレンスが返されます。 元の内容とデコードされた内容が同じ場合、データのコピーが必要ないので、 これを設定するとより効率的になるでしょう。

$mess->parts( @parts )
$mess->parts( \@parts )

Messages can be composite, i.e. contain other messages. The composite messages have a content type of multipart/* or message/*. This method give access to the contained messages.

メッセージは合成できます (他のメッセージを含むことができます)。 合成メッセージは multipart/*message/* のコンテントタイプを 持ちます。 このメソッドは含まれているメッセージにアクセスします。

The argumentless form will return a list of HTTP::Message objects. If the content type of $msg is not multipart/* or message/* then this will return the empty list. In scalar context only the first object is returned. The returned message parts should be regarded as are read only (future versions of this library might make it possible to modify the parent by modifying the parts).

引数なし形式の場合は HTTP::Message オブジェクトのリストを返します。 $msg のコンテントタイプが multipart/* でも message/* でもない場合は 空リストが返されます。 スカラコンテキストでは最初のオブジェクトのみが返されます。 返されたメッセージ部品は読み込み専用と考えるべきです (このライブラリの将来のバージョンでは、部品を変更することで親を 変更できるようになるかもしれません)。

If the content type of $msg is message/* then there will only be one part returned.

$msg のコンテントタイプが message/* なら、一つの部品だけが 返されます。

If the content type is message/http, then the return value will be either an HTTP::Request or an HTTP::Response object.

コンテントタイプが message/http なら、返された値は HTTP::Request オブジェクトか HTTP::Response オブジェクトです。

If an @parts argument is given, then the content of the message will be modified. The array reference form is provided so that an empty list can be provided. The @parts array should contain HTTP::Message objects. The @parts objects are owned by $mess after this call and should not be modified or made part of other messages.

@parts 引数が与えられると、メッセージの内容は変更されます。 空リストを提供できるように、配列リファレンス形式で提供されます。 @parts 配列は HTTP::Message オブジェクトを含んでいる必要があります。 @parts オブジェクトはこの呼び出しの後 $mess によって所有され、 修正されたり、他のメッセージの部品となったりはしません。

When updating the message with this method and the old content type of $mess is not multipart/* or message/*, then the content type is set to multipart/mixed and all other content headers are cleared.

このメソッドによってメッセージが更新され、$mess の古い コンテントタイプが multipart/* でも message/* でもない場合、 コンテントタイプは multipart/mixed に設定され、その他の全ての コンテントヘッダはクリアされます。

This method will croak if the content type is message/* and more than one part is provided.

このメソッドは、コンテントタイプが message/* で、複数の部品が 提供された場合、croak します。

$mess->add_part( $part )

This will add a part to a message. The $part argument should be another HTTP::Message object. If the previous content type of $mess is not multipart/* then the old content (together with all content headers) will be made part #1 and the content type made multipart/mixed before the new part is added. The $part object is owned by $mess after this call and should not be modified or made part of other messages.

メッセージに部品を追加します。 $part 引数はもう一つの HTTP::Message オブジェクトです。 $mess の以前のコンテントタイプが multipart/* でない場合、 古い内容(と全てのコンテントヘッダ) は 1 番目の部品になり、新しい部品が 追加される前にコンテントタイプは multipart/mixed になります。 $part オブジェクトはこの呼び出しの後 $mess によって所有され、 修正されたり、他のメッセージの部品となったりはしません。

There is no return value.



Will clear the headers and set the content to the empty string. There is no return value

ヘッダをクリアし、内容を空文字列に設定します。 返り値はありません。

$mess->protocol( $proto )

Sets the HTTP protocol used for the message. The protocol() is a string like HTTP/1.0 or HTTP/1.1.

そのメッセージに使われる HTTP プロトコルを設定します。 protocol() は HTTP/1.0HTTP/1.1 のような文字列です。


Returns a copy of the message object.


$mess->as_string( $eol )

Returns the message formatted as a single string.


The optional $eol parameter specifies the line ending sequence to use. The default is "\n". If no $eol is given then as_string will ensure that the returned string is newline terminated (even when the message content is not). No extra newline is appended if an explicit $eol is passed.

オプションの $eol 引数は、使用する行末シーケンスを指定します。 デフォルトは "\n" です。 $eol が与えられなかった場合は、(たとえメッセージの末尾に改行がなくても) 返される文字列が改行で終端されることが保証されます。 明示的に $eol が渡された場合は、改行は追加されません。

All methods unknown to HTTP::Message itself are delegated to the HTTP::Headers object that is part of every message. This allows convenient access to these methods. Refer to HTTP::Headers for details of these methods:

HTTP::Message 自身が分からないすべてのメソッドは、 代わりに各メッセージの一部である HTTP::Headers オブジェクトに 委譲されます。 これは以下の便利メソッドへのアクセスを可能にします。 これらのメソッドについての詳細は HTTP::Headers を参照してください。

    $mess->header( $field => $val )
    $mess->push_header( $field => $val )
    $mess->init_header( $field => $val )
    $mess->remove_header( $field )
    $mess->scan( \&doit )



Copyright 1995-2004 Gisle Aas.

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