zerodds-corba-cos-notify 1.0.0-rc.3.1

OMG CosNotification 1.1 — structured event channel + ConsumerAdmin/SupplierAdmin + StructuredProxy hierarchy + filter + QoS (successor to CosEvent; no_std + alloc).
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

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 ZeroDDS Contributors

//! CosNotifyComm §3 — structured-event push/pull traits + publish/subscribe.

use alloc::boxed::Box;

use crate::event::{EventType, StructuredEvent};

/// `Disconnected` — the proxy/endpoint is no longer connected.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Disconnected;

/// Connect error (§3 / §4): already connected or nil reference.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ConnectError {
    /// `AlreadyConnected`.
    AlreadyConnected,
    /// `TypeError` — incompatible endpoint type.
    TypeError,
}

/// `CosNotifyComm::StructuredPushConsumer` (§3.2): receives pushed events.
pub trait StructuredPushConsumer: Send + Sync {
    /// `push_structured_event` — deliver an event.
    ///
    /// # Errors
    /// `Disconnected` if the consumer is disconnected.
    fn push_structured_event(&self, event: StructuredEvent) -> Result<(), Disconnected>;
    /// `disconnect_structured_push_consumer`.
    fn disconnect(&self);
}

/// `CosNotifyComm::StructuredPushSupplier` (§3.3).
pub trait StructuredPushSupplier: Send + Sync {
    /// `disconnect_structured_push_supplier`.
    fn disconnect(&self);
}

/// `CosNotifyComm::StructuredPullConsumer` (§3.4).
pub trait StructuredPullConsumer: Send + Sync {
    /// `disconnect_structured_pull_consumer`.
    fn disconnect(&self);
}

/// `CosNotifyComm::StructuredPullSupplier` (§3.5): supplies events on demand.
pub trait StructuredPullSupplier: Send + Sync {
    /// `pull_structured_event` — blocks (here: error if empty) until an event is available.
    ///
    /// # Errors
    /// `Disconnected`.
    fn pull_structured_event(&self) -> Result<StructuredEvent, Disconnected>;
    /// `try_pull_structured_event` — non-blocking; `bool` = `has_event`.
    ///
    /// # Errors
    /// `Disconnected`.
    fn try_pull_structured_event(&self) -> Result<(StructuredEvent, bool), Disconnected>;
    /// `disconnect_structured_pull_supplier`.
    fn disconnect(&self);
}

/// `CosNotifyComm::NotifyPublish` (§3.1): supplier announces event types.
pub trait NotifyPublish: Send + Sync {
    /// `offer_change` — `added`/`removed` event types.
    fn offer_change(&self, added: &[EventType], removed: &[EventType]);
}

/// `CosNotifyComm::NotifySubscribe` (§3.1): consumer subscribes to event types.
pub trait NotifySubscribe: Send + Sync {
    /// `subscription_change` — `added`/`removed` event types.
    fn subscription_change(&self, added: &[EventType], removed: &[EventType]);
}

/// Boxed push-consumer callback for the channel push path.
pub type BoxedPushConsumer = Box<dyn StructuredPushConsumer>;

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn connect_error_variants_distinct() {
        assert_ne!(ConnectError::AlreadyConnected, ConnectError::TypeError);
    }
}