Struct glommio::channels::sharding::Sharded

pub struct Sharded<T: Send, H> { /* fields omitted */ }

The public interface for sharding

Implementations

impl<T: Send + 'static, H: Handler<T> + 'static> Sharded<T, H>

pub async fn new(
    mesh: FullMesh<T>,
    shard_fn: ShardFn<T>,
    handler: H
) -> Result<Self, ()>

Join a full mesh for sharding

pub fn nr_shards(&self) -> usize

Returns the total number of shards

pub fn shard_id(&self) -> usize

Returns the shard_id associated with ourselves

pub fn handle<S: Stream<Item = T> + Unpin + 'static>(
    &mut self,
    messages: S
) -> Result<(), S>

Consume messages from a stream. It will return a GlommioError::Closed if this Sharded is closed. Otherwise, the function will return immediately after spawning a background task draining messages from the stream.

pub async fn send_to(&mut self, dst_shard: usize, message: T) -> Result<(), T>

Sends an individual message to a given shard.

This functions returns GlommioError::Closed if this Sharded is closed, or InvalidInput if the destination id is invalid.

This function ignores the sharding function.

pub async fn send(&self, message: T) -> Result<(), T>

Sends an individual message to the correct shard.

The correct shard is calculated using the sharding function in this Sharded object.

This functions returns GlommioError::Closed if this Sharded is closed.

pub async fn close(&mut self)

Close this Sharded and wait for all existing background tasks to finish. No more consuming task will be spawned, but incoming messages from the streams consumed by existing back ground tasks will not be rejected. So it would be important to truncate the streams from upstream before calling this method to prevent it from hanging.

Trait Implementations

impl<T: Send, H> Debug for Sharded<T, H>

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

Formats the value using the given formatter.