1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
use std::{
any::Any,
future::Future,
pin::Pin,
task::{self, Poll},
};
use pin_project::pin_project;
use sealed::sealed;
use tokio::time::{Duration, Instant, Sleep};
use crate::{
addr::Addr,
envelope::{Envelope, MessageKind},
message::Message,
source::{SourceArc, SourceStream, UnattachedSource},
time::far_future,
tracing::TraceId,
};
/// A source that emits messages periodically.
/// Clones the message on every tick.
///
/// # Tracing
///
/// Every message starts a new trace, thus a new trace id is generated and
/// assigned to the current scope.
///
/// # Example
///
/// ```
/// # use std::time::Duration;
/// # use elfo_core as elfo;
/// # struct Config { period: Duration }
/// # async fn exec(mut ctx: elfo::Context<Config>) {
/// # use elfo::{message, msg};
/// use elfo::{time::Interval, messages::ConfigUpdated};
///
/// #[message]
/// struct MyTick;
///
/// let interval = ctx.attach(Interval::new(MyTick));
/// interval.start(ctx.config().period);
///
/// while let Some(envelope) = ctx.recv().await {
/// msg!(match envelope {
/// ConfigUpdated => {
/// interval.set_period(ctx.config().period);
/// },
/// MyTick => {
/// tracing::info!("tick!");
/// },
/// });
/// }
/// # }
/// ```
pub struct Interval<M> {
source: SourceArc<IntervalSource<M>>,
}
#[sealed]
impl<M: Message> crate::source::SourceHandle for Interval<M> {
fn is_terminated(&self) -> bool {
self.source.lock().is_none()
}
fn terminate(self) {
ward!(self.source.lock()).terminate();
}
}
const NEVER: Duration = Duration::ZERO;
#[pin_project]
struct IntervalSource<M> {
message: M,
period: Duration,
is_delayed: bool,
#[pin]
sleep: Sleep,
}
impl<M: Message> Interval<M> {
/// Creates an unattached instance of [`Interval`].
pub fn new(message: M) -> UnattachedSource<Self> {
let source = IntervalSource {
message,
period: NEVER,
is_delayed: false,
sleep: tokio::time::sleep_until(far_future()),
};
let source = SourceArc::new(source, false);
UnattachedSource::new(source, |source| Self { source })
}
/// Replaces a stored message with the provided one.
pub fn set_message(&self, message: M) {
let mut guard = ward!(self.source.lock());
*guard.stream().project().message = message;
}
// TODO: pub fn set_missed_tick_policy
/// Configures the period of ticks. Intended to be called on
/// `ConfigUpdated`.
///
/// Does nothing if the timer is not started or the period hasn't been
/// changed.
///
/// Unlike rescheduling (`start_*` methods), it only adjusts the current
/// period and doesn't change the time origin. For instance, if we have
/// a configured interval with period = 5s and try to call one of these
/// methods, the difference looks something like this:
///
/// ```text
/// set_period(10s): | 5s | 5s | 5s | # 10s | 10s |
/// start(10s): | 5s | 5s | 5s | # 10s | 10s |
/// #
/// called here
/// ```
///
/// # Panics
///
/// If `period` is zero.
#[track_caller]
pub fn set_period(&self, period: Duration) {
assert_ne!(period, NEVER, "period must be non-zero");
let mut guard = ward!(self.source.lock());
let source = guard.stream().project();
// Do nothing if not started or the period hasn't been changed.
if *source.period == NEVER || period == *source.period {
return;
}
// Reschedule if inside the period.
if !*source.is_delayed {
let new_deadline = source.sleep.deadline() - *source.period + period;
source.sleep.reset(new_deadline);
*source.period = period;
guard.wake();
} else {
*source.period = period;
}
}
/// Schedules the timer to start emitting ticks every `period`.
/// The first tick will be emitted also after `period`.
///
/// Reschedules the timer if it's already started.
///
/// # Panics
///
/// If `period` is zero.
#[track_caller]
pub fn start(&self, period: Duration) {
assert_ne!(period, NEVER, "period must be non-zero");
self.schedule(None, period);
}
/// Schedules the timer to start emitting ticks every `period`.
/// The first tick will be emitted after `delay`.
///
/// Reschedules the timer if it's already started.
///
/// # Panics
///
/// If `period` is zero.
#[track_caller]
pub fn start_after(&self, delay: Duration, period: Duration) {
self.start_at(Instant::now() + delay, period);
}
/// Schedules the timer to start emitting ticks every `period`.
/// The first tick will be emitted at `when`.
///
/// Reschedules the timer if it's already started.
///
/// # Panics
///
/// If `period` is zero.
///
/// # Stability
///
/// This method is unstable, because it accepts [`tokio::time::Instant`],
/// which will be replaced in the future to support other runtimes.
#[stability::unstable]
#[track_caller]
pub fn start_at(&self, when: Instant, period: Duration) {
assert_ne!(period, NEVER, "period must be non-zero");
self.schedule(Some(when), period);
}
/// Stops any ticks. To resume ticks use one of `start_*` methods.
///
/// Note: it doesn't terminates the source. It means the source is present
/// in the source map until [`SourceHandle::terminate()`] is called.
///
/// [`SourceHandle::terminate()`]: crate::SourceHandle::terminate()
pub fn stop(&self) {
self.schedule(Some(far_future()), NEVER);
}
fn schedule(&self, when: Option<Instant>, period: Duration) {
let mut guard = ward!(self.source.lock());
let source = guard.stream().project();
*source.is_delayed = when.is_some();
*source.period = period;
let new_deadline = when.unwrap_or_else(|| Instant::now() + period);
source.sleep.reset(new_deadline);
guard.wake();
}
}
impl<M: Message> SourceStream for IntervalSource<M> {
fn as_any_mut(self: Pin<&mut Self>) -> Pin<&mut dyn Any> {
// SAFETY: we only cast here, it cannot move data.
unsafe { self.map_unchecked_mut(|s| s) }
}
fn poll_recv(self: Pin<&mut Self>, cx: &mut task::Context<'_>) -> Poll<Option<Envelope>> {
let mut this = self.project();
// Do nothing if stopped or not configured.
if *this.period == NEVER {
return Poll::Pending;
}
// Wait for a tick from implementation.
if !this.sleep.as_mut().poll(cx).is_ready() {
return Poll::Pending;
}
// After first tick, the interval isn't delayed even if it was.
*this.is_delayed = false;
// Reset the underlying timer.
// It would be nice to use `reset_without_reregister` here, but it's private.
// TODO: consider moving to `tokio::time::Interval`, which uses it internally.
let new_deadline = this.sleep.deadline() + *this.period;
this.sleep.reset(new_deadline);
// Emit the message.
let message = this.message.clone();
let kind = MessageKind::Regular { sender: Addr::NULL };
let trace_id = TraceId::generate();
let envelope = Envelope::with_trace_id(message, kind, trace_id).upcast();
Poll::Ready(Some(envelope))
}
}