Struct riker::actors::ActorSystem

pub struct ActorSystem {
    pub exec: ThreadPool,
    pub timer: Sender<Job>,
    pub sys_channels: Option<SysChannels>,
    // some fields omitted
}

The actor runtime and common services coordinator

The ActorSystem provides a runtime on which actors are executed. It also provides common services such as channels, persistence and scheduling. The ActorSystem is the heart of a Riker application, starting serveral threads when it is created. Create only one instance of ActorSystem per application.

Fields

exec: ThreadPool

timer: Sender<Job>

sys_channels: Option<SysChannels>

Methods

impl ActorSystem

pub fn new() -> Result<ActorSystem, SystemError>

Create a new ActorSystem instance

Requires a type that implements the Model trait.

pub fn with_name(name: &str) -> Result<ActorSystem, SystemError>

Create a new ActorSystem instance with provided name

Requires a type that implements the Model trait.

pub fn with_config(name: &str, cfg: Config) -> Result<ActorSystem, SystemError>

Create a new ActorSystem instance bypassing default config behavior

pub fn start_date(&self) -> &DateTime<Utc>

Returns the system start date

pub fn uptime(&self) -> u64

Returns the number of seconds since the system started

pub fn host(&self) -> Arc<String>

Returns the hostname used when the system started

The host is used in actor addressing.

Currently not used, but will be once system clustering is introduced.

pub fn id(&self) -> Uuid

Returns the UUID assigned to the system

pub fn name(&self) -> String

Returns the name of the system

pub fn print_tree(&self)

pub fn user_root(&self) -> &BasicActorRef

Returns the user root actor reference

pub fn sys_root(&self) -> &BasicActorRef

Returns the system root actor reference

pub fn temp_root(&self) -> &BasicActorRef

Reutrns the temp root actor reference

pub fn sys_events(&self) -> &ActorRef<ChannelMsg<SystemEvent>>

Returns a reference to the system events channel

pub fn dead_letters(&self) -> &ActorRef<DLChannelMsg>

Returns a reference to the dead letters channel

pub fn publish_event(&self, evt: SystemEvent)

pub fn config(&self) -> Config

Returns the Config used by the system

pub fn sys_actor_of<A>(
    &self,
    props: BoxActorProd<A>,
    name: &str
) -> Result<ActorRef<A::Msg>, CreateError> where
    A: Actor, 

Create an actor under the system root

pub fn shutdown(&self) -> Receiver<()>

Shutdown the actor system

Attempts a graceful shutdown of the system and all actors. Actors will receive a stop message, executing actor.post_stop.

Does not block. Returns a future which is completed when all actors have successfully stopped.

Trait Implementations

impl ActorRefFactory for ActorSystem

fn actor_of<A>(
    &self,
    props: BoxActorProd<A>,
    name: &str
) -> Result<ActorRef<A::Msg>, CreateError> where
    A: Actor, 

fn stop(&self, actor: impl ActorReference)

impl TmpActorRefFactory for ActorSystem

fn tmp_actor_of<A>(
    &self,
    props: BoxActorProd<A>
) -> Result<ActorRef<A::Msg>, CreateError> where
    A: Actor, 

impl ActorSelectionFactory for ActorSystem

fn select(&self, path: &str) -> Result<ActorSelection, InvalidPath>

impl Run for ActorSystem

fn run<Fut>(
    &self,
    future: Fut
) -> Result<RemoteHandle<<Fut as Future>::Output>, SpawnError> where
    Fut: Future + Send + 'static,
    <Fut as Future>::Output: Send, 

impl Timer for ActorSystem

fn schedule<T, M>(
    &self,
    initial_delay: Duration,
    interval: Duration,
    receiver: ActorRef<M>,
    sender: Sender,
    msg: T
) -> Uuid where
    T: Message + Into<M>,
    M: Message, 

fn schedule_once<T, M>(
    &self,
    delay: Duration,
    receiver: ActorRef<M>,
    sender: Sender,
    msg: T
) -> Uuid where
    T: Message + Into<M>,
    M: Message, 

fn schedule_at_time<T, M>(
    &self,
    time: DateTime<Utc>,
    receiver: ActorRef<M>,
    sender: Sender,
    msg: T
) -> Uuid where
    T: Message + Into<M>,
    M: Message, 

fn cancel_schedule(&self, id: Uuid)

impl Sync for ActorSystem

impl Clone for ActorSystem

fn clone(&self) -> ActorSystem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Send for ActorSystem

impl Debug for ActorSystem

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

Formats the value using the given formatter.