Specification of the connection adapter API implemented by webservers
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
peer_data() :: %{ address: :inet.ip_address(), port: :inet.port_number(), ssl_cert: binary() | nil }
chunk(payload(), Plug.Conn.status()) :: :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.
Returns the HTTP protocol and its version.
Returns peer information such as the address, port and ssl cert.
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.
push(payload(), path :: String.t(), headers :: Keyword.t()) :: :ok | {:error, term()}
Push a resource to the client.
If the adapter does not support server push then {:error, :not_supported}
should be returned.
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.
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.
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.
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.
© 2013 Plataformatec
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/plug/1.7.1/Plug.Conn.Adapter.html