Skip to main content

Module client

Module client 

Source
Expand description

The client, its builder, the account-scoped client and the request pipeline they share: hooks, credentials, retries, redirects and the response cache.

Structs§

AccountClient
A client scoped to one account: every path it sends starts with the account id. Made with Client::for_account.
Client
A Fizzy client: one set of credentials on one origin. Most of the API is scoped to an account, reached with Client::for_account; what is not — sessions, identity, access tokens — hangs off the client itself.
ClientBuilder
Builds a Client.
RequestOptions
How a raw call is sent, where the defaults are not what the caller wants.
Response
What came back from Fizzy, before it is decoded.
Scope
What a generated service sends through: the client, and the account when there is one.

Constants§

DEFAULT_BASE_DELAY
The first backoff for a raw call.
DEFAULT_MAX_ATTEMPTS
How many times a raw call is sent, the first attempt included, and the ceiling on what a modelled route may ask for. Three, as the behavior model gives every retried operation and as the Go client counts its MaxRetries.
DEFAULT_MAX_DELAY
The longest the client waits between attempts, however many it has made. The backoff’s job is to stop hammering, and thirty seconds does it; a caller who raised the retry count would otherwise be waiting minutes on a server that is not coming back. Move it with ClientBuilder::max_delay.
DEFAULT_MAX_JITTER
The most random time added to a backoff.
DEFAULT_MAX_PAGES
How many pages a walk reads before stopping.
DEFAULT_MAX_RESPONSE_BODY_BYTES
The most of an answer the client holds in memory.
DEFAULT_MAX_RETRY_AFTER
The longest Retry-After the client sits out. Past it the answer is handed back as the rate-limit error it is, with the wait in the hint, rather than the call blocking for an hour. Move it with ClientBuilder::max_retry_after.
DEFAULT_TIMEOUT
How long the shipped HTTP client gives an answer to arrive.