Struct batch_system::BasicMailbox

[+] Show declaration

pub struct BasicMailbox<Owner: Fsm> {
    sender: LooseBoundedSender<Owner::Message>,
    state: Arc<FsmState<Owner>>,
}

[−] Expand description

A basic mailbox.

Every mailbox should have one and only one owner, who will receive all messages sent to this mailbox.

When a message is sent to a mailbox, its owner will be checked whether it’s idle. An idle owner will be scheduled via FsmScheduler immediately, which will drive the fsm to poll for messages.

Fields

sender: LooseBoundedSender<Owner::Message>

state: Arc<FsmState<Owner>>

Implementations

impl<Owner: Fsm> BasicMailbox<Owner>[−]

pub fn new(
    sender: LooseBoundedSender<Owner::Message>,
    fsm: Box<Owner>,
    state_cnt: Arc<AtomicUsize>
) -> BasicMailbox<Owner>

pub(crate) fn is_connected(&self) -> bool

pub(crate) fn release(&self, fsm: Box<Owner>)

pub(crate) fn take_fsm(&self) -> Option<Box<Owner>>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn force_send<S: FsmScheduler<Fsm = Owner>>(
    &self,
    msg: Owner::Message,
    scheduler: &S
) -> Result<(), SendError<Owner::Message>>[−]

Force sending a message despite the capacity limit on channel.

pub fn try_send<S: FsmScheduler<Fsm = Owner>>(
    &self,
    msg: Owner::Message,
    scheduler: &S
) -> Result<(), TrySendError<Owner::Message>>[−]

Try to send a message to the mailbox.

If there are too many pending messages, function may fail.

pub(crate) fn close(&self)[−]

Close the mailbox explicitly.

Trait Implementations

impl<Owner: Fsm> Clone for BasicMailbox<Owner>[+]

[+] Show hidden undocumented items

fn clone(&self) -> BasicMailbox<Owner>[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.