tokio-connectors 0.1.6

A collection of connectors for tokio-based clients and servers
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

//! A Unix client connector for arbitrary serialisable messages

use std::{
    fmt::Debug,
    marker::PhantomData,
    path::{Path, PathBuf},
    pin::Pin,
    task::{Context, Poll},
};

use futures::Stream;
use tokio::{
    net::UnixStream,
    sync::mpsc::{UnboundedReceiver, UnboundedSender},
};

use super::UnixSocketId;
use crate::{codecs::Codec, error::Error, handle::Handle};

/// A Unix client connector for sending and receiving arbitrary serialisable messages to/from a Unix server.
///
/// Uses the provided [Codec] for framing and (de)serialization of messages.
pub struct UnixClient<C: Codec<OUT, IN>, OUT: Debug + Send + 'static, IN: Debug + Send + 'static> {
    local_path: PathBuf,
    out_tx: UnboundedSender<OUT>,
    in_rx: UnboundedReceiver<(IN, UnixSocketId)>,
    handle: Handle<C, OUT, IN, UnixSocketId>,
    _c: PhantomData<C>,
}

impl<C: Codec<OUT, IN>, OUT: Debug + Send + 'static, IN: Debug + Send + 'static> Unpin
    for UnixClient<C, OUT, IN>
{
}

impl<C: Codec<OUT, IN>, OUT: Debug + Send + 'static, IN: Debug + Send + 'static>
    UnixClient<C, OUT, IN>
{
    /// Connect a Unix client to the given path
    pub async fn connect(path: &Path) -> Result<Self, Error> {
        // Bind the Unix stream to the given path
        let stream = UnixStream::connect(path).await?;

        // Setup a channel for incoming messages
        let (in_tx, in_rx) = tokio::sync::mpsc::unbounded_channel();

        // Setup a channel for outgoing messages
        let (out_tx, out_rx) = tokio::sync::mpsc::unbounded_channel();

        // Setup internal tasks for handling the Unix stream
        let (stream_rx, stream_tx) = stream.into_split();
        let handle = Handle::new(UnixSocketId(0), stream_rx, stream_tx, out_rx, in_tx).await?;

        // Create a new TcpClient from the connected stream
        Ok(Self {
            local_path: path.to_path_buf(),
            handle,
            out_tx,
            in_rx,
            _c: PhantomData,
        })
    }

    /// Fetch the local path of the Unix client connection
    pub fn local_path(&self) -> &Path {
        &self.local_path
    }

    /// Send an outgoing message
    // TODO: this should fail if the target client is not currently connected...
    pub async fn send(&mut self, msg: OUT) -> Result<(), Error> {
        self.out_tx.send(msg).map_err(|_e| Error::Send)?;
        Ok(())
    }

    /// Close the client connection and tear down internal tasks
    pub fn close(self) {
        // Send exit signal to internal handle
        let _ = self.handle.close();
    }
}

/// Poll for the next incoming message
impl<C: Codec<OUT, IN>, OUT: Debug + Send + Unpin + 'static, IN: Debug + Send + Unpin + 'static>
    Stream for UnixClient<C, OUT, IN>
{
    type Item = IN;

    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        match self.as_mut().in_rx.poll_recv(cx) {
            Poll::Ready(Some((msg, _addr))) => Poll::Ready(Some(msg)),
            Poll::Ready(None) => Poll::Ready(None), // Channel closed
            Poll::Pending => Poll::Pending,
        }
    }
}