http_headers() = [{binary(), iodata()}]
http_status() = non_neg_integer() | binary()
http_version() = 'HTTP/1.1' | 'HTTP/1.0'
onrequest_fun() = fun((Req) -> Req)
onresponse_fun() = fun((http_status(), http_headers(), iodata(), Req) -> Req)
set_env/3 | Convenience function for setting an environment value. |
start_http/4 | Start an HTTP listener. |
start_https/4 | Start an HTTPS listener. |
start_spdy/4 | Start a SPDY listener. |
stop_listener/1 | Stop a listener. |
set_env(Ref::ranch:ref(), Name::atom(), Value::any()) -> ok
Convenience function for setting an environment value.
Allows you to update live an environment value used by middlewares. This function is primarily intended to simplify updating the dispatch list used for routing.start_http(Ref::ranch:ref(), NbAcceptors::non_neg_integer(), TransOpts::ranch_tcp:opts(), ProtoOpts::cowboy_protocol:opts()) -> {ok, pid()} | {error, any()}
Start an HTTP listener.
start_https(Ref::ranch:ref(), NbAcceptors::non_neg_integer(), TransOpts::ranch_ssl:opts(), ProtoOpts::cowboy_protocol:opts()) -> {ok, pid()} | {error, any()}
Start an HTTPS listener.
start_spdy(Ref::ranch:ref(), NbAcceptors::non_neg_integer(), TransOpts::ranch_ssl:opts(), ProtoOpts::cowboy_spdy:opts()) -> {ok, pid()} | {error, any()}
Start a SPDY listener.
stop_listener(Ref::ranch:ref()) -> ok
Stop a listener.
Generated by EDoc, Oct 28 2013, 11:09:20.