Struct ResourceController 

pub struct ResourceController<T: Controlled> { /* private fields */ }

Generic controller for a mesh of resources. Currently instantiated as ActorMeshController<A> = ResourceController<ActorMeshRef<A>>. All shared behavior lives here; mesh-specific behavior is delegated through the Controlled trait.

resource::mesh::Spec<()> and resource::mesh::State<()> (instead of Spec<T::Spec> / State<T::StateInner>) are used because the controller participates in the mesh resource protocol only at the outer layer: callers of GetState on the controller want the per-rank statuses and the mesh-wide status that resource::mesh::State already carries, not the inner T::StateInner payload (which is available rank-by-rank via the resource::State<T::StateInner> stream). The unit type is the explicit “no extra payload” choice.

Trait Implementations

impl<T: Controlled> Actor for ResourceController<T>

where State<T::StateInner>: RemoteMessage,

fn init<'life0, 'life1, 'async_trait>( &'life0 mut self, this: &'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 cleanup<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, this: &'life1 Instance<Self>, _err: Option<&'life2 ActorError>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Cleanup things used by this actor before shutting down. Notably this function is async and allows more complex cleanup. Simpler cleanup can be handled by the impl Drop for this Actor. If err is not None, it is the error that this actor is failing with. Any errors returned by this function will be logged and ignored. If err is None, any errors returned by this function will be propagated as an ActorError. This function is not called if there is a panic in the actor, as the actor may be in an indeterminate state. It is also not called if the process is killed, there is no atexit handler or signal handler.

fn handle_undeliverable_message<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Instance<Self>, envelope: 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 handle_stop<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, this: &'life1 Instance<Self>, mode: StopMode, reason: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

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

Handle a stop request from the runtime.

fn spawn(self, cx: &impl Actor) -> Result<ActorHandle<Self>, Error>

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_with_name( self, cx: &impl Actor, name: &str, ) -> Result<ActorHandle<Self>, Error>

Spawn a named child actor. Same supervision semantics as spawn, but the child gets name in its ActorAddr.

fn spawn_detached(self) -> Result<ActorHandle<Self>, Error>

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.

fn display_name(&self) -> Option<String>

If overridden, we will use this name in place of the ActorAddr for talking about this actor in supervision error messages.

impl<T: Controlled + Named> Binds<ResourceController<T>> for ResourceController<T>

where Subscribe: RemoteMessage, ResourceController<T>: Handler<Subscribe> + Handler<Unsubscribe> + Handler<GetSubscriberCount> + Handler<CheckState> + Handler<WaitRankStatus> + Handler<CreateOrUpdate<Spec<()>>> + Handler<GetState<State<()>>> + Handler<Stop> + Handler<State<T::StateInner>>, Unsubscribe: RemoteMessage, GetSubscriberCount: RemoteMessage, CheckState: RemoteMessage, WaitRankStatus: RemoteMessage, CreateOrUpdate<Spec<()>>: RemoteMessage, GetState<State<()>>: RemoteMessage, Stop: RemoteMessage, State<T::StateInner>: RemoteMessage,

fn bind(ports: &HandlerPorts<Self>)

Bind ports in this actor.

impl<T: Controlled> Debug for ResourceController<T>

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

Formats the value using the given formatter.

impl<T: Controlled> Handler<CheckState> for ResourceController<T>

where State<T::StateInner>: RemoteMessage,

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

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

Handle the next M-typed message.

impl<T: Controlled> Handler<CreateOrUpdate<Spec<()>>> for ResourceController<T>

where State<T::StateInner>: RemoteMessage,

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

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

Currently a no-op as there’s nothing to create or update, but allows ResourceController to implement the resource mesh behavior.

impl<T: Controlled> Handler<GetState<State<()>>> for ResourceController<T>

where State<T::StateInner>: RemoteMessage,

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, message: GetState<State<()>>, ) -> 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<T: Controlled> Handler<GetSubscriberCount> for ResourceController<T>

where State<T::StateInner>: RemoteMessage,

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, message: GetSubscriberCount, ) -> 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<T: Controlled> Handler<State<<T as Controlled>::StateInner>> for ResourceController<T>

where State<T::StateInner>: RemoteMessage,

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, state: State<T::StateInner>, ) -> 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<T: Controlled> Handler<Stop> for ResourceController<T>

where State<T::StateInner>: RemoteMessage,

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, message: Stop, ) -> 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<T: Controlled> Handler<Subscribe> for ResourceController<T>

where State<T::StateInner>: RemoteMessage,

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, message: Subscribe, ) -> 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<T: Controlled> Handler<Unsubscribe> for ResourceController<T>

where State<T::StateInner>: RemoteMessage,

fn handle<'life0, 'life1, 'async_trait>( &'life0 mut self, cx: &'life1 Context<'_, Self>, message: Unsubscribe, ) -> 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<T: Controlled> Handler<WaitRankStatus> for ResourceController<T>

where State<T::StateInner>: RemoteMessage,

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

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

Forward WaitRankStatus to the underlying agents. Each agent replies directly to the caller’s accumulator port when its resource reaches the requested status.

impl<T: Controlled> Mesh for ResourceController<T>

type Spec = ()

The mesh-specific specification for this resource.

type State = ()

The mesh-specific state for this resource.

impl<T: Controlled + Named> Named for ResourceController<T>

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<T: Controlled + Named> Accepts<CheckState> for ResourceController<T>

where CheckState: RemoteMessage,

impl<T: Controlled + Named> Accepts<CreateOrUpdate<Spec<()>>> for ResourceController<T>

where CreateOrUpdate<Spec<()>>: RemoteMessage,

impl<T: Controlled + Named> Accepts<GetState<State<()>>> for ResourceController<T>

where GetState<State<()>>: RemoteMessage,

impl<T: Controlled + Named> Accepts<GetSubscriberCount> for ResourceController<T>

where GetSubscriberCount: RemoteMessage,

impl<T: Controlled + Named> Accepts<IntrospectMessage> for ResourceController<T>

impl<T: Controlled + Named> Accepts<State<<T as Controlled>::StateInner>> for ResourceController<T>

where State<T::StateInner>: RemoteMessage,

impl<T: Controlled + Named> Accepts<Stop> for ResourceController<T>

where Stop: RemoteMessage,

impl<T: Controlled + Named> Accepts<Subscribe> for ResourceController<T>

where Subscribe: RemoteMessage,

impl<T: Controlled + Named> Accepts<Unsubscribe> for ResourceController<T>

where Unsubscribe: RemoteMessage,

impl<T: Controlled + Named> Accepts<WaitRankStatus> for ResourceController<T>

where WaitRankStatus: RemoteMessage,

impl<T: Controlled + Named> Referable for ResourceController<T>

impl<T: Controlled + Named> RemoteHandles<CheckState> for ResourceController<T>

where CheckState: RemoteMessage,

impl<T: Controlled + Named> RemoteHandles<CreateOrUpdate<Spec<()>>> for ResourceController<T>

where CreateOrUpdate<Spec<()>>: RemoteMessage,

impl<T: Controlled + Named> RemoteHandles<GetState<State<()>>> for ResourceController<T>

where GetState<State<()>>: RemoteMessage,

impl<T: Controlled + Named> RemoteHandles<GetSubscriberCount> for ResourceController<T>

where GetSubscriberCount: RemoteMessage,

impl<T: Controlled + Named> RemoteHandles<IntrospectMessage> for ResourceController<T>

impl<T: Controlled + Named> RemoteHandles<State<<T as Controlled>::StateInner>> for ResourceController<T>

where State<T::StateInner>: RemoteMessage,

impl<T: Controlled + Named> RemoteHandles<Stop> for ResourceController<T>

where Stop: RemoteMessage,

impl<T: Controlled + Named> RemoteHandles<Subscribe> for ResourceController<T>

where Subscribe: RemoteMessage,

impl<T: Controlled + Named> RemoteHandles<Unsubscribe> for ResourceController<T>

where Unsubscribe: RemoteMessage,

impl<T: Controlled + Named> RemoteHandles<WaitRankStatus> for ResourceController<T>

where WaitRankStatus: RemoteMessage,