Struct conjure_runtime::ClientFactory

pub struct ClientFactory<T = Complete>(/* private fields */);

A factory type which can create clients that will live-reload in response to configuration updates.

Implementations

impl ClientFactory<ConfigStage>

pub fn builder() -> Self

Creates a new builder to construct a client factory.

pub fn config( self, config: Refreshable<ServicesConfig, Error> ) -> ClientFactory<UserAgentStage>

Sets the refreshable configuration used for service clients.

impl ClientFactory<UserAgentStage>

pub fn user_agent(self, user_agent: UserAgent) -> ClientFactory

Sets the user agent sent by clients.

impl ClientFactory

pub fn user_agent(self, user_agent: UserAgent) -> Self

Sets the user agent sent by clients.

pub fn get_user_agent(&self) -> &UserAgent

Returns the configured user agent.

pub fn client_qos(self, client_qos: ClientQos) -> Self

Sets clients’ rate limiting behavior.

Defaults to ClientQos::Enabled.

pub fn get_client_qos(&self) -> ClientQos

Returns the configured rate limiting behavior

pub fn server_qos(self, server_qos: ServerQos) -> Self

Sets clients’ behavior in response to a QoS error from the server.

Defaults to ServerQos::AutomaticRetry.

pub fn get_server_qos(&self) -> ServerQos

Returns the configured QoS behavior.

pub fn service_error(self, service_error: ServiceError) -> Self

Sets clients’ behavior in response to a service error from the server.

Defaults to ServiceError::WrapInNewError.

pub fn get_service_error(&self) -> ServiceError

Returns the configured service error behavior.

pub fn idempotency(self, idempotency: Idempotency) -> Self

Sets clients’ behavior to determine if a request is idempotent or not.

Only idempotent requests will be retried.

Defaults to Idempotency::ByMethod.

pub fn get_idempotency(&self) -> Idempotency

Returns the configured idempotency behavior.

pub fn node_selection_strategy( self, node_selection_strategy: NodeSelectionStrategy ) -> Self

Sets the clients’ strategy for selecting a node for a request.

Defaults to NodeSelectionStrategy::PinUntilError.

pub fn get_node_selection_strategy(&self) -> NodeSelectionStrategy

Returns the configured node selection strategy.

pub fn metrics(self, metrics: Arc<MetricRegistry>) -> Self

Sets the metric registry used to register client metrics.

Defaults to no registry.

pub fn get_metrics(&self) -> Option<&Arc<MetricRegistry>>

Returns the configured metrics registry.

pub fn host_metrics(self, host_metrics: Arc<HostMetricsRegistry>) -> Self

Sets the host metrics registry used to track host performance.

Defaults to no registry.

pub fn get_host_metrics(&self) -> Option<&Arc<HostMetricsRegistry>>

Returns the configured host metrics registry.

pub fn blocking_handle(self, blocking_handle: Handle) -> Self

Returns the Handle to the tokio Runtime to be used by blocking clients.

This has no effect on async clients.

Defaults to a conjure-runtime internal Runtime.

pub fn get_blocking_handle(&self) -> Option<&Handle>

Returns the configured blocking handle.

pub fn client<T>(&self, service: &str) -> Result<T, Error>

where T: AsyncService<Client>,

Creates a new client for the specified service.

The client’s configuration will automatically refresh to track changes in the factory’s ServicesConfig.

If no configuration is present for the specified service in the ServicesConfig, the client will immediately return an error for all requests.

The method can return any type implementing the conjure-http AsyncService trait. This notably includes all Conjure-generated client types as well as the conjure-runtime Client itself.

pub fn blocking_client<T>(&self, service: &str) -> Result<T, Error>

where T: Service<Client>,

Creates a new blocking client for the specified service.

The client’s configuration will automatically refresh to track changes in the factory’s ServicesConfig.

If no configuration is present for the specified service in the ServicesConfig, the client will immediately return an error for all requests.

The method can return any type implementing the conjure-http Service trait. This notably includes all Conjure-generated client types as well as the conjure-runtime blocking::Client itself.

pub fn per_host_clients<T>( &self, service: &str ) -> Result<Refreshable<PerHostClients<T>, Error>, Error>

where T: AsyncService<Client> + 'static + Sync + Send,

Creates a refreshable collection of clients, each corresponding to a separate replica of the service.

Note

The client type T is assumed to be stateless - each instance will be recreated on every refresh.

pub fn blocking_per_host_clients<T>( &self, service: &str ) -> Result<Refreshable<PerHostClients<T>, Error>, Error>

where T: Service<Client> + 'static + Sync + Send,

Creates a refreshable collection of blocking clients, each corresponding to a separate replica of the service.

Note

The client type T is assumed to be stateless - each instance will be recreated on every refresh.

Trait Implementations

impl<T: Clone> Clone for ClientFactory<T>

fn clone(&self) -> ClientFactory<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ClientFactory<ConfigStage>

fn default() -> Self

Returns the “default value” for a type.