Skip to main content

LifecycleManager

Struct LifecycleManager 

Source
pub struct LifecycleManager<R: ContainerRuntime + 'static> { /* private fields */ }
Expand description

Coordinates the startup, supervision and shutdown of every resource declared in a LifecyclePlan.

Implementations§

Source§

impl<R: ContainerRuntime + 'static> LifecycleManager<R>

Source

pub fn new(plan: LifecyclePlan, runtime: R) -> (Self, Receiver<LifecycleEvent>)

Build a manager bound to plan and runtime. Returns a fresh event subscriber alongside; further subscribers can be obtained from Self::subscribe_events.

Source

pub async fn start_all(&self) -> Result<(), LifecycleError>

Start every resource in topological order. Independent branches start in parallel. On the first failure, the resources that already started are stopped automatically before the error is returned.

Source

pub async fn stop_all(&self, grace: Duration) -> Result<(), LifecycleError>

Stop every resource in reverse topological order with the given SIGTERM-to-SIGKILL grace window.

Source

pub async fn run_until_signal( &self, grace: Duration, ) -> Result<(), LifecycleError>

Opinionated entry point used by lightshuttle up: starts the stack, waits for SIGINT or SIGTERM, then stops the stack cleanly with the configured grace window.

Source

pub async fn restart_one(&self, resource: &str) -> Result<(), LifecycleError>

Restart a single resource without touching its dependents.

The target is stopped via SIGTERM (10-second grace window), its container id and started-at timestamp are cleared, then start_one is re-run from the same cached spec. Three events are emitted on the lifecycle channel in order: ResourceStopped, ResourceStarted, ResourceHealthy.

Dependents keep running. Their watch channels observe the target’s status going StoppedPendingStartingRunningHealthy, so callers that depend on the target can pause their work locally until it is healthy again.

Source

pub fn subscribe_events(&self) -> Receiver<LifecycleEvent>

Open a new subscription on the lifecycle event broadcast.

Multiple subscribers can read concurrently. Subscribers that fall more than [EVENT_CHANNEL_CAPACITY] events behind will observe a RecvError::Lagged and have to resynchronise.

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<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> 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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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