Struct ProcActorParams

pub struct ProcActorParams {
    pub proc: Proc,
    pub world_id: WorldId,
    pub system_actor_ref: ActorRef<SystemActor>,
    pub bootstrap_channel_addr: ChannelAddr,
    pub local_addr: ChannelAddr,
    pub state_watch: Sender<ProcState>,
    pub supervisor_actor_ref: ActorRef<ProcSupervisor>,
    pub supervision_update_interval: Duration,
    pub labels: HashMap<String, String>,
    pub lifecycle_mode: ProcLifecycleMode,
}

Parameters for managing the proc.

Fields

proc: Proc

The proc that is managed by this actor.

world_id: WorldId

The system world to which this proc belongs.

system_actor_ref: ActorRef<SystemActor>

Reference to the system actor that is managing this proc.

bootstrap_channel_addr: ChannelAddr

The channel address used to communicate with the system actor that manages this proc. This is passed through so that the proc can spawn sibling procs.

local_addr: ChannelAddr

The local address of this proc actor. This is used by the proc actor to register the proc with the system actor.

state_watch: Sender<ProcState>

Watch into which the proc’s state is published.

supervisor_actor_ref: ActorRef<ProcSupervisor>

Reference to supervisor.

supervision_update_interval: Duration

Interval of reporting supervision status to the system actor.

labels: HashMap<String, String>

Arbitrary labels for the proc. They can be used later to query proc(s) using system snapshot api.

lifecycle_mode: ProcLifecycleMode

Proc lifecycle management mode.

If a proc is not managed

• it will not be stopped when system shutdowns.
• it will not be captured by system snapshot.

Not being managed is useful for procs that runs on the client side, which might need to stay around for a while after the system is gone.

Trait Implementations

impl Clone for ProcActorParams

fn clone(&self) -> ProcActorParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcActorParams

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

Formats the value using the given formatter.