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 access. Each arbiter can belongs to specific System actor.

Methods

impl Arbiter

pub fn new<T: Into<String>>(name: T) -> Addr<Syn, Arbiter>

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

pub fn name() -> String

Returns current arbiter's address

pub fn arbiter() -> Addr<Unsync, Arbiter>

Returns current arbiter's address

pub fn system() -> Addr<Syn, System>

This function returns system address,

pub fn system_arbiter() -> Addr<Syn, Arbiter>

This function returns system address,

pub fn system_name() -> String

This function returns system name,

pub fn system_registry() -> &'static SystemRegistry

This function returns system registry,

pub fn handle() -> &'static Handle

This function returns current event loop's handle,

pub fn registry() -> &'static Registry

This function returns arbiter's registry,

pub fn start<A, F>(f: F) -> Addr<Syn, 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 Addr<Syn, A> 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) -> Running

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.

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.

impl Handler<StopArbiter> for Arbiter

type Result = ()

The type of value that this handle will return

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

Method is called for every message received by this Actor

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

type Result = Addr<Syn, A>

The type of value that this handle will return

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

Method is called for every message received by this Actor

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

Execute function in arbiter's thread

type Result = Result<I, E>

The type of value that this handle will return

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

Method is called for every message received by this Actor