Skip to main content

qualia_core_db/net/qdnf/bearer/
contract.rs

1//! Bearer contracts. Observed locators come from the adapter, never the payload.
2
3use crate::net::qdnf::errors::QdnfError;
4use crate::net::qdnf::registries::BearerProfile;
5use crate::net::qdnf::types::{ObservedLocator, ScopeEpoch};
6
7#[repr(C)]
8#[derive(Clone, Copy, Debug, PartialEq, Eq)]
9pub struct BearerCapabilities {
10    pub profile: BearerProfile,
11    pub mtu: u16,
12    pub group_delivery: bool,
13    pub ordered: bool,
14    pub may_duplicate: bool,
15}
16
17#[repr(C)]
18#[derive(Clone, Copy, Debug, PartialEq, Eq)]
19pub struct RecvMeta {
20    pub observed_source: ObservedLocator,
21    pub scope: ScopeEpoch,
22    pub mtu: u16,
23}
24
25pub trait Bearer {
26    /// Bearer profile.
27    fn profile(&self) -> BearerProfile;
28    /// MTU.
29    fn mtu(&self) -> u16;
30    /// Scope epoch.
31    fn scope(&self) -> ScopeEpoch;
32    /// Sends a frame.
33    fn send(&mut self, dest: &ObservedLocator, frame: &[u8]) -> Result<usize, QdnfError>;
34    /// Receives into `out`.
35    fn recv(&mut self, out: &mut [u8]) -> Result<(usize, RecvMeta), QdnfError>;
36    /// Shuts down.
37    fn shutdown(&mut self) -> Result<(), QdnfError>;
38}
39
40/// `Ok(())` when the frame fits the MTU.
41pub fn check_frame_mtu(frame_len: usize, mtu: u16) -> Result<(), QdnfError> {
42    if frame_len > mtu as usize {
43        Err(QdnfError::Capacity)
44    } else {
45        Ok(())
46    }
47}