simple_bridge behaviour (simple_bridge v2.3.2)

View Source

Summary

Types

bridge/0

-type bridge() ::
          #sbw{mod :: term(),
               req :: term(),
               is_multipart :: term(),
               post_params :: term(),
               query_params :: term(),
               post_files :: term(),
               error :: term(),
               headers :: term(),
               cookies :: term(),
               response :: term()}.

Callbacks

build_response/2

-callback build_response(req(),
                         #response{status_code :: term(),
                                   headers :: term(),
                                   cookies :: term(),
                                   data :: term()}) ->
                            any().

headers/1

-callback headers(req()) -> [{key(), value()}] | map().

host/1

-callback host(req()) -> string().

init/1

-callback init(req()) -> req().

native_header_type/0

-callback native_header_type() -> map | list.

path/1

-callback path(req()) -> string().

peer_ip/1

-callback peer_ip(req()) -> ipv4() | ipv6().

post_params/1

-callback post_params(req()) -> [{key(), value()}].

protocol/1

-callback protocol(req()) -> http | https | ws | wss | undefined.

query_params/1

-callback query_params(req()) -> [{key(), value()}].

request_method/1

-callback request_method(req()) -> 'GET' | 'POST' | 'DELETE' | atom().

uri/1

-callback uri(req()) -> string().

Functions

make(BridgeType, Req)

make(BridgeType, Req, DocRoot)

make_request(Module, Req)

make_response(Module, Bridge)

start()

start(Backend)

start(Backend, Handler)