Struct veilid_tools::StartupLock

pub struct StartupLock { /* private fields */ }

Synchronization mechanism that tracks the startup and shutdown of a region of code. Guarantees that some code can only be started up once and shut down only if it is already started. Also tracks if the code is in-use and will wait for all ‘entered’ code to finish before shutting down. Once a shutdown is requested, future calls to ‘enter’ will fail, ensuring that nothing is ‘entered’ at the time of shutdown. This allows an asynchronous shutdown to wait for operations to finish before proceeding.

Implementations

impl StartupLock

pub fn new() -> Self

pub fn startup( &self, ) -> Result<StartupLockGuard<'_>, StartupLockAlreadyStartedError>

Start up if things are not already started up One must call ‘success()’ on the returned startup lock guard if startup was successful otherwise the startup lock will not shift to the ‘started’ state.

pub fn stop_token(&self) -> Option<StopToken>

Get a stop token for this lock One can wait on this to timeout operations when a shutdown is requested

pub fn is_started(&self) -> bool

Check if this StartupLock is currently in a started state Returns false is the state is in transition

pub fn is_shut_down(&self) -> bool

Check if this StartupLock is currently in a shut down state Returns false is the state is in transition

pub async fn shutdown( &self, ) -> Result<StartupLockGuard<'_>, StartupLockAlreadyShutDownError>

Wait for all ‘entered’ operations to finish before shutting down One must call ‘success()’ on the returned startup lock guard if shutdown was successful otherwise the startup lock will not shift to the ‘stopped’ state.

pub fn enter( &self, ) -> Result<StartupLockEnterGuard<'_>, StartupLockNotStartedError>

Enter an operation in a started-up module. If this module has not yet started up or is in the process of startup or shutdown this will fail.

Trait Implementations

impl Debug for StartupLock

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

Formats the value using the given formatter.

impl Default for StartupLock

fn default() -> Self

Returns the “default value” for a type.