Struct actix::Arbiter

pub struct Arbiter { /* fields omitted */ }

Event loop controller

Arbiter controls event loop in it's thread. Each arbiter runs in separate thread. Arbiter provides several api for event loop acces. Each arbiter can belongs to specific System actor.

Methods

impl Arbiter

fn new<T: ToString>(name: T) -> SyncAddress<Arbiter>

Spawn new thread and run event loop in spawned thread. Returns address of newly created arbiter.

fn name() -> String

Returns current arbiter's address

fn arbiter() -> Address<Arbiter>

Returns current arbiter's address

fn system() -> SyncAddress<System>

This function returns system address,

fn system_arbiter() -> SyncAddress<Arbiter>

This function returns system address,

fn system_name() -> String

This function returns system name,

fn system_registry() -> &'static SystemRegistry

This function returns system registry,

fn handle() -> &'static Handle

This function returns current event loop's handle,

fn registry() -> &'static Registry

This function returns arbiter's registry,

fn start<A, F>(f: F) -> SyncAddress<A> where
    A: Actor<Context = Context<A>>,
    F: FnOnce(&mut A::Context) -> A + Send + 'static, 

Start new arbiter and then start actor in created arbiter. Returns SyncAddress of created actor.

Trait Implementations

impl Actor for Arbiter

type Context = Context<Self>

Actor execution context type

fn started(&mut self, ctx: &mut Context<Self>)

Method is called when actor get polled first time.

fn stopping(&mut self, ctx: &mut Self::Context)

Method is called after an actor is in Actor::Stopping state. There could be several reasons for stopping. Context::stop get called by the actor itself. All addresses to current actor get dropped and no more evented objects left in the context. Actor could restore from stopping state to running state by creating new address or adding future or stream to current content.

fn stopped(&mut self, ctx: &mut Self::Context)

Method is called after an actor is stopped, it can be used to perform any needed cleanup work or spawning more actors. This is final state, after this call actor get dropped.

fn start<Addr>(self) -> Addr where
    Self: Actor<Context = Context<Self>> + ActorAddress<Self, Addr>, 

Start new asynchronous actor, returns address of newly created actor.

fn start_default<Addr>() -> Addr where
    Self: Default + Actor<Context = Context<Self>> + ActorAddress<Self, Addr>, 

Start new asynchronous actor, returns address of newly created actor.

fn create<Addr, F>(f: F) -> Addr where
    Self: Actor<Context = Context<Self>> + ActorAddress<Self, Addr>,
    F: FnOnce(&mut Context<Self>) -> Self + 'static, 

Use create method, if you need Context object during actor initialization.

fn reply<M>(val: M::Item) -> Response<Self, M> where
    M: ResponseType, 

Create static response.

fn async_reply<T, M>(fut: T) -> Response<Self, M> where
    M: ResponseType,
    T: ActorFuture<Item = M::Item, Error = M::Error, Actor = Self> + Sized + 'static, 

Create async response process.

fn empty<M>() -> Response<Self, M> where
    M: ResponseType<Item = ()>, 

Create unit response, for case when ResponseType::Item = ()

fn reply_error<M>(err: M::Error) -> Response<Self, M> where
    M: ResponseType, 

Create error response

impl Handler<StopArbiter> for Arbiter

fn handle(
    &mut self,
    msg: StopArbiter,
    _: &mut Context<Self>
) -> Response<Self, StopArbiter>

Method is called for every message received by this Actor

fn error(&mut self, err: E, ctx: &mut Self::Context)

Method is called on error. By default it does nothing.

impl<A> Handler<StartActor<A>> for Arbiter where
    A: Actor<Context = Context<A>>, 

fn handle(
    &mut self,
    msg: StartActor<A>,
    _: &mut Context<Self>
) -> Response<Self, StartActor<A>>

Method is called for every message received by this Actor

fn error(&mut self, err: E, ctx: &mut Self::Context)

Method is called on error. By default it does nothing.

impl<I: Send, E: Send> Handler<Execute<I, E>> for Arbiter

Execute function in arbiter's thread

fn handle(
    &mut self,
    msg: Execute<I, E>,
    _: &mut Context<Self>
) -> Response<Self, Execute<I, E>>

Method is called for every message received by this Actor

fn error(&mut self, err: E, ctx: &mut Self::Context)

Method is called on error. By default it does nothing.