View Source LoggerTelegramBackend.HTTPClient behaviour (logger_telegram_backend v3.0.0-rc.2)

Specifies the API for using a custom HTTP Client.

The default HTTP client is LoggerTelegramBackend.HTTPClient.Finch.

To configure a different HTTP client, implement the LoggerTelegramBackend.HTTPClient behaviour and change the :client configuration:

config :logger, LoggerTelegramBackend,
  client: MyHTTPClient

Summary

Types

HTTP request or response body.

HTTP request or response headers.

HTTP request method.

Options to configure the pool (set via :client_pool_opts).

HTTP request options (set via :client_request_opts).

HTTP response status.

HTTP request URL.

Callbacks

Should return a child specification to start the HTTP client or nil.

Should make an HTTP request to url with the given method, headers and body.

Types

@type body() :: binary()

HTTP request or response body.

@type headers() :: [{String.t(), String.t()}]

HTTP request or response headers.

@type method() :: atom()

HTTP request method.

@type pool_opts() :: Keyword.t()

Options to configure the pool (set via :client_pool_opts).

@type req_opts() :: Keyword.t()

HTTP request options (set via :client_request_opts).

@type status() :: 100..599

HTTP response status.

@type url() :: String.t()

HTTP request URL.

Callbacks

@callback child_spec(pool_opts()) :: Supervisor.child_spec() | nil

Should return a child specification to start the HTTP client or nil.

For example, this can start a pool of HTTP connections dedicated to LoggerTelegramBackend.

Link to this callback

request(method, url, headers, body, req_opts)

View Source
@callback request(method(), url(), headers(), body(), req_opts()) ::
  {:ok, status(), headers(), body()} | {:error, term()}

Should make an HTTP request to url with the given method, headers and body.