Module wrq

Copyright © 2007-2009 Basho Technologies Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Authors: Justin Sheehy (justin@basho.com).

Data Types

method()

method() = 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | string() | binary()

reqdata()

abstract datatype: reqdata()

The opaque data type used for req/resp data structures.

scheme()

scheme() = http | https

t()

t() = #wm_reqdata{method = wrq:method(), scheme = wrq:scheme(), version = {non_neg_integer(), non_neg_integer()}, peer = any(), sock = any(), wm_state = any(), disp_path = any(), path = string(), raw_path = string(), path_info = orddict:orddict(), path_tokens = any(), app_root = any(), response_code = non_neg_integer() | {non_neg_integer(), string()}, max_recv_body = non_neg_integer(), max_recv_hunk = non_neg_integer(), req_cookie = [{string(), string()}] | defined_in_create, req_qs = [{string(), string()}] | defined_in_create, req_headers = webmachine_headers:headers(), req_body = any(), resp_redirect = boolean(), resp_headers = webmachine_headers:headers(), resp_body = webmachine:response_body(), resp_range = follow_request | ignore_request, host_tokens = any(), port = undefined | inet:port_number(), notes = list()}

version()

version() = {non_neg_integer(), non_neg_integer()}

Function Index

add_note/3
app_root/1
append_to_resp_body/2
append_to_response_body/2
base_uri/1
create/4
create/5
disp_path/1
do_redirect/2
fresh_resp_headers/2
get_cookie_value/2
get_notes/1
get_qs_value/2
get_qs_value/3
get_req_header/2
get_resp_header/2
host_tokens/1
load_dispatch_data/7
max_recv_body/1
merge_resp_headers/2
method/1
path/1
path_info/1
path_info/2
path_tokens/1
peer/1
port/1
raw_path/1
remove_resp_header/2
req_body/1
req_cookie/1
req_headers/1
req_qs/1
resp_body/1
resp_headers/1
resp_redirect/1
response_code/1
scheme/1
set_disp_path/2
set_max_recv_body/2
set_peer/2
set_req_body/2
set_resp_body/2
set_resp_header/3
set_resp_headers/2
set_resp_range/2
set_response_code/2
set_sock/2
sock/1
stream_req_body/2
version/1

Function Details

add_note/3

add_note(K::any(), V::any(), RD::t()) -> t()

app_root/1

app_root(RD) -> any()

append_to_resp_body/2

append_to_resp_body(Data::iolist() | binary(), RD::t()) -> t()

append_to_response_body/2

append_to_response_body(IOList::iolist() | binary(), RD::t()) -> t()

base_uri/1

base_uri(RD::t()) -> string()

create/4

create(Method::method(), Version::version(), RawPath::string(), Headers::webmachine:headers()) -> t()

create/5

create(Method::method(), Scheme::scheme(), Version::version(), RawPath::string(), Headers::webmachine:headers()) -> t()

disp_path/1

disp_path(RD::t()) -> string()

do_redirect/2

do_redirect(Bool::boolean(), RD::t()) -> t()

fresh_resp_headers/2

fresh_resp_headers(Hdrs, RD) -> any()

get_cookie_value/2

get_cookie_value(Key::string(), RD::t()) -> string() | undefined

get_notes/1

get_notes(RD::t()) -> list()

get_qs_value/2

get_qs_value(Key::string(), RD::t()) -> string() | undefined

get_qs_value/3

get_qs_value(Key::string(), Default::string(), RD::t()) -> string()

get_req_header/2

get_req_header(HdrName::webmachine_headers:name(), RD::t()) -> undefined | webmachine_headers:value()

get_resp_header/2

get_resp_header(HdrName, RD) -> any()

host_tokens/1

host_tokens(RD) -> any()

load_dispatch_data/7

load_dispatch_data(PathInfo, HostTokens, Port, PathTokens, AppRoot, DispPath, RD) -> any()

max_recv_body/1

max_recv_body(RD) -> any()

merge_resp_headers/2

merge_resp_headers(Hdrs, RD) -> any()

method/1

method(RD::t()) -> method()

path/1

path(RD::t()) -> string()

path_info/1

path_info(RD) -> any()

path_info/2

path_info(Key, RD) -> any()

path_tokens/1

path_tokens(RD) -> any()

peer/1

peer(RD) -> any()

port/1

port(RD::t()) -> inet:port_number()

raw_path/1

raw_path(RD::t()) -> string()

remove_resp_header/2

remove_resp_header(K, RD) -> any()

req_body/1

req_body(RD) -> any()

req_cookie/1

req_cookie(RD::t()) -> [{string(), string()}]

req_headers/1

req_headers(RD::t()) -> webmachine:headers()

req_qs/1

req_qs(RD::t()) -> [{string(), string()}]

resp_body/1

resp_body(RD::t()) -> webmachine:response_body()

resp_headers/1

resp_headers(RD::t()) -> webmachine_headers:headers()

resp_redirect/1

resp_redirect(Wm_reqdata::t()) -> boolean()

response_code/1

response_code(Wm_reqdata::t()) -> non_neg_integer()

scheme/1

scheme(RD::t()) -> scheme()

set_disp_path/2

set_disp_path(P, RD) -> any()

set_max_recv_body/2

set_max_recv_body(X, RD) -> any()

set_peer/2

set_peer(P, RD) -> any()

set_req_body/2

set_req_body(Body, RD) -> any()

set_resp_body/2

set_resp_body(Body, RD) -> any()

set_resp_header/3

set_resp_header(K, V, RD) -> any()

set_resp_headers/2

set_resp_headers(Hdrs, RD) -> any()

set_resp_range/2

set_resp_range(RespRange::follow_request | ignore_request, RD::t()) -> t()

set_response_code/2

set_response_code(CodeAndReason, RD) -> any()

set_sock/2

set_sock(S, RD) -> any()

sock/1

sock(RD) -> any()

stream_req_body/2

stream_req_body(RD, MaxHunk) -> any()

version/1

version(RD::t()) -> version()


Generated by EDoc