quickwit_actors/
kill_switch.rs

1// Copyright (C) 2021 Quickwit, Inc.
2//
3// Quickwit is offered under the AGPL v3.0 and as commercial software.
4// For commercial licensing, contact us at hello@quickwit.io.
5//
6// AGPL:
7// This program is free software: you can redistribute it and/or modify
8// it under the terms of the GNU Affero General Public License as
9// published by the Free Software Foundation, either version 3 of the
10// License, or (at your option) any later version.
11//
12// This program is distributed in the hope that it will be useful,
13// but WITHOUT ANY WARRANTY; without even the implied warranty of
14// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15// GNU Affero General Public License for more details.
16//
17// You should have received a copy of the GNU Affero General Public License
18// along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20use std::sync::atomic::{AtomicBool, Ordering};
21use std::sync::Arc;
22
23use tracing::debug;
24
25#[derive(Clone)]
26pub struct KillSwitch {
27    alive: Arc<AtomicBool>,
28}
29
30impl Default for KillSwitch {
31    fn default() -> Self {
32        KillSwitch {
33            alive: Arc::new(AtomicBool::new(true)),
34        }
35    }
36}
37
38impl KillSwitch {
39    pub fn kill(&self) {
40        debug!("kill-switch-activated");
41        self.alive.store(false, Ordering::Relaxed);
42    }
43
44    pub fn is_alive(&self) -> bool {
45        self.alive.load(Ordering::Relaxed)
46    }
47
48    pub fn is_dead(&self) -> bool {
49        !self.is_alive()
50    }
51}
52#[cfg(test)]
53mod tests {
54    use super::KillSwitch;
55
56    #[test]
57    fn test_kill_switch() {
58        let kill_switch = KillSwitch::default();
59        assert!(kill_switch.is_alive());
60        assert!(!kill_switch.is_dead());
61        kill_switch.kill();
62        assert!(!kill_switch.is_alive());
63        assert!(kill_switch.is_dead());
64        kill_switch.kill();
65        assert!(!kill_switch.is_alive());
66        assert!(kill_switch.is_dead());
67    }
68}
quickwit_actors/kill_switch.rs

quickwit_actors/
kill_switch.rs
