velo 0.12.0

Velo distributed-systems runtime: active messaging, peer discovery, streaming, rendezvous, and queue backends
Documentation 
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

// SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

//! Concrete [`Event`] RAII guard and [`EventBackend`] routing trait.

use anyhow::Result;
use std::sync::{Arc, LazyLock};

use crate::events::handle::EventHandle;
use crate::events::slot::EventAwaiter;

/// Static poison reason reused across all drop-triggered poisons.
static DROP_POISON_REASON: LazyLock<Arc<str>> =
    LazyLock::new(|| Arc::from("event dropped without being triggered"));

// ── Backend trait: routing customization point ──────────────────────

/// Routing layer for event completion operations.
///
/// Only three methods — just the operations that need local-vs-remote routing
/// in a distributed setup. [`EventSystemBase`](crate::EventSystemBase) implements
/// this for the local path; a distributed backend would add network routing.
pub trait EventBackend: Send + Sync {
    /// Mark the event as successfully completed, waking all waiters.
    fn trigger(&self, handle: EventHandle) -> Result<()>;

    /// Poison the event with the given reason, waking all waiters with an error.
    fn poison(&self, handle: EventHandle, reason: Arc<str>) -> Result<()>;

    /// Create a future that resolves when the event completes.
    fn awaiter(&self, handle: EventHandle) -> Result<EventAwaiter>;
}

// ── Concrete Event ─────────────────────────────────────────────────

/// A single event that can be triggered or poisoned exactly once.
///
/// `Event` is an RAII guard: dropping it without calling [`trigger`](Event::trigger)
/// or [`poison`](Event::poison) automatically poisons the event so waiters are
/// never silently abandoned. To opt out of drop-poisoning (e.g. when handing
/// ownership to a manager-level operation), call [`into_handle`](Event::into_handle).
///
/// `trigger` and `poison` consume `self`, preventing double-completion at
/// compile time.
pub struct Event {
    inner: Option<EventInner>,
}

struct EventInner {
    handle: EventHandle,
    backend: Arc<dyn EventBackend>,
}

impl Event {
    /// Create a new event RAII guard.
    pub(crate) fn new(handle: EventHandle, backend: Arc<dyn EventBackend>) -> Self {
        Self {
            inner: Some(EventInner { handle, backend }),
        }
    }

    /// Take the inner state, disarming the drop guard.
    fn take_inner(&mut self) -> EventInner {
        self.inner.take().expect("event already consumed")
    }

    /// Return the handle that identifies this event.
    pub fn handle(&self) -> EventHandle {
        self.inner.as_ref().expect("event already consumed").handle
    }

    /// Mark the event as successfully completed, waking all waiters.
    /// Consumes the event, disarming the drop guard.
    pub fn trigger(mut self) -> Result<()> {
        let inner = self.take_inner();
        inner.backend.trigger(inner.handle)
    }

    /// Poison the event with the given reason, waking all waiters with an error.
    /// Consumes the event, disarming the drop guard.
    pub fn poison(mut self, reason: impl Into<Arc<str>>) -> Result<()> {
        let inner = self.take_inner();
        inner.backend.poison(inner.handle, reason.into())
    }

    /// Create a future that resolves when this event completes.
    pub fn awaiter(&self) -> Result<EventAwaiter> {
        let inner = self.inner.as_ref().expect("event already consumed");
        inner.backend.awaiter(inner.handle)
    }

    /// Disarm the drop guard and return the bare handle.
    ///
    /// After this call the event will **not** be auto-poisoned on drop.
    /// Use the returned handle with [`EventManager`](crate::EventManager)
    /// methods to complete the event manually.
    pub fn into_handle(mut self) -> EventHandle {
        self.take_inner().handle
    }
}

impl Drop for Event {
    fn drop(&mut self) {
        if let Some(inner) = self.inner.take() {
            let _ = inner
                .backend
                .poison(inner.handle, Arc::clone(&*DROP_POISON_REASON));
        }
    }
}