mirror of
https://github.com/ninenines/cowboy.git
synced 2025-07-15 20:50:24 +00:00
57fda14217
This new protocol option is a fun. It expects 3 args: the Status code used in the reply (this is the cowboy_http:status() type, it can be an integer or a binary), the headers that will be sent in the reply, and the Req. It should only return a possibly modified Req. This can be used for many things like error logging or custom error pages. If a reply is sent inside the hook, then Cowboy will discard the reply initially sent. Extra caution must be used in the handlers making use of inline chunked replies as they will throw an error. This fun cannot be used as a filter, you can either observe the reply sent or discard it to send a different one instead. The hook will not be called for replies sent from inside the hook.
58 lines
2.7 KiB
Erlang
58 lines
2.7 KiB
Erlang
%% Copyright (c) 2011, Loïc Hoguin <essen@dev-extend.eu>
|
|
%% Copyright (c) 2011, Anthony Ramine <nox@dev-extend.eu>
|
|
%%
|
|
%% Permission to use, copy, modify, and/or distribute this software for any
|
|
%% purpose with or without fee is hereby granted, provided that the above
|
|
%% copyright notice and this permission notice appear in all copies.
|
|
%%
|
|
%% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
%% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
%% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
%% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
%% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
%% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
%% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
-record(http_req, {
|
|
%% Transport.
|
|
socket = undefined :: undefined | inet:socket(),
|
|
transport = undefined :: undefined | module(),
|
|
connection = keepalive :: keepalive | close,
|
|
|
|
%% Request.
|
|
pid = undefined :: pid(),
|
|
method = 'GET' :: cowboy_http:method(),
|
|
version = {1, 1} :: cowboy_http:version(),
|
|
peer = undefined :: undefined |
|
|
{inet:ip_address(), inet:port_number()},
|
|
host = undefined :: undefined | cowboy_dispatcher:tokens(),
|
|
host_info = undefined :: undefined | cowboy_dispatcher:tokens(),
|
|
raw_host = undefined :: undefined | binary(),
|
|
port = undefined :: undefined | inet:port_number(),
|
|
path = undefined :: undefined | '*' | cowboy_dispatcher:tokens(),
|
|
path_info = undefined :: undefined | cowboy_dispatcher:tokens(),
|
|
raw_path = undefined :: undefined | binary(),
|
|
qs_vals = undefined :: undefined | list({binary(), binary() | true}),
|
|
raw_qs = undefined :: undefined | binary(),
|
|
bindings = undefined :: undefined | cowboy_dispatcher:bindings(),
|
|
headers = [] :: cowboy_http:headers(),
|
|
p_headers = [] :: [any()], %% @todo Improve those specs.
|
|
cookies = undefined :: undefined | [{binary(), binary()}],
|
|
meta = [] :: [{atom(), any()}],
|
|
|
|
%% Request body.
|
|
body_state = waiting :: waiting | done | {stream, fun(), any(), fun()}
|
|
| {multipart, non_neg_integer(), fun()},
|
|
buffer = <<>> :: binary(),
|
|
|
|
%% Response.
|
|
resp_state = waiting :: locked | waiting | chunks | done,
|
|
resp_headers = [] :: cowboy_http:headers(),
|
|
resp_body = <<>> :: iodata() | {non_neg_integer(),
|
|
fun(() -> {sent, non_neg_integer()})},
|
|
|
|
%% Functions.
|
|
onresponse = undefined :: undefined | fun((cowboy_http:status(),
|
|
cowboy_http:headers(), #http_req{}) -> #http_req{}),
|
|
urldecode :: {fun((binary(), T) -> binary()), T}
|
|
}).
|