Goth v1.3.0-rc.3

Goth.HTTPClient behaviour (Goth v1.3.0-rc.3) View Source

Specification for a Goth HTTP client.

The client is configured as a {module, initial_state} tuple where the module implements this behaviour and initial_state is returned by the init/1 callback.

The init/1 callback gives an opportunity to perform some initialization tasks just once.

Link to this section Summary

Types

body()
header()
initial_state()
method()
status()
url()

Callbacks

init(opts)

Callback to initialize the given HTTP client.

request(method, url, list, body, opts, initial_state)

Callback to make an HTTP request.

Link to this section Types

Link to this type

body()

View Source

Specs

body() :: binary()
Link to this type

header()

View Source

Specs

header() :: {binary(), binary()}
Link to this type

initial_state()

View Source

Specs

initial_state() :: map()
Link to this type

method()

View Source

Specs

method() :: atom()
Link to this type

status()

View Source

Specs

status() :: non_neg_integer()
Link to this type

url()

View Source

Specs

url() :: binary()

Link to this section Callbacks

Link to this callback

init(opts)

View Source

Specs

init(opts :: keyword()) :: initial_state()

Callback to initialize the given HTTP client.

The returned initial_state needs to be a map and will be given to request/6.

Link to this callback

request(method, url, list, body, opts, initial_state)

View Source

Specs

request(method(), url(), [header()], body(), opts :: keyword(), initial_state()) ::
  {:ok, %{status: status(), headers: [header()], body: body()}}
  | {:error, Exception.t()}

Callback to make an HTTP request.