Struct tikv::server::gc_worker::gc_manager::GcManagerContext

[+] Show declaration

pub(super) struct GcManagerContext {
    stop_signal_receiver: Option<Receiver<()>>,
    is_stopped: bool,
}

[−] Expand description

Used to check if GcManager should be stopped.

When GcManager is running, it might take very long time to GC a round. It should be able to break at any time so that we can shut down TiKV in time.

Fields

stop_signal_receiver: Option<Receiver<()>>

[−] Expand description

Used to receive stop signal. The sender side is hold in GcManagerHandle. If this field is None, the GcManagerContext will never stop.

is_stopped: bool

[−] Expand description

Whether an stop signal is received.

Implementations

impl GcManagerContext[−]

pub fn new() -> Self

pub fn set_stop_signal_receiver(&mut self, rx: Receiver<()>)[−]

Sets the receiver that used to receive the stop signal. GcManagerContext will be considered to be stopped as soon as a message is received from the receiver.

fn sleep_or_stop(&mut self, timeout: Duration) -> Result<(), GcManagerError>[−]

Sleeps for a while. if a stop message is received, returns immediately with GcManagerError::Stopped.

fn check_stopped(&mut self) -> Result<(), GcManagerError>[−]

Checks if a stop message has been fired. Returns GcManagerError::Stopped if there’s such a message.