thinwrap_notifications_httpc (thinwrap_notifications v1.2.0)

View Source

Default transport, built on OTP httpc.

Options (all optional), passed as transport => {thinwrap_notifications_httpc, Opts}:

  • timeout — whole-request budget in milliseconds (default 30000). httpc itself defaults to infinity, so a blackholed connection would otherwise hang the calling process forever.
  • connect_timeout — milliseconds (default: timeout).
  • profile — an httpc profile you started yourself (default: default). The library never starts a profile or any other process.
  • ssl — a complete list of ssl client options. Leave it out: since OTP 26 httpc verifies the peer and its host name against the OS trust store by default, and passing any ssl list replaces those defaults rather than adding to them.

The adapter is HTTPS-only: an http:// (or any other) URL is refused with an invalid_request error instead of being sent in cleartext. A self-hosted endpoint on plain HTTP (a Mattermost or Rocket.Chat on an intranet) needs your own transport. Redirects are never followed.

Summary

Functions

request/2

Send one request with httpc. See the module doc for Opts.

Functions

request/2

-spec request(thinwrap_notifications_transport:request(), map()) ->
                 {ok, thinwrap_notifications_transport:response()} | {error, term()}.

Send one request with httpc. See the module doc for Opts.