Struct actix::registry::Registry

pub struct Registry { /* private fields */ }

Actors registry

An Actor can register itself as a service. A Service can be defined as an ArbiterService, which is unique per arbiter, or a SystemService, which is unique per system.

If an arbiter service is used outside of a running arbiter, it panics.

Examples

use actix::prelude::*;

#[derive(Message)]
#[rtype(result = "()")]
struct Ping;

#[derive(Default)]
struct MyActor1;

impl Actor for MyActor1 {
    type Context = Context<Self>;
}
impl actix::Supervised for MyActor1 {}

impl ArbiterService for MyActor1 {
   fn service_started(&mut self, ctx: &mut Context<Self>) {
      println!("Service started");
   }
}

impl Handler<Ping> for MyActor1 {
   type Result = ();

   fn handle(&mut self, _: Ping, ctx: &mut Context<Self>) {
      println!("ping");
   }
}

struct MyActor2;

impl Actor for MyActor2 {
   type Context = Context<Self>;

   fn started(&mut self, _: &mut Context<Self>) {
      // get MyActor1 address from the registry
      let act = MyActor1::from_registry();
      act.do_send(Ping);
   }
}

#[actix::main]
async fn main() {
    // Start MyActor2 in new Arbiter
    Arbiter::new().spawn_fn(|| {
        MyActor2.start();
    });
}

Implementations

impl Registry

pub fn get<A: ArbiterService + Actor<Context = Context<A>>>(&self) -> Addr<A>

👎Deprecated since 0.13.5: Renamed to get_or_start_default().

Queries registry for a type of actor (A), returning its address.

If actor is not registered, a new actor is started and its address is returned.

pub fn get_or_start_default<A: ArbiterService + Actor<Context = Context<A>>>( &self, ) -> Addr<A>

Queries registry for an actor, returning its address.

If actor of type A is not registered, a new actor is started and its address is returned.

pub fn try_get<A: Actor<Context = Context<A>>>(&self) -> Option<Addr<A>>

Queries registry for specific actor, returning its address.

Returns None if an actor of type A is not registered.

pub fn query<A: Actor<Context = Context<A>>>(&self) -> Option<Addr<A>>

Returns actor’s address if it is in the registry.

pub fn set<A: Actor<Context = Context<A>>>(addr: Addr<A>)

Adds an unregistered actor type to the registry by address.

Panics

Panics if actor is already running

Trait Implementations

impl Clone for Registry

fn clone(&self) -> Registry

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.