Struct actix::FramedContext

pub struct FramedContext<A> where
    A: FramedActor + Actor<Context = FramedContext<A>>,
    A: StreamHandler<<<A as FramedActor>::Codec as Decoder>::Item, <<A as FramedActor>::Codec as Decoder>::Error>,
    <<A as FramedActor>::Codec as Decoder>::Item: ResponseType,  { /* fields omitted */ }

Actor execution context for Framed object

Methods

impl<A> FramedContext<A> where
    A: Actor<Context = Self> + FramedActor,
    A: StreamHandler<<<A as FramedActor>::Codec as Decoder>::Item, <<A as FramedActor>::Codec as Decoder>::Error>,
    <<A as FramedActor>::Codec as Decoder>::Item: ResponseType, 

fn send(
    &mut self,
    msg: <<A as FramedActor>::Codec as Encoder>::Item
) -> Result<(), <<A as FramedActor>::Codec as Encoder>::Item>

Send item to sink. If sink is closed item returned as an error.

fn close(&mut self)

Gracefully close Framed object. FramedContext will try to send all buffered items and then close. FramedContext::stop() could be used to force stop sending process.

Trait Implementations

impl<A, M> ToEnvelope<A, M> for FramedContext<A> where
    M: ResponseType + Send + 'static,
    A: FramedActor + Actor<Context = FramedContext<A>> + Handler<M>,
    A: StreamHandler<<<A as FramedActor>::Codec as Decoder>::Item, <<A as FramedActor>::Codec as Decoder>::Error>,
    <<A as FramedActor>::Codec as Decoder>::Item: ResponseType,
    M::Item: Send,
    M::Error: Send, 

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

Pack message into envelope

impl<A> ActorContext<A> for FramedContext<A> where
    A: Actor<Context = Self> + FramedActor,
    A: StreamHandler<<<A as FramedActor>::Codec as Decoder>::Item, <<A as FramedActor>::Codec as Decoder>::Error>,
    <<A as FramedActor>::Codec as Decoder>::Item: ResponseType, 

fn stop(&mut self)

Stop actor execution

This method closes actor address and framed object.

fn terminate(&mut self)

Terminate actor execution

fn state(&self) -> ActorState

Actor execution state

fn alive(&self) -> bool

Check if execution context is alive

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

Get actor address

impl<A> AsyncContext<A> for FramedContext<A> where
    A: Actor<Context = Self> + FramedActor,
    A: StreamHandler<<<A as FramedActor>::Codec as Decoder>::Item, <<A as FramedActor>::Codec as Decoder>::Error>,
    <<A as FramedActor>::Codec as Decoder>::Item: ResponseType, 

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 cancel_future(&mut self, handle: SpawnHandle) -> bool

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

fn add_future<F>(&mut self, fut: F) where
    F: Future + 'static,
    F::Item: ResponseType,
    A: Handler<F::Item, F::Error>, 

This method allow to handle Future in similar way as normal actor messages.

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

This method is similar to add_future but works with streams.

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

Send message msg to self after specified period of time. Returns spawn handle which could be used for cancelation.

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

impl<A> AsyncContextApi<A> for FramedContext<A> where
    A: Actor<Context = Self> + FramedActor,
    A: StreamHandler<<<A as FramedActor>::Codec as Decoder>::Item, <<A as FramedActor>::Codec as Decoder>::Error>,
    <<A as FramedActor>::Codec as Decoder>::Item: ResponseType, 

fn address_cell(&mut self) -> &mut ActorAddressCell<A>

impl<A> Debug for FramedContext<A> where
    A: Actor<Context = Self> + FramedActor,
    A: StreamHandler<<<A as FramedActor>::Codec as Decoder>::Item, <<A as FramedActor>::Codec as Decoder>::Error>,
    <<A as FramedActor>::Codec as Decoder>::Item: ResponseType, 

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

Formats the value using the given formatter.