Struct ActorSystem

Source

pub struct ActorSystem { /* private fields */ }

Expand description

An actor system that contains and manages the actors spawned inside it.

Implementations§

Source §

impl ActorSystem

Source

pub fn create(config: ActorSystemConfig) -> ActorSystem

Creates an actor system with the given config. The user should benchmark how many slots are needed in the work channel, the number of threads they need in the system and and so on in order to satisfy the requirements of the software they are creating.

Source

pub fn start(&self)

Starts an unstarted ActorSystem. The function will do nothing if the ActorSystem has already been started.

Source

pub fn config(&self) -> &ActorSystemConfig

Returns a reference to the config for this actor system.

Source

pub fn connect( &self, sender: &SeccSender<WireMessage>, receiver: &SeccReceiver<WireMessage>, ) -> Uuid

Adds a connection to a remote actor system. When the connection is established the actor system will announce itself to the remote system with a WireMessage::Hello.

Source

pub fn disconnect(&self, system_uuid: Uuid) -> Result<(), AidError>

Disconnects this actor system from the remote actor system with the given UUID.

Source

pub fn connect_with_channels(system1: &ActorSystem, system2: &ActorSystem)

Connects two actor systems using two channels directly. This can be used as a utility in testing or to link two actor systems directly within the same process.

Source

pub fn init_current(&self)

Initializes this actor system to use for the current thread which is necessary if the user wishes to serialize and deserialize Aids.

§Contract

You must run this exactly once per thread where needed.

Source

pub fn current() -> ActorSystem

Fetches a clone of a reference to the actor system for the current thread.

Source

pub fn uuid(&self) -> Uuid

Returns the unique UUID for this actor system.

Source

pub fn trigger_shutdown(&self)

Triggers a shutdown but doesn’t wait for the Reactors to stop.

Source

pub fn await_shutdown( &self, timeout: impl Into<Option<Duration>>, ) -> ShutdownResult

Awaits the Executor shutting down all Reactors. This is backed by a barrier that Reactors will wait on after ActorSystem::trigger_shutdown is called, blocking until all Reactors have stopped.

Source

pub fn trigger_and_await_shutdown( &self, timeout: impl Into<Option<Duration>>, ) -> ShutdownResult

Triggers a shutdown of the system and returns only when all Reactors have shutdown.

Source

pub fn spawn(&self) -> ActorBuilder

Creates a single use builder for this actor system that allows a user to build actors using a chained syntax while optionally providing configuration parameters if desired.

§Examples

use axiom::prelude::*;

let system = ActorSystem::create(ActorSystemConfig::default().thread_pool_size(2));

async fn handler(mut count: usize, _: Context, _: Message) -> ActorResult<usize> {
    count += 1;
    Ok(Status::done(count))
}

let state = 0 as usize;

let aid1 = system.spawn().with(state, handler).unwrap();
let aid2 = system.spawn().name("Foo").with(state, handler).unwrap();
let aid3 = system.spawn().channel_size(10).with(state, handler).unwrap();

Source

pub fn stop_actor(&self, aid: &Aid)

Stops an actor by shutting down its channels and removing it from the actors list and telling the Aid to not allow messages to be sent to the actor since the receiving side of the actor is gone.

This is something that should rarely be called from the outside as it is much better to send the actor a SystemMsg::Stop message and allow it to stop gracefully.

Source