Skip to main content

WarmPool

Struct WarmPool 

Source
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 shutdown

Implementations§

Source§

impl WarmPool

Source

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.

Source

pub fn set_metrics(&mut self, metrics: RuntimeMetrics)

Attach Prometheus metrics to this pool.

Source

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).

Source

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.

Source

pub async fn stats(&self) -> PoolStats

Get current pool statistics.

Source

pub async fn idle_count(&self) -> usize

Get the number of idle VMs currently in the pool.

Source

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.

Source

pub async fn drain(&mut self) -> Result<()>

Gracefully drain all VMs and stop the pool.

Source

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§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more