oidcc_http_util (Oidcc v3.8.0)

HTTP Client Utilities

Summary

Types

error()

http_header()

HTTP header representation used by OIDCC.

httpc_error()

Transport error. The default adapter returns errors documented by httpc:request/5.

query_params()

See uri_string:compose_query/1.

request_opts()

See httpc:request/5.

telemetry_opts()

Functions

headers_to_cache_deadline(Headers, DefaultExpiry)

Types

error()

(since 3.0.0)

-type error() ::
          {http_error, StatusCode :: non_neg_integer(), HttpBodyResult :: binary() | map()} |
          {use_dpop_nonce, Nonce :: binary(), HttpBodyResult :: binary() | map()} |
          invalid_content_type |
          httpc_error().

http_header()

(since 3.0.0)

-type http_header() :: {Field :: [byte()] | binary(), Value :: iodata()}.

HTTP header representation used by OIDCC.

httpc_error()

(since 3.0.0)

-type httpc_error() :: term().

Transport error. The default adapter returns errors documented by httpc:request/5.

query_params()

(since 3.0.0)

-type query_params() :: [{unicode:chardata(), unicode:chardata() | true}].

See uri_string:compose_query/1.

request_opts()

(since 3.0.0)

-type request_opts() ::
          #{timeout => timeout(),
            ssl => [ssl:tls_option()],
            httpc_profile => atom() | pid(),
            http_adapter => oidcc_http_adapter:config()}.

See httpc:request/5.

Parameters

timeout - timeout for request
ssl - TLS config
httpc_profile - httpc profile used by the default adapter
http_adapter - {AdapterModule, AdapterConfigMap} transport adapter

telemetry_opts()

(since 3.0.0)

-type telemetry_opts() :: #{topic := [atom()], extra_meta => map()}.

Functions

headers_to_cache_deadline(Headers, DefaultExpiry)

-spec headers_to_cache_deadline(Headers, DefaultExpiry) -> pos_integer()
                                   when
                                       Headers :: [oidcc_http_adapter:header()],
                                       DefaultExpiry :: non_neg_integer().