Struct batch_system::mailbox::BasicMailbox[][src]

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

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>[src]

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

pub(crate) fn is_connected(&self) -> bool[src]

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

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

pub fn len(&self) -> usize[src]

pub fn is_empty(&self) -> bool[src]

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

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>>
[src]

Try to send a message to the mailbox.

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

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

Close the mailbox explicitly.

Trait Implementations

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

Auto Trait Implementations

impl<Owner> !RefUnwindSafe for BasicMailbox<Owner>

impl<Owner> Send for BasicMailbox<Owner>

impl<Owner> !Sync for BasicMailbox<Owner>

impl<Owner> Unpin for BasicMailbox<Owner>

impl<Owner> UnwindSafe for BasicMailbox<Owner>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pointable for T[src]

type Init = T

The type for initializers.

impl<T> Same<T> for T[src]

type Output = T

Should always be Self

impl<T> Sealed<T> for T where
    T: ?Sized
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 
[src]