Struct replicante_util_upkeep::Upkeep

pub struct Upkeep { /* private fields */ }

Block the calling thread until shutdown is requested.

Shutdown is requested when:

• The process receives SIGINT.
• A registered thread panics.
• A required thread exists (optional threads are allowed to exit gracefully).

Shutdown Flow

1. Request all registered threads to shutdown.
2. Execute all on_shutdown callbacks. 3 Wait for all registered threads to exit.

Threads and handlers are iterated on in registration order.

Signal Handling

When a process is sent SIGINT the shutdown flow begins. The process is allowed to take as long as it wants to shutdown.

If a second SIGINT is received while the process is shutting down it will instead exit immediately.

Example

let mut up = Upkeep::new();
up.on_shutdown(|| println!("Bye :wave:"));
up.keepalive();

Implementations

impl Upkeep

pub fn new() -> Upkeep

pub fn keepalive(&mut self) -> bool

Block the calling thread waiting for the process to shutdown.

Returns

This method returns true if the process shuts down cleanly.

pub fn on_shutdown<F>(&mut self, callback: F)where
    F: Fn() + 'static,

Register a callback to be executed when a shutdown request is received.

pub fn register_signal(&mut self) -> Result<(), Error>

Register signal handers for SIGINT and SIGTERM.

pub fn register_thread<T: Send + 'static>(&mut self, thread: Thread<T>)

Register a Thread for shutdown.

Threads are politely asked to stop work and then joined. Threads MUST join for the process to exit correctly.

If a Thread registered with this function panics or exits the shutdown procedure for all other threads begins.

pub fn register_thread_optional<T: Send + 'static>(&mut self, thread: Thread<T>)

Similar to Upkeep::register_thread but clean exists do not shutdown the process.

pub fn set_logger(&mut self, logger: Logger)

Set the logger to be used by the Upkeep instance.

Trait Implementations

impl Default for Upkeep

fn default() -> Upkeep

Returns the “default value” for a type.

impl Drop for Upkeep

fn drop(&mut self)

Executes the destructor for this type.