quickwit_actors/
lib.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
20//! quickwit-actors is a simplified actor framework for quickwit.
21//!
22//! It solves the following problem:
23//! - have sync and async tasks communicate together.
24//! - make these task observable
25//! - make these task modular and testable
26//! - detect when some task is stuck and does not progress anymore
27
28use std::fmt;
29
30use tokio::time::Duration;
31mod actor;
32mod actor_handle;
33mod actor_state;
34mod actor_with_state_tx;
35pub(crate) mod channel_with_priority;
36mod envelope;
37mod kill_switch;
38mod mailbox;
39mod observation;
40mod progress;
41mod runner;
42mod scheduler;
43mod spawn_builder;
44
45mod join_handle;
46#[cfg(test)]
47mod tests;
48mod universe;
49
50pub use actor::{Actor, ActorExitStatus, Handler};
51pub use actor_handle::{ActorHandle, Health, Supervisable};
52pub use kill_switch::KillSwitch;
53pub use observation::{Observation, ObservationType};
54pub use progress::{Progress, ProtectedZoneGuard};
55pub(crate) use scheduler::Scheduler;
56use thiserror::Error;
57pub use universe::Universe;
58
59pub use self::actor::ActorContext;
60pub use self::actor_state::ActorState;
61pub use self::channel_with_priority::{QueueCapacity, RecvError, SendError};
62pub use self::mailbox::{create_mailbox, create_test_mailbox, Command, Mailbox};
63pub use crate::runner::ActorRunner;
64
65/// Heartbeat used to verify that actors are progressing.
66///
67/// If an actor does not advertise a progress within an interval of duration `HEARTBEAT`,
68/// its supervisor will consider it as blocked and will proceed to kill it, as well
69/// as all of the actors all the actors that share the killswitch.
70pub const HEARTBEAT: Duration = Duration::from_secs(3);
71
72pub fn message_timeout() -> Duration {
73    HEARTBEAT.mul_f32(0.2f32)
74}
75
76/// Error that occured while calling `ActorContext::ask(..)` or `Universe::ask`
77#[derive(Error, Debug)]
78pub enum AskError<E: fmt::Debug> {
79    #[error("Message could not be delivered")]
80    MessageNotDelivered,
81    #[error("Error while the message was being processed.")]
82    ProcessMessageError,
83    #[error("The handler returned an error: `{0:?}`.")]
84    ErrorReply(#[from] E),
85}
quickwit_actors/lib.rs

quickwit_actors/
lib.rs
