Plug v1.10.1 Plug.Conn.Adapter behaviour View Source
Specification of the connection adapter API implemented by webservers.
All adapters are required to emit the proper plug_adapter.call.start
,
plug_adapter.call.stop
and plug_adapter.call.failure
telemetry
events on every request, with the %{conn: Plug.Conn, adapter: adapter_name}
as metadata.
Link to this section Summary
Callbacks
Sends a chunk in the chunked response.
Returns the HTTP protocol and its version.
Returns peer information such as the address, port and ssl cert.
Send an informational response to the client.
Push a resource to the client.
Reads the request body.
Sends the given status, headers as the beginning of a chunked response to the client.
Sends the given status, headers and file as a response back to the client.
Sends the given status, headers and body as a response back to the client.
Link to this section Types
Specs
http_protocol() :: :"HTTP/1" | :"HTTP/1.1" | :"HTTP/2" | atom()
Specs
payload() :: term()
Specs
peer_data() :: %{ address: :inet.ip_address(), port: :inet.port_number(), ssl_cert: binary() | nil }
Link to this section Callbacks
Specs
chunk(payload(), Plug.Conn.body()) :: :ok | {:ok, sent_body :: binary(), payload()} | {:error, term()}
Sends a chunk in the chunked response.
If the request has method "HEAD"
, the adapter should
not send the response to the client.
Webservers are advised to return :ok
and not modify
any further state for each chunk. However, the test
implementation returns the actual body and payload so
it can be used during testing.
Specs
get_http_protocol(payload()) :: http_protocol()
Returns the HTTP protocol and its version.
Specs
Returns peer information such as the address, port and ssl cert.
Specs
inform(payload(), Plug.Conn.status(), headers :: Keyword.t()) :: :ok | {:error, term()}
Send an informational response to the client.
If the adapter does not support inform, then {:error, :not_supported}
should be returned.
Specs
Push a resource to the client.
If the adapter does not support server push then {:error, :not_supported}
should be returned.
Specs
read_req_body(payload(), options :: Keyword.t()) :: {:ok, data :: binary(), payload()} | {:more, data :: binary(), payload()} | {:error, term()}
Reads the request body.
Read the docs in Plug.Conn.read_body/2
for the supported
options and expected behaviour.
Specs
send_chunked(payload(), Plug.Conn.status(), Plug.Conn.headers()) :: {:ok, sent_body :: binary() | nil, payload()}
Sends the given status, headers as the beginning of a chunked response to the client.
Webservers are advised to return nil
as the sent_body,
as the body can no longer be manipulated. However, the
test implementation returns the actual body so it can
be used during testing.
Specs
send_file( payload(), Plug.Conn.status(), Plug.Conn.headers(), file :: binary(), offset :: integer(), length :: integer() | :all ) :: {:ok, sent_body :: binary() | nil, payload()}
Sends the given status, headers and file as a response back to the client.
If the request has method "HEAD"
, the adapter should
not send the response to the client.
Webservers are advised to return nil
as the sent_body,
as the body can no longer be manipulated. However, the
test implementation returns the actual body so it can
be used during testing.
Specs
send_resp(payload(), Plug.Conn.status(), Plug.Conn.headers(), Plug.Conn.body()) :: {:ok, sent_body :: binary() | nil, payload()}
Sends the given status, headers and body as a response back to the client.
If the request has method "HEAD"
, the adapter should
not send the response to the client.
Webservers are advised to return nil
as the sent_body,
as the body can no longer be manipulated. However, the
test implementation returns the actual body so it can
be used during testing.