Struct SystemActor

pub struct SystemActor { /* private fields */ }

The system actor manages the whole system. It is responsible for managing the systems’ worlds, and for managing their constituent procs. The system actor also provides a central mailbox that can route messages to any live actor in the system.

Implementations

impl SystemActor

pub async fn bootstrap( params: SystemActorParams, ) -> Result<(ActorHandle<SystemActor>, Proc), Error>

Bootstrap the system actor. This will create a proc, spawn the actor on that proc, and then return the actor handle and the corresponding proc.

pub async fn bootstrap_with_clock( params: SystemActorParams, clock: ClockKind, ) -> Result<(ActorHandle<SystemActor>, Proc), Error>

Bootstrap the system actor with a specified clock.This will create a proc, spawn the actor on that proc, and then return the actor handle and the corresponding proc.

Trait Implementations

impl Actor for SystemActor

type Params = SystemActorParams

The type of initialization parameters accepted by this actor.

fn new<'async_trait>( params: SystemActorParams, ) -> Pin<Box<dyn Future<Output = Result<Self, Error>> + Send + 'async_trait>>

where Self: 'async_trait,

Creates a new actor instance given its instantiation parameters.

fn init<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Instance<Self>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Initialize the actor, after the runtime has been fully initialized. Init thus provides a mechanism by which an actor can reliably and always receive some initial event that can be used to kick off further (potentially delayed) processing.

fn handle_undeliverable_message<'life0, 'life1, 'async_trait>( &'life0 mut self, _cx: &'life1 Instance<Self>, __arg2: Undeliverable<MessageEnvelope>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Default undeliverable message handling behavior.

fn spawn<'life0, 'async_trait>( cap: &'life0 (impl CanSpawn + 'async_trait), params: Self::Params, ) -> Pin<Box<dyn Future<Output = Result<ActorHandle<Self>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Spawn a child actor, given a spawning capability (usually given by Instance). The spawned actor will be supervised by the parent (spawning) actor.

fn spawn_detached<'async_trait>( params: Self::Params, ) -> Pin<Box<dyn Future<Output = Result<ActorHandle<Self>, Error>> + Send + 'async_trait>>

where Self: 'async_trait,

Spawns this actor in a detached state, handling its messages in a background task. The returned handle is used to control the actor’s lifecycle and to interact with it.

fn spawn_server_task<F>(future: F) -> JoinHandle<<F as Future>::Output>

where F: Future + Send + 'static, <F as Future>::Output: Send + 'static,

This method is used by the runtime to spawn the actor server. It can be used by actors that require customized runtime setups (e.g., dedicated actor threads), or want to use a custom tokio runtime.

fn handle_supervision_event<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, _this: &'life1 Instance<Self>, _event: &'life2 ActorSupervisionEvent, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Handle actor supervision event. Return `Ok(true)`` if the event is handled here.

impl Binds<SystemActor> for SystemActor

fn bind(ports: &Ports<Self>)

Bind ports in this actor.

impl Clone for SystemActor

fn clone(&self) -> SystemActor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemActor

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

Formats the value using the given formatter.

impl Handler<ProcStopResult> for SystemActor

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, msg: ProcStopResult, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Handle the next M-typed message.

impl Handler<ProcSupervisionMessage> for SystemActor

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, msg: ProcSupervisionMessage, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Handle the next M-typed message.

impl Handler<SystemMessage> for SystemActor

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, message: SystemMessage, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Handle the next M-typed message.

impl Handler<WorldSupervisionMessage> for SystemActor

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, msg: WorldSupervisionMessage, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Handle the next M-typed message.

impl Named for SystemActor

fn typename() -> &'static str

The globally unique type name for the type. This should typically be the fully qualified Rust name of the type.

fn typehash() -> u64

A globally unique hash for this type. TODO: actually enforce perfect hashing

fn typeid() -> TypeId

The TypeId for this type. TypeIds are unique only within a binary, and should not be used for global identification.

fn port() -> u64

The globally unique port for this type. Typed ports are in the range of 1<<63..1<<64-1.

fn arm(&self) -> Option<&'static str>

If the named type is an enum, this returns the name of the arm of the value self.

unsafe fn arm_unchecked(self_: *const ()) -> Option<&'static str>

An unsafe version of ‘arm’, accepting a pointer to the value, for use in type-erased settings.

impl SystemMessageHandler for SystemActor

+——+ spawns +––+ joins +—–+ | Proc |<–––––|Host|———>|World| +——+ +––+ +—–+ | ^ | joins | +———————————–+ When bootstrapping the system,

1. hosts will join the world,
2. hosts will spawn (worker) procs,
3. procs will join the world

fn join<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, world_id: WorldId, proc_id: ProcId, proc_message_port: PortRef<ProcMessage>, channel_addr: ChannelAddr, labels: HashMap<String, String>, lifecycle_mode: ProcLifecycleMode, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The generated handler method for this enum variant.

fn upsert_world<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, world_id: WorldId, shape: Shape, num_procs_per_host: usize, env: Environment, labels: HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The generated handler method for this enum variant.

fn snapshot<'life0, 'life1, 'async_trait>( &'life0 mut self, _cx: &'life1 Context<'_, Self>, filter: SystemSnapshotFilter, ) -> Pin<Box<dyn Future<Output = Result<SystemSnapshot, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The generated handler method for this enum variant.

fn stop<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, worlds: Option<Vec<WorldId>>, proc_timeout: Duration, reply_port: OncePortRef<()>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The generated handler method for this enum variant.

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, message: SystemMessage, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Handle the next message.

impl RemoteActor for SystemActor

impl RemoteHandles<ProcSupervisionMessage> for SystemActor

impl RemoteHandles<Signal> for SystemActor

impl RemoteHandles<SystemMessage> for SystemActor

impl RemoteHandles<WorldSupervisionMessage> for SystemActor