pub struct WarmPool { /* private fields */ }Expand description
A pre-warmed pool of ready-to-use MicroVMs.
The pool maintains min_idle VMs in Ready state. When a VM is
acquired, the pool spawns a replacement in the background. Idle VMs
that exceed idle_ttl_secs are automatically evicted.
§Usage
let pool = WarmPool::start(pool_config, box_config, emitter).await?;
let vm = pool.acquire().await?; // Instant if pool has capacity
// ... use vm ...
pool.release(vm).await?; // Return to pool or destroy
pool.drain().await?; // Graceful shutdownImplementations§
Source§impl WarmPool
impl WarmPool
Sourcepub async fn start(
config: PoolConfig,
box_config: BoxConfig,
event_emitter: EventEmitter,
) -> Result<Self>
pub async fn start( config: PoolConfig, box_config: BoxConfig, event_emitter: EventEmitter, ) -> Result<Self>
Create and start the warm pool.
Spawns min_idle VMs in the background and starts the
replenishment/eviction loop.
Sourcepub fn set_metrics(&mut self, metrics: RuntimeMetrics)
pub fn set_metrics(&mut self, metrics: RuntimeMetrics)
Attach Prometheus metrics to this pool.
Sourcepub async fn acquire(&self) -> Result<VmManager>
pub async fn acquire(&self) -> Result<VmManager>
Acquire a ready VM from the pool.
If an idle VM is available, returns it immediately. Otherwise, boots a new VM on demand (slower path).
Sourcepub async fn release(&self, vm: VmManager) -> Result<()>
pub async fn release(&self, vm: VmManager) -> Result<()>
Release a VM back to the pool.
If the pool is at capacity, the VM is destroyed instead.
Sourcepub async fn idle_count(&self) -> usize
pub async fn idle_count(&self) -> usize
Get the number of idle VMs currently in the pool.
Sourcepub fn signal_shutdown(&self)
pub fn signal_shutdown(&self)
Signal the pool to shutdown. This signals the background task to stop replenishing and sets the shutdown flag. VMs will continue to exist until the pool is drained or dropped.
Sourcepub async fn drain_idle(&self) -> Result<()>
pub async fn drain_idle(&self) -> Result<()>
Destroy all idle VMs without consuming the pool (&self), so it can be
shut down from behind an Arc (e.g. a daemon serving concurrent requests).
Pair with Self::signal_shutdown first to stop the background replenisher;
its task then exits on its own (it watches the shutdown channel).
Auto Trait Implementations§
impl !RefUnwindSafe for WarmPool
impl !UnwindSafe for WarmPool
impl Freeze for WarmPool
impl Send for WarmPool
impl Sync for WarmPool
impl Unpin for WarmPool
impl UnsafeUnpin for WarmPool
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more