Bandit v0.1.0

Bandit.HTTPRequest behaviour (Bandit v0.1.0) View Source

Defines behaviour to be implemented by HTTP Request handlers in addition to those defined by Plug.Conn.Adapter.

Link to this section Summary

Types

payload()

Callbacks

close(payload)
get_local_data(payload)
keepalive?(payload)
read_headers(payload)
request(arg1)
send_fallback_resp(payload, code)

Link to this section Types

Link to this type

payload()

View Source

Specs

payload() :: term()

Link to this section Callbacks

Link to this callback

close(payload)

View Source

Specs

close(payload()) :: :ok
Link to this callback

get_local_data(payload)

View Source

Specs

get_local_data(payload()) :: Plug.Conn.Adapter.peer_data()
Link to this callback

keepalive?(payload)

View Source

Specs

keepalive?(payload()) :: bool()
Link to this callback

read_headers(payload)

View Source

Specs

read_headers(payload()) ::
  {:ok, keyword(), String.t(), String.t(), payload()} | {:error, String.t()}
Link to this callback

request(arg1)

View Source

Specs

request(ThousandIsland.Socket.t()) :: {:ok, module(), payload()}
Link to this callback

send_fallback_resp(payload, code)

View Source

Specs

send_fallback_resp(payload(), code :: pos_integer()) :: :ok