aggligator 0.9.11

Aggregates multiple links (TCP or similar) into one connection having their combined bandwidth and provides resiliency against failure of individual links.
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

//! Front-end of aggregated connection.

use bytes::Bytes;
use std::{
    io,
    pin::Pin,
    sync::Arc,
    task::{Context, Poll},
};
use tokio::{
    io::{AsyncRead, AsyncWrite, ReadBuf},
    sync::{mpsc, watch},
};

use super::{Receiver, ReceiverStream, RecvError, SendError, Sender, SenderSink};
use crate::{
    agg::task::SendReq,
    cfg::{Cfg, ExchangedCfg},
    id::ConnId,
};

/// A bi-directional channel backed by a connection of aggregated links.
///
/// Use the [connect module](mod@crate::connect) to establish a new connection.
///
/// This must either be converted into [sender and receiver for messages](Self::into_tx_rx)
/// or into a [stream supporting async IO](Self::into_stream).
#[derive(Debug)]
pub struct Channel {
    cfg: Arc<Cfg>,
    remote_cfg: Option<Arc<ExchangedCfg>>,
    conn_id: ConnId,
    tx: mpsc::Sender<SendReq>,
    tx_error: watch::Receiver<SendError>,
    rx: mpsc::Receiver<Bytes>,
    rx_closed: mpsc::Sender<()>,
    rx_error: watch::Receiver<Option<RecvError>>,
}

impl Channel {
    #[allow(clippy::too_many_arguments)]
    pub(crate) fn new(
        cfg: Arc<Cfg>, remote_cfg: Option<Arc<ExchangedCfg>>, conn_id: ConnId, tx: mpsc::Sender<SendReq>,
        tx_error: watch::Receiver<SendError>, rx: mpsc::Receiver<Bytes>, rx_closed: mpsc::Sender<()>,
        rx_error: watch::Receiver<Option<RecvError>>,
    ) -> Self {
        Self { cfg, remote_cfg, conn_id, tx, tx_error, rx, rx_closed, rx_error }
    }

    /// Connection id.
    pub fn id(&self) -> ConnId {
        self.conn_id
    }

    /// Sets the remote configuration of the connection.
    pub(crate) fn set_remote_cfg(&mut self, remote_cfg: Arc<ExchangedCfg>) {
        assert!(self.remote_cfg.is_none(), "remote configuration was already set");
        self.remote_cfg = Some(remote_cfg);
    }

    /// Splits this into sender and receiver for messages.
    ///
    /// Note that the local sender is connected to the receiver *of the remote endpoint* and vice versa.
    pub fn into_tx_rx(self) -> (Sender, Receiver) {
        let Self { cfg, remote_cfg, conn_id, tx, tx_error, rx, rx_closed, rx_error } = self;

        let tx = Sender::new(cfg, remote_cfg.unwrap(), conn_id, tx, tx_error);
        let rx = Receiver::new(conn_id, rx, rx_closed, rx_error);

        (tx, rx)
    }

    /// Converts this into a stream that implements the [`AsyncRead`] and [`AsyncWrite`] traits.
    pub fn into_stream(self) -> Stream {
        let (tx, rx) = self.into_tx_rx();
        Stream { tx: tx.into_sink(), rx: rx.into_stream() }
    }
}

/// A bi-directional IO stream backed by a connection of aggregated links,
/// implementing [AsyncRead] and [AsyncWrite].
#[derive(Debug)]
pub struct Stream {
    tx: SenderSink,
    rx: ReceiverStream,
}

impl Stream {
    /// Connection id.
    pub fn id(&self) -> ConnId {
        self.tx.id()
    }

    /// Splits this stream into its receiving and sending halves.
    pub fn into_split(self) -> (ReceiverStream, SenderSink) {
        let Self { tx, rx } = self;
        (rx, tx)
    }

    /// Prevents the remote endpoint from sending further data, but allows already
    /// sent data to be processed.
    pub fn close(&mut self) {
        self.rx.close()
    }
}

impl AsyncRead for Stream {
    #[inline]
    fn poll_read(self: Pin<&mut Self>, cx: &mut Context, buf: &mut ReadBuf) -> Poll<io::Result<()>> {
        Pin::new(&mut self.get_mut().rx).poll_read(cx, buf)
    }
}

impl AsyncWrite for Stream {
    #[inline]
    fn poll_write(self: Pin<&mut Self>, cx: &mut Context, buf: &[u8]) -> Poll<Result<usize, io::Error>> {
        Pin::new(&mut self.get_mut().tx).poll_write(cx, buf)
    }

    #[inline]
    fn poll_flush(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), io::Error>> {
        Pin::new(&mut self.get_mut().tx).poll_flush(cx)
    }

    fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), io::Error>> {
        Pin::new(&mut self.get_mut().tx).poll_shutdown(cx)
    }
}