Struct actix::prelude::Context

pub struct Context<A> where
    A: Actor<Context = Context<A>>,  { /* fields omitted */ }

Actor execution context

Methods

impl<A> Context<A> where
    A: Actor<Context = Self>, 

pub fn handle(&self) -> SpawnHandle

Handle of the running future

SpawnHandle is the handle returned by AsyncContext::spawn() method.

pub fn set_mailbox_capacity(&mut self, cap: usize)

Set mailbox capacity

By default mailbox capacity is 16 messages.

Trait Implementations

impl<A> ActorContext for Context<A> where
    A: Actor<Context = Self>, 

fn stop(&mut self)

Immediately stop processing incoming messages and switch to a stopping state

fn terminate(&mut self)

Terminate actor execution

fn state(&self) -> ActorState

Actor execution state

impl<A> AsyncContext<A> for Context<A> where
    A: Actor<Context = Self>, 

fn spawn<F>(&mut self, fut: F) -> SpawnHandle where
    F: ActorFuture<Item = (), Error = (), Actor = A> + 'static, 

Spawn async future into context. Returns handle of the item, could be used for cancelling execution.

fn wait<F>(&mut self, fut: F) where
    F: ActorFuture<Item = (), Error = (), Actor = A> + 'static, 

Spawn future into the context. Stop processing any of incoming events until this future resolves.

fn waiting(&self) -> bool

Check if context is paused (waiting for future completion or stopping)

fn cancel_future(&mut self, handle: SpawnHandle) -> bool

Cancel future. idx is a value returned by spawn method.

fn address<Address>(&mut self) -> Address where
    A: ActorAddress<A, Address>, 

Get actor address

fn add_stream<S>(&mut self, fut: S) -> SpawnHandle where
    S: Stream + 'static,
    A: StreamHandler<S::Item, S::Error>, 

This method register stream to an actor context and allows to handle Stream in similar way as normal actor messages.

fn add_message_stream<S>(&mut self, fut: S) where
    S: Stream<Error = ()> + 'static,
    S::Item: Message,
    A: Handler<S::Item>, 

This method is similar to add_stream but it skips stream errors.

fn notify<M>(&mut self, msg: M) where
    A: Handler<M>,
    M: Message + 'static, 

Send message msg to self.

fn notify_later<M>(&mut self, msg: M, after: Duration) -> SpawnHandle where
    A: Handler<M>,
    M: Message + 'static, 

Send message msg to self after specified period of time. Returns spawn handle which could be used for cancellation. Notification get cancelled if context's stop method get called.

fn run_later<F>(&mut self, dur: Duration, f: F) -> SpawnHandle where
    F: FnOnce(&mut A, &mut A::Context) + 'static, 

Execute closure after specified period of time within same Actor and Context. Execution get cancelled if context's stop method get called.

impl<A> Debug for Context<A> where
    A: Actor<Context = Self>, 

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

Formats the value using the given formatter.

impl<A, M> ToEnvelope<Syn, A, M> for Context<A> where
    A: Actor<Context = Context<A>> + Handler<M>,
    M: Message + Send + 'static,
    M::Result: Send, 

fn pack(msg: M, tx: Option<SyncSender<M::Result>>) -> SyncEnvelope<A>

Pack message into suitable envelope