Struct RcClientConfiguration 

pub struct RcClientConfiguration {
    pub kind: ClientKind,
    pub poll_interval: Duration,
    pub max_backoff: Duration,
    pub request_timeout: Duration,
}

Settings for a RemoteConfigurationClient.

Rc abbreviates Remote Configuration, which avoids the repetition in RemoteConfigurationClientConfiguration.

Start from new, which takes the kind of client to report and uses the standard schedule, and change fields as needed. validate checks the values, and RemoteConfigurationClient::new rejects invalid settings.

Whatever the settings, the worker polls once immediately when it starts, and retries every second until its first successful poll. The exception is an Agent that answers that Remote Configuration is not enabled: the worker then waits max_backoff between attempts, first success or not.

Fields

kind: ClientKind

The kind of client the Agent sees, and the details it reports in every poll.

Has no default.

poll_interval: Duration

How long the worker waits between successful polls.

Shorter intervals deliver changes sooner at the cost of more requests to the Agent. The Agent refreshes from the backend far less often than this, so lowering it rarely helps. Must be at least one second.

Defaults to 5 seconds.

max_backoff: Duration

The longest the worker waits between polls while polls are failing.

After consecutive failures the wait doubles, with jitter, from poll_interval up to this ceiling, and resets on the next success. The worker also waits this long between attempts when the Agent has remote configuration disabled. Must be at least poll_interval.

Defaults to 90 seconds.

request_timeout: Duration

How long the worker waits for the Agent to answer one poll.

A poll that runs out of time is abandoned and handled like any other failed poll, so a stuck connection cannot stall delivery indefinitely. The Agent may hold the first poll from a new client for up to about two seconds while it fetches from the backend, so this must stay well above that. Must be at least one second.

Defaults to 30 seconds.

Implementations

impl RcClientConfiguration

pub fn new(kind: ClientKind) -> Self

Creates settings for a client that reports itself as kind, with the standard schedule.

pub fn validate(&self) -> Result<()>

Checks that the settings are valid.

Errors

Returns Error::InvalidSettings if an agent’s name or version is empty, poll_interval is shorter than one second, max_backoff is shorter than poll_interval, or request_timeout is shorter than one second. The fields are checked in that order, and the error describes the first that fails.

Trait Implementations

impl Clone for RcClientConfiguration

fn clone(&self) -> RcClientConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RcClientConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.