Struct actix::System

pub struct System { /* fields omitted */ }

System is an actor which manages process.

Before starting any actix's actors, System actor has to be create with System::new() call. This method creates new Arbiter in current thread and starts System actor.

Examples

extern crate actix;

use std::time::Duration;
use actix::prelude::*;

struct Timer {dur: Duration}

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

   // stop system after `self.dur` seconds
   fn started(&mut self, ctx: &mut Context<Self>) {
       ctx.run_later(self.dur, |act, ctx| {
           // send `SystemExit` to `System` actor.
           Arbiter::system().send(msgs::SystemExit(0));
       });
   }
}

fn main() {
   // initialize system
   let sys = System::new("test");

   // Start `Timer` actor
   let _:() = Timer{dur: Duration::new(0, 1)}.start();

   // Run system, this function blocks current thread
   let code = sys.run();
   std::process::exit(code);
}

Methods

impl System

fn new<T: ToString>(name: T) -> SystemRunner

Create new system

Trait Implementations

impl Actor for System

type Context = Context<Self>

Actor execution context type

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

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<SystemExit> for System

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

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.