Struct flo_stream::SinglePublisher

pub struct SinglePublisher<Message> { /* fields omitted */ }

A single publisher is a publisher that sends each message to only a single subscriber rather than all of them

This is useful for scheduling messages on the first available worker.

Implementations

impl<Message> SinglePublisher<Message>

pub fn new(buffer_size: usize) -> SinglePublisher<Message>

Creates a new single publisher, which will buffer the specified number of messages

pub fn count_subscribers(&self) -> usize

Counts the number of subscribers in this publisher

pub fn republish(&self) -> Self

Creates a duplicate publisher that can be used to publish to the same streams as this object

Trait Implementations

impl<Message> Drop for SinglePublisher<Message>

fn drop(&mut self)

Executes the destructor for this type.

impl<Message: 'static + Send> MessagePublisher for SinglePublisher<Message>

fn subscribe(&mut self) -> Subscriber<Message>

Subscribes to this publisher

Subscribers only receive messages sent to the publisher after they are created.

fn when_ready(&mut self) -> BoxFuture<'static, MessageSender<Message>>

Reserves a space for a message with the subscribers, returning when it’s ready

fn when_empty(&mut self) -> BoxFuture<'static, ()>

Waits until all subscribers have consumed all pending messages

fn is_closed(&self) -> bool

Returns true if this publisher is closed (will not publish any further messages to its subscribers)

fn when_closed(&self) -> BoxFuture<'static, ()>

Future that returns when this publisher is closed

type Message = Message

fn publish(&mut self, message: Self::Message) -> BoxFuture<'static, ()>

Publishes a message to the subscribers of this object