Struct veloren_server_cli::shutdown_coordinator::ShutdownCoordinator

pub(crate) struct ShutdownCoordinator {
    last_shutdown_msg: Instant,
    msg_interval: Duration,
    shutdown_initiated_at: Option<Instant>,
    shutdown_grace_period: Duration,
    shutdown_message: String,
    shutdown_signal: Arc<AtomicBool>,
}

Coordinates the shutdown procedure for the server, which can be initiated by either the TUI console interface or by sending the server the SIGUSR1 (or others) signal which indicates the server is restarting due to an update.

Fields

last_shutdown_msg: Instant

The instant that the last shutdown message was sent, used for calculating when to send the next shutdown message

msg_interval: Duration

The interval that shutdown warning messages are sent at

shutdown_initiated_at: Option<Instant>

The instant that shudown was initiated at

shutdown_grace_period: Duration

The period to wait before shutting down after shutdown is initiated

shutdown_message: String

The message to use for the shutdown warning message that is sent to all connected players

shutdown_signal: Arc<AtomicBool>

Provided by signal_hook to allow observation of a shutdown signal

Implementations

impl ShutdownCoordinator

pub fn new(shutdown_signal: Arc<AtomicBool>) -> Self

pub fn initiate_shutdown( &mut self, server: &mut Server, grace_period: Duration, message: String )

Initiates a graceful shutdown of the server using the specified grace period and message. When the grace period expires, the server process exits.

pub fn abort_shutdown(&mut self, server: &mut Server)

Aborts an in-progress shutdown and sends a message to all connected clients.

pub fn check(&mut self, server: &mut Server, settings: &Settings) -> bool

Called once per tick to process any pending actions related to server shutdown. If the grace period for an initiated shutdown has expired, returns true which triggers the loop in main.rs to break and exit the server process.

fn check_shutdown_signal(&mut self, server: &mut Server, settings: &Settings)

Checks whether a shutdown (SIGUSR1 by default) signal has been set, which is used to trigger a graceful shutdown for an update. Watchtower is configured on the main Veloren server to send SIGUSR1 instead of SIGTERM which allows us to react specifically to shutdowns that are for an update. NOTE: SIGUSR1 is not supported on Windows

fn send_shutdown_msg(&mut self, server: &mut Server)

Constructs a formatted shutdown message and sends it to all connected clients

fn time_until_shutdown(&self) -> Option<Duration>

Calculates the remaining time before the shutdown grace period expires

fn send_msg(server: &mut Server, msg: String)

Logs and sends a message to all connected clients

fn duration_to_text(duration: Duration) -> String

Converts a Duration into text in the format XsXm for example 1 minute 50 seconds would be converted to “1m50s”, 2 minutes 0 seconds to “2m” and 0 minutes 23 seconds to “23s”.