Struct ServerConfigurationHandle 

pub struct ServerConfigurationHandle {
    pub admission: Arc<Mutex<()>>,
    pub pending: Arc<Atomic<bool>>,
    pub fetch: Arc<OnceLock<Arc<dyn ConfigurationFetch>>>,
    /* private fields */
}

The snapshot the client was built with, plus a blocked connection a refresh may set.

Cloning shares both: every consumer sees the blocked connection when a refresh sets it.

Fields

admission: Arc<Mutex<()>>

Serializes the first-request configuration check and explicit refreshes, so one fetch runs at a time.

pending: Arc<Atomic<bool>>

Set while the first-request configuration check has not committed.

fetch: Arc<OnceLock<Arc<dyn ConfigurationFetch>>>

The request adapter’s configuration fetch, once the client binds it.

Implementations

impl ServerConfigurationHandle

pub fn requires_preflight(&self) -> bool

Whether the first-request configuration check is still pending.

pub fn new(provider: Arc<dyn ConfigProvider>) -> ServerConfigurationHandle

Hold one snapshot, with no zero left in its limits or attachment upload ceiling.

Wire conversion replaces a zero on the wire with the compiled default, but a snapshot an app builds in Rust and hands in through a ConfigProvider never passes through that conversion, and a zero dimension would panic the chunks(limit) calls in xmtp_api. Every snapshot reaches a client through this constructor, so sanitizing here keeps zero limits out of all three readers at once: this handle, the wrapper that chunks with them, and the transport. It also removes an unusable attachment offer from a provider snapshot.

pub fn with_chain_restriction( self, custom_verifier: bool, ) -> ServerConfigurationHandle

Restrict app-supplied smart contract wallet signatures to the chains the snapshot names. Skipped entirely when the app supplied its own verifier, which the chain restriction exempts.

pub fn restrict(&self, request: &mut SignatureRequest)

Bind a signature request to the chains this deployment accepts, before it is handed to the app.

pub fn configuration(&self) -> &ServerConfiguration

The snapshot. Fixed for the life of the client: a refresh rewrites the stored row, never this value.

pub fn commit_log_enabled(&self) -> bool

Whether this deployment keeps a commit log. Read at every write and read site, so a deployment that turns it off turns it off for every group this client touches.

pub fn blocked_connection(&self) -> Option<BlockedConnection>

The blocked connection, if one has been observed.

pub fn set_event_writer(&self, writer: Arc<dyn EventWriter>)

Where a blocked connection reports its client event.

pub fn set_deployment_recorder(&self, recorder: DeploymentRecorder)

The record that a fetched deployment identifier is written to.

pub async fn record_deployment( &self, identifier: &str, ) -> Result<(), ServerConfigError>

Record identifier for this client’s backend URL, when a recorder is set.

pub fn check(&self) -> Result<(), BlockedConnection>

Fail when the connection is blocked. Every call that reaches the network goes through here.

pub fn blocked_or<E>(&self, error: E) -> E

where E: From<BlockedConnection>,

Replace a failure with the blocked connection’s error when a block is recorded. A block during an operation, such as the deferred first request check, cancels the client’s streams, so the stopped work would otherwise report a close or an incomplete barrier instead of why.

pub fn block_connection(&self, reason: BlockedConnection) -> BlockedConnection

Block the connection on the first failure. A later one does not displace it: the first cause is the one worth reporting.

Trait Implementations

impl Clone for ServerConfigurationHandle

fn clone(&self) -> ServerConfigurationHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerConfigurationHandle

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

Formats the value using the given formatter.

impl Default for ServerConfigurationHandle

fn default() -> ServerConfigurationHandle

Returns the “default value” for a type.