Struct NomadClient 

pub struct NomadClient<S: SyncState> { /* private fields */ }

Available on crate feature client only.

A NOMAD protocol client.

Generic over state type S which must implement SyncState.

Example

use nomad_protocol::client::{NomadClient, NomadClientBuilder};

let config = NomadClientBuilder::new()
    .server_addr("127.0.0.1:19999".parse()?)
    .server_public_key(server_pubkey)
    .build();

let (client, state_rx) = NomadClient::<MyState>::connect(config, initial_state).await?;

// Send state updates
client.update_state(new_state).await?;

// Receive server state updates
while let Some(server_state) = state_rx.recv().await {
    // Handle server state
}

Implementations

impl<S: SyncState> NomadClient<S>

pub async fn connect( config: ClientConfig, initial_state: S, ) -> Result<(Self, StateReceiver<S>), ClientError>

Connect to a NOMAD server.

Returns the client handle and a receiver for server state updates.

pub async fn client_state(&self) -> ClientState

Get the current client state.

pub async fn local_state(&self) -> S

Get a copy of the current local state.

pub async fn update_state(&self, new_state: S) -> Result<(), ClientError>

Update the local state.

This queues the state for synchronization with the server.

pub fn state_sender(&self) -> StateSender<S>

Get a sender handle for state updates.

This can be cloned and used from multiple tasks.

pub async fn is_connected(&self) -> bool

Check if the client is connected.

pub async fn disconnect(self) -> Result<(), ClientError>

Gracefully disconnect from the server.

pub fn server_addr(&self) -> SocketAddr

Get the server address.

Trait Implementations

impl<S: SyncState> Drop for NomadClient<S>

fn drop(&mut self)

Executes the destructor for this type.