dope 0.8.0

The manifold runtime
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

use std::marker::PhantomData;
use std::time::Instant;

use o3::buffer::Shared;

use super::Session;
use crate::manifold::connector::source::DialKey;
use dope_net::link::core::{Establish, Outbound};
use dope_net::link::egress;
use dope_net::link::slot::PendingFlags;

pub use dope_net::link::egress::queue::Queue;
pub use dope_net::link::egress::stage::Stage;

pub const IOV_CAP: usize = 32;

use dope_core::driver::token::Token;
use dope_net::wire::send::Vectored;

pub struct Ctx<'a, 'd, N: Session<'d>> {
    pub conn_id: Token,
    pub state: &'a mut N::ConnState,
    pub sink: &'a mut egress::queue::Queue<IOV_CAP, N::Send>,
    pub(super) driver: PhantomData<fn(&'d ()) -> &'d ()>,
}

pub struct State<C: Default, B: AsRef<[u8]> = Shared> {
    pub conn: C,
    pub(super) egress: egress::queue::Queue<IOV_CAP, B>,
    pub(super) dial: DialKey,
    pub(super) pending: PendingFlags,
    pub(super) establish: Establish,
    pub(super) retired: bool,
    /// Monotonic time of the last inbound bytes from the peer, stamped from the
    /// turn clock on connect and on every recv. `None` until established. Read
    /// only for established slots, by the connector's inbound-idle liveness
    /// watchdog (`Core::poll_liveness`) — the sole detector of a silently
    /// vanished / half-open peer that never surfaces a readable EOF.
    pub(super) last_recv: Option<Instant>,
    /// Set by an app-initiated `CloseKind::Permanent` request so `close_slot`
    /// kills the dial target (no redial) instead of the default recoverable
    /// `disconnect`. Every other close path leaves this false (recoverable).
    pub(super) close_permanent: bool,
}

impl<C: Default, B: AsRef<[u8]>> Outbound for State<C, B> {
    fn establish(&mut self) -> &mut Establish {
        &mut self.establish
    }
}

impl<C: Default, B: AsRef<[u8]>> State<C, B> {
    pub(super) fn new(dial: DialKey, lane: usize, arena: &egress::queue::Arena<B>) -> Self {
        Self {
            conn: C::default(),
            egress: arena.queue_for(lane),
            dial,
            pending: PendingFlags::default(),
            establish: Establish::Idle,
            retired: false,
            last_recv: None,
            close_permanent: false,
        }
    }

    pub fn try_enqueue(&self, bytes: B) -> Result<(), B> {
        self.egress.try_enqueue(bytes)
    }

    pub(super) fn enqueue_send(&mut self, bytes: B) -> Result<(), B> {
        self.egress.try_enqueue(bytes)
    }

    pub fn wire_stage(&mut self) -> egress::stage::Stage<'_, B> {
        self.egress.wire_stage()
    }

    pub fn egress_len(&self) -> usize {
        self.egress.total_bytes()
    }

    pub(super) fn prepare_send(&mut self, bytes_cap: usize) -> Vectored<'_> {
        self.egress.prepare_send(bytes_cap)
    }

    pub(super) fn ack_send(&mut self, n: usize) {
        self.egress.ack(n);
    }
}

impl<C: Default> State<C, Shared> {
    #[must_use = "false = egress cap hit, nothing was enqueued"]
    pub fn enqueue_all(&mut self, frames: &[Shared]) -> bool {
        self.egress.try_enqueue_all(frames)
    }
}