ankh v0.8.1 Ankh.HTTP
Ankh HTTP public API
Link to this section Summary
Functions
Accepts an HTTP connection
Closes the underlying connection
Establishes an HTTP connection to a server
Reports a connection error
Sends a request to a server
Sends a response to a client request
Receives data form the the other and and returns responses
Link to this section Types
HTTP body
HTTP Header
HTTP Header name
HTTP Header value
HTTP Headers
Link to this section Functions
accept(uri, socket, options \\ [])
accept(URI.t(), Ankh.Transport.t(), Ankh.Transport.options()) :: {:ok, Ankh.Protocol.t()} | {:error, any()}
Accepts an HTTP connection
After accepting the connection, stream
will receive requests from the client and respond
can be used to send replies.
Closes the underlying connection
connect(uri, options \\ [])
connect(URI.t(), keyword()) :: {:ok, Ankh.Protocol.t()} | {:error, any()}
Establishes an HTTP connection to a server
After establishing the connection, request
can be user to send request to the server and
stream
can be used to receive receive responses.
Reports a connection error
request(protocol, request)
request(Ankh.Protocol.t(), Ankh.HTTP.Request.t()) :: {:ok, Ankh.Protocol.t(), Ankh.Protocol.request_ref()} | {:error, any()}
Sends a request to a server
Needs a connection to be established via connect
beforehand.
respond(protocol, reference, response)
respond(Ankh.Protocol.t(), Ankh.Protocol.request_ref(), Ankh.HTTP.Response.t()) :: {:ok, Ankh.Protocol.t()} | {:error, any()}
Sends a response to a client request
Needs a connection to be accepted via accept
beforehand.
stream(protocol, msg)
stream(Ankh.Protocol.t(), any()) :: {:ok, Ankh.Protocol.t(), any()} | {:error, any()}
Receives data form the the other and and returns responses