Struct stakker::sync::Channel

pub struct Channel<M: Send> { /* private fields */ }

Channel for sending messages to an actor

A Channel may be used to send messages of type M to an actor from any thread. It is an unbounded queue.

Messages are delivered directly to an actor method via a Fwd instance. Cleanup of the channel is handled via a ChannelGuard which should be kept in the same actor. When this is dropped, the channel is closed, and senders are informed via the Channel::send and Channel::is_closed methods. So this handles cleanup automatically when the actor fails or terminates for any reason.

Implementations

impl<M: Send> Channel<M>

pub fn new(core: &mut Core, fwd: Fwd<M>) -> (Self, ChannelGuard)

Create a new channel that directs messages to an actor using the given Fwd instance. Returns the channel and a channel-guard. The Channel may be cloned as many times as necessary and sent to other threads. The ChannelGuard should be kept in the actor that receives the messages.

pub fn send(&self, msg: M) -> bool

Send a message to destination actor in the Stakker thread if the channel is open, and return true. If the channel has been closed, returns false.

pub fn is_closed(&self) -> bool

Tests whether the channel has been closed.

Trait Implementations

impl<M: Send> Clone for Channel<M>

fn clone(&self) -> Self

Get another reference to the same channel

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

Performs copy-assignment from source.