Overviewerlang logo

Module backwater_request

Data Types

conn_params()

conn_params() = #{transport := transport(), host := nonempty_string(), port := inet:port_number()}

endpoint()

endpoint() = {location(), secret()}

http_params()

http_params() = #{method := nonempty_binary(), path := nonempty_binary(), headers := nonempty_headers(), body := binary()}

location()

location() = nonempty_binary() | nonempty_string() | {nonempty_string(), inet:port_number()} | inet:ip_address() | {inet:ip_address(), inet:port_number()}

nonempty_headers()

nonempty_headers() = [{nonempty_binary(), binary()}, ...]

options()

options() = #{compression_threshold => non_neg_integer()}

secret()

secret() = binary()

state()

state() = #{signed_request_msg := backwater_signatures:signed_message()}

t()

t() = #{conn_params := conn_params(), http_params := http_params(), full_url := nonempty_binary()}

transport()

transport() = hackney_tcp | hackney_ssl

Function Index

encode/4
encode/5

Function Details

encode/4

encode(Endpoint, Module, Function, Args) -> {Request, RequestState}

encode/5

encode(Endpoint, Module, Function, Args, Options) -> {Request, RequestState}

Overviewerlang logo

Generated by EDoc