Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > webrick/httpresponseライブラリ > WEBrick::HTTPResponseクラス

class WEBrick::HTTPResponse

クラスの継承リスト: WEBrick::HTTPResponse < Object < Kernel < BasicObject

要約

HTTP のレスポンスを表すためのクラスです。

通常 WEBrick::HTTPResponse オブジェクトはサーブレットの service メソッドや do_XXX メソッドの引数として与えられるものであり、ユーザが明示的に生成する必要はありません。

特異メソッド

定義 説明
new(config) -> WEBrick::HTTPResponse

HTTPResponse オブジェクトを生成して返します。

インスタンスメソッド

定義 説明
self[field] -> String

レスポンスのヘッダの該当する内容を文字列で返します。

self[field] = val

レスポンスの該当するヘッダに val を設定します。

body -> String | IO

クライアントに返す内容(エンティティボディ)を返します。

body=(val)

クライアントに返す内容(エンティティボディ)をセットします。

chunked=(flag)

真に設定するとクライアントに返す内容(エンティティボディ)を chunk に分けるようになります。

chunked? -> bool

真であればクライアントに返す内容(エンティティボディ)を chunk に分けます。

config -> Hash

自身が生成される時に指定されたハッシュを返します。

content_length -> Integer | nil
content_length=(len)

Content-Length ヘッダの値を整数で表すアクセサです。デフォルトは nil です。

content_type -> String | nil

Content-Type ヘッダの値を返します。

content_type=(val)

Content-Type ヘッダの値をセットします。

cookies -> [WEBrick::Cookie]

レスポンスの Set-Cookie ヘッダの値を表す WEBrick::Cookie オブジェクトの配列です。レスポンスに新たに Cookie を加えたい場合はこの配列に WEBrick::Cookie オブジェクトを加えます。

each {|key, val| ... }

レスポンスのヘッダ名を key、内容を val としてブロックを評価します。

filename -> String | nil

自身の内容があるファイルのそれである場合に、そのファイル名を返します。デフォルトは nil です。

filename=(file)

自身の内容があるファイルのそれである場合に、そのファイル名をセットします。デフォルトは nil です。

header -> Hash

ヘッダ名をキー、ヘッダの値を値とするハッシュを返します。ハッシュのキーも値も文字列です。

http_version -> WEBrick::HTTPVersion

レスポンスの HTTP のバージョンを表す WEBrick::HTTPVersion オブジェクトを返します。

keep_alive? -> bool
keep_alive -> bool

レスポンスの keep_alive が有効である場合は、真を返します。そうでない場合は偽を返します。デフォルトは真です。

keep_alive=(flag)

真をセットするとレスポンスの keep_alive が有効になります。デフォルトは真です。

reason_phrase -> String | nil

HTTP のレスポンスの最初の行の reason phrase を返します。この値が nil の場合 reason phrase は status から生成されます。デフォルトは nil です。

reason_phrase=(val)

HTTP のレスポンスの最初の行の reason phrase をセットします。この値が nil の場合 reason phrase は status から生成されます。デフォルトは nil です。

request_http_version -> WEBrick::HTTPVersion

リクエストの HTTP バージョンを返します。デフォルトでは自身の WEBrick::HTTPResponse#http_version が使われます。

request_http_version=(ver)

リクエストの HTTP バージョンをセットします。

request_method -> String | nil

リクエストの HTTP メソッドを返します。

request_method=(method)

リクエストの HTTP メソッドをセットします。デフォルトは nil です。

request_uri -> URI | nil

リクエストの URI を返します。

request_uri=(uri)

リクエストの URI をセットします。デフォルトは nil です。

sent_size -> Integer

クライアントに送られた内容(エンティティボディ)のバイト数を表す整数を返します。

set_error(status, backtrace = false) -> ()

自身の内容(エンティティボディ)を指定された status のエラーページにします。

set_redirect(status, url) -> ()

指定された url にリダイレクトするためのヘッダと内容(エンティティボディ)を設定し例外 status を発生させます。

status -> Integer

レスポンスのステータスコードを表す整数を返します。デフォルトは WEBrick::HTTPStatus::RC_OK です。

status=(status)

レスポンスのステータスコードを整数で指定します。 reason_phrase も適切なものに設定されます。

status_line -> String

HTTP のステータスラインを CR+LF 付き文字列で返します。

to_s -> String

実際にクライアントに送られるデータを文字列として返します。

継承したメソッド

! != __id__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> == === =~ __send__ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? singleton_class singleton_method singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE