Struct tiny_actor::channel::Channel

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

Contains all data that should be shared between Addresses, Inboxes and the Child.

Implementations

impl<M> Channel<M>

pub fn try_recv(&self, signaled_halt: &mut bool) -> Result<Option<M>, RecvError>

This will attempt to receive a message from the Inbox. If there is no message, this will return None.

pub fn recv<'a>(
    &'a self,
    signaled_halt: &'a mut bool,
    listener: &'a mut Option<EventListener>
) -> Rcv<'a, M>

Wait until there is a message in the Inbox.

impl<M> Channel<M>

pub fn send(&self, msg: M) -> Snd<'_, M>

pub fn send_now(&self, msg: M) -> Result<(), TrySendError<M>>

pub fn try_send(&self, msg: M) -> Result<(), TrySendError<M>>

pub fn send_blocking(&self, msg: M) -> Result<(), SendError<M>>

Trait Implementations

impl<M: Send + 'static> AnyChannel for Channel<M>

fn into_any(self: Arc<Self>) -> Arc<dyn Any + Send + Sync>

impl<M> Debug for Channel<M>

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

Formats the value using the given formatter.

impl<M> DynChannel for Channel<M>

fn close(&self) -> bool

Close the channel. Returns true if the channel was not closed before this. Otherwise, this returns false.

Notifies

• if true -> all send_listeners & recv_listeners

fn halt_some(&self, n: u32)

Halt n inboxes associated with this channel. If n >= #inboxes, all inboxes will be halted. This might leave halt-count > inbox-count, however that’s not a problem. If n > i32::MAX, n = i32::MAX.

Notifies

• n recv-listeners

fn inbox_count(&self) -> usize

Returns the amount of inboxes this channel has.

fn msg_count(&self) -> usize

Returns the amount of messages currently in the channel.

fn address_count(&self) -> usize

Returns the amount of addresses this channel has.

fn is_closed(&self) -> bool

Whether the queue asscociated to the channel has been closed.

fn capacity(&self) -> &Capacity

Capacity of the inbox.

fn has_exited(&self) -> bool

Whether all inboxes linked to this channel have exited.

fn add_address(&self) -> usize

Add an Address to the channel, incrementing address-count by 1. Afterwards, a new Address may be created from this channel.

Returns the previous inbox-count

fn remove_address(&self) -> usize

Remove an Address from the channel, decrementing address-count by 1. This should be called from the destructor of the Address.

Notifies

• prev-address-count == 1 -> all send_listeners & recv_listeners

Panics

• prev-address-count == 0

fn actor_id(&self) -> u64

Get the actor_id.

fn is_bounded(&self) -> bool

Whether the channel is bounded.

fn get_exit_listener(&self) -> EventListener

fn halt(&self)