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

use std::time::Duration;

use super::Ctx;
use super::app::Requests;
use super::codec::Codec;
use super::lifecycle::Lifecycle;
use crate::runtime::Idle;
use dope_core::driver::ready::ReadyKey;
use dope_core::driver::token::Token;

pub trait Session<'d>: Sized {
    type Codec: Codec;
    type ConnState: Lifecycle;
    type Send: AsRef<[u8]>;

    fn codec(&self) -> &Self::Codec;

    fn activate(&self, token: Token, ready: ReadyKey<'d>) {
        let _ = (token, ready);
    }

    fn connect(&mut self, ctx: &mut Ctx<'_, 'd, Self>);

    fn response(&mut self, head: <Self::Codec as Codec>::Head, ctx: &mut Ctx<'_, 'd, Self>);

    fn disconnect(&mut self, ctx: &mut Ctx<'_, 'd, Self>);

    fn flush_trailer(&mut self, ctx: &mut Ctx<'_, 'd, Self>) {
        let _ = ctx;
    }

    fn sent(&self, token: Token, sent: usize) {
        let _ = (token, sent);
    }

    fn drain_requests(
        &self,
        token: Token,
        push: impl FnMut(Self::Send) -> Result<(), Self::Send>,
    ) -> Requests {
        let _ = (token, push);
        Requests::default()
    }

    fn defer_close(&self, token: Token, state: &Self::ConnState) -> bool {
        let _ = token;
        state.defer_close()
    }

    fn is_drained(&self, token: Token, state: &Self::ConnState) -> bool {
        let _ = token;
        state.is_drained()
    }

    fn pre_park(&mut self) {}

    fn idle(&self) -> Idle {
        Idle::Park(None)
    }

    /// Inbound-idle liveness bound (see `ConnApp::inbound_idle_timeout`). A
    /// protocol sets this to just over its keepalive cadence — e.g. AMQP returns
    /// `2 ×` the negotiated heartbeat once the handshake fixes the interval — so
    /// the connector force-reconnects a silently vanished peer. `None` disables.
    fn inbound_idle_timeout(&self) -> Option<Duration> {
        None
    }
}