Struct CoordinatorServiceClient 

pub struct CoordinatorServiceClient<Stub = Channel<CoordinatorServiceRequest, CoordinatorServiceResponse>>(/* private fields */);

The client stub that makes RPC calls to the server. All request methods return Futures.

Implementations

impl CoordinatorServiceClient

pub fn new<T>( config: Config, transport: T, ) -> NewClient<Self, RequestDispatch<CoordinatorServiceRequest, CoordinatorServiceResponse, T>>

where T: Transport<ClientMessage<CoordinatorServiceRequest>, Response<CoordinatorServiceResponse>>,

Returns a new client stub that sends requests over the given transport.

impl<Stub> CoordinatorServiceClient<Stub>

where Stub: Stub<Req = CoordinatorServiceRequest, Resp = CoordinatorServiceResponse>,

pub fn register( &self, ctx: Context, info: ShardInfo, ) -> impl Future<Output = Result<RpcResult<ShardId>, RpcError>> + '_

Register a new shard with the coordinator.

Returns the assigned shard ID. The coordinator will include this shard in subsequent tick coordination.

pub fn unregister( &self, ctx: Context, shard_id: ShardId, ) -> impl Future<Output = Result<RpcResult<()>, RpcError>> + '_

Unregister a shard from the coordinator.

Should be called during graceful shutdown. The coordinator will stop routing requests to this shard.

pub fn phase_complete( &self, ctx: Context, shard_id: ShardId, phase: TickPhase, tick: u64, ) -> impl Future<Output = Result<RpcResult<()>, RpcError>> + '_

Report that a shard has completed a tick phase.

Used for barrier synchronization. The coordinator tracks completion across all shards before advancing to the next phase.

pub fn route_document( &self, ctx: Context, doc_id: DocumentId, ) -> impl Future<Output = Result<ShardId, RpcError>> + '_

Get the shard responsible for a document.

Uses consistent hashing to determine which shard owns a document.

pub fn route_node( &self, ctx: Context, node_id: NodeId, ) -> impl Future<Output = Result<ShardId, RpcError>> + '_

Get the shard responsible for a node.

Uses consistent hashing based on node ID.

pub fn get_global_df( &self, ctx: Context, terms: Vec<String>, ) -> impl Future<Output = Result<RpcResult<HashMap<String, u64>>, RpcError>> + '_

Get global document frequencies for TF-IDF.

Returns aggregated term frequencies across all shards.

pub fn barrier_ready( &self, ctx: Context, shard_id: ShardId, phase: TickPhase, tick: u64, ) -> impl Future<Output = Result<RpcResult<bool>, RpcError>> + '_

Signal ready for next phase (barrier).

Returns true when all shards are ready and the phase can proceed.

pub fn current_tick( &self, ctx: Context, ) -> impl Future<Output = Result<u64, RpcError>> + '_

Get current tick number.

Returns the global tick counter maintained by the coordinator.

pub fn list_shards( &self, ctx: Context, ) -> impl Future<Output = Result<Vec<ShardInfo>, RpcError>> + '_

Get all registered shards.

Returns information about all shards in the cluster.

pub fn start_tick( &self, ctx: Context, ) -> impl Future<Output = Result<RpcResult<u64>, RpcError>> + '_

Request to start a new tick.

Only succeeds if no tick is currently in progress.

pub fn tick_status( &self, ctx: Context, ) -> impl Future<Output = Result<RpcResult<TickStatus>, RpcError>> + '_

Get the status of the current tick.

Returns the current phase and which shards have completed it.

Trait Implementations

impl<Stub: Clone> Clone for CoordinatorServiceClient<Stub>

fn clone(&self) -> CoordinatorServiceClient<Stub>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Stub: Debug> Debug for CoordinatorServiceClient<Stub>

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

Formats the value using the given formatter.

impl<Stub> From<Stub> for CoordinatorServiceClient<Stub>

where Stub: Stub<Req = CoordinatorServiceRequest, Resp = CoordinatorServiceResponse>,

fn from(stub: Stub) -> Self

Returns a new client stub that sends requests over the given transport.