Struct Client 

pub struct Client {
    inner: Arc<RwLock<ClientInner>>,
    shutdown: CancellationToken,
    run_active: Arc<AtomicBool>,
}

Centrifugo realtime client with auto-reconnect; clones share state.

Fields

inner: Arc<RwLock<ClientInner>>

shutdown: CancellationToken

run_active: Arc<AtomicBool>

Implementations

impl Client

pub async fn subscribe( &self, config: SubscriptionConfig, ) -> Result<Subscription, Error>

Registers a subscription and starts it immediately when connected.

Errors

Returns an error if the channel is already subscribed or the server rejects the subscribe command.

pub async fn unsubscribe(&self, channel: &str) -> Result<(), Error>

Removes the subscription for channel from the server and client.

Errors

Returns an error if the client is disconnected or the command fails.

pub async fn presence(&self, channel: &str) -> Result<PresenceResult, Error>

Queries presence information for channel.

Errors

Returns an error if the client is disconnected or the command fails.

pub async fn presence_stats( &self, channel: &str, ) -> Result<PresenceStats, Error>

Queries aggregate presence statistics for channel.

Errors

Returns an error if the client is disconnected or the command fails.

pub async fn history( &self, channel: &str, limit: i32, since: Option<StreamPosition>, reverse: bool, ) -> Result<HistoryResult, Error>

Queries publication history for channel.

Errors

Returns an error if the client is disconnected or the command fails.

pub async fn publish(&self, channel: &str, data: Vec<u8>) -> Result<(), Error>

Publishes data to channel.

Errors

Returns an error if the client is disconnected or the command fails.

pub async fn rpc(&self, method: &str, data: Vec<u8>) -> Result<RpcResult, Error>

Calls the named server RPC method.

Errors

Returns an error if the client is disconnected or the command fails.

pub async fn send(&self, data: Vec<u8>) -> Result<(), Error>

Sends asynchronous data to the server without publishing it.

Errors

Returns an error if the client is disconnected or the command fails.

pub async fn sub_refresh( &self, channel: &str, token: &str, ) -> Result<SubRefreshResult, Error>

Refreshes the subscription token for channel.

Errors

Returns an error if the client is disconnected or the command fails.

pub fn disconnect(&self)

Stops the background connection loop and closes the active transport.

pub(super) async fn subscribe_internal( &self, channel: &str, ) -> Result<SubscribeResult, Error>

async fn send_extract<P, T>( &self, cmd: Command, label: &'static str, extract: impl FnOnce(Reply) -> Option<P>, ) -> Result<T, Error>

where P: Into<T>,

async fn send_void(&self, cmd: Command) -> Result<(), Error>

async fn send_command(&self, cmd: Command) -> Result<Reply, Error>

impl Client

pub(super) async fn handle_reply( &self, reply: Reply, transport: &mut Transport, ) -> Result<Option<DisconnectAdvice>, Error>

pub(super) async fn build_recovery_subs( &self, ) -> FastMap<String, SubscribeRequest>

pub(super) async fn process_server_subs( &self, subs: impl IntoIterator<Item = (String, SubscribeResult)>, )

pub(super) async fn resubscribe_all(&self)

async fn handle_push(&self, push: Push) -> Option<DisconnectAdvice>

async fn handle_push_publication(&self, channel: &str, pub_: Publication)

async fn handle_push_unsubscribe(&self, channel: &str, unsub: Unsubscribe)

impl Client

pub fn new(config: ClientConfig) -> Self

Creates a disconnected client with shared connection state.

pub async fn events(&self) -> Receiver<ClientEvent>

Replaces the client event receiver and returns the new receiver; install before Self::connect.

pub async fn state(&self) -> ClientState

Returns the current connection lifecycle state.

pub async fn is_connected(&self) -> bool

Returns whether the client completed the Centrifugo handshake.

pub fn connect(&self)

Spawns a background task that maintains the connection with auto-reconnect.

pub async fn run(&self)

Maintains the connection and reconnects until Self::disconnect is called.

async fn emit_client_event(&self, event: ClientEvent)

async fn emit_subscription_event(&self, channel: &str, event: SubscriptionEvent)

async fn connection_config(&self) -> Result<Option<ClientConfig>, Error>

async fn establish_connection( &self, config: &ClientConfig, ) -> Result<(Transport, ConnectResult), Error>

async fn connect_and_run(&self) -> Result<ConnectionExit, Error>

async fn begin_refresh( &self, transport: &mut Transport, ) -> Result<Option<PendingRefresh>, Error>

async fn finish_refresh( &self, refresh: PendingRefresh, reply: Reply, ) -> Result<Option<Instant>, Error>

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.