Struct RemoteProcessAlloc

pub struct RemoteProcessAlloc { /* private fields */ }

A generalized implementation of an Alloc using one or more hosts running RemoteProcessAlloc for process allocation.

Implementations

impl RemoteProcessAlloc

pub async fn new( spec: AllocSpec, world_id: WorldId, remote_allocator_port: u16, initializer: impl RemoteProcessAllocInitializer + Send + Sync + 'static, ) -> Result<Self, Error>

Create a new Alloc. initializer will be called on the first invocation of next() to obtain a list of allocate hosts. Then Allocate message will be sent to all RemoteProcessAllocator on all hosts. Heartbeats will be used to maintain health status of remote hosts.

Trait Implementations

impl Alloc for RemoteProcessAlloc

fn client_router_addr(&self) -> ChannelAddr

For Tcp and Metatls, return a router address which has the same IP address as the alloc’s bootstrap address, but with port set as 0. We do this instead of using ChannelAddr::any is because we want alloc uses the same IP address for all its frontend ports. In some environment, the host can have public IP address and private IP address, and use the wrong one could lead to port unreachable error.

For other channel types, this method still uses ChannelAddr::any.

fn next<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Option<ProcState>> + Send + 'async_trait>>

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

Return the next proc event. None indicates that there are no more events, and that the alloc is stopped.

fn spec(&self) -> &AllocSpec

The spec against which this alloc is executing.

fn extent(&self) -> &Extent

The shape of the alloc.

fn world_id(&self) -> &WorldId

The world id of this alloc, uniquely identifying the alloc. Note: This will be removed in favor of a different naming scheme, once we exise “worlds” from hyperactor core.

fn stop<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), AllocatorError>> + Send + 'async_trait>>

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

Stop this alloc, shutting down all of its procs. A clean shutdown should result in Stop events from all allocs, followed by the end of the event stream.

fn shape(&self) -> Shape

The shape of the alloc. (Deprecated.)

fn transport(&self) -> ChannelTransport

The channel transport used the procs in this alloc.

fn stop_and_wait<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), AllocatorError>> + Send + 'async_trait>>

where Self: Send + 'async_trait, 'life0: 'async_trait,

Stop this alloc and wait for all procs to stop. Call will block until all ProcState events have been drained.

fn is_local(&self) -> bool

Returns whether the alloc is a local alloc: that is, its procs are not independent processes, but just threads in the selfsame process.

impl Drop for RemoteProcessAlloc

fn drop(&mut self)

Executes the destructor for this type.