xclient v0.7.0-vendored-xhttp XClient.Pool View Source

XClient.Pool provides an HTTP 1.x request connection pool based on XClient and Poolboy.

Example:

>>>> children = [XClient.Pool.child_spec(MyPool)]
>>>> {:ok, _pid} = Supervisor.start_link(children, strategy: :one_for_one)
>>>> XClient.Pool.request(MyPool, :get, "http://example.com")
{:ok, %XClient.Response{...}}

Link to this section Summary

Functions

child_spec(name, opts \\ [])

Returns a child spec suitable to pass to e.g., Supervisor.start_link/2

request(pool, method, url, headers \\ [], payload \\ "", opts \\ [])

Makes an HTTP 1.x request using an existing connection pool

Link to this section Functions

child_spec(name, opts \\ [])

Returns a child spec suitable to pass to e.g., Supervisor.start_link/2.

Options:

:size sets the initial pool size. Default is 10.
:max_overflow sets the maximum number of additional connections under high load. Default is 5.
:strategy sets the pool connection-grabbing strategy. Valid values are :fifo and :lifo (default).

The :size and :max_overflow options are passed to Poolboy.

request(pool, method, url, headers \\ [], payload \\ "", opts \\ [])

request(
  pid(),
  XClient.method(),
  String.t(),
  XClient.headers(),
  String.t(),
  Keyword.t()
) :: {:ok, XClient.response()} | {:error, XClient.error()}

Makes an HTTP 1.x request using an existing connection pool.

Options:

:timeout - Response timeout in milliseconds. Defaults to Application.get_env(:xclient, :request_timeout, 5000).