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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
use std::fmt;
use std::io;
use std::net::SocketAddr;
use std::path::PathBuf;
use std::pin::Pin;
use std::task::{Poll, Context};

use futures::io::{AsyncRead, AsyncWrite, IoSlice, IoSliceMut};
use async_std::net::{TcpStream, Shutdown};
#[cfg(unix)] use async_std::os::unix::net::UnixStream;

use crate::backpressure::Token;


#[derive(Debug)]
enum Stream {
    Tcp(TcpStream),
    #[cfg(unix)]
    Unix(UnixStream),
}

/// A peer address for either Tcp or Unix socket
///
/// This enum is returned by
/// [`ByteStream::peer_addr`](struct.ByteStream.html#method.peer_addr).
///
///
/// The enum contains `Unix` option even on platforms that don't support
/// unix sockets (Windows) to make code easier to write (less `#[cfg(unix)]`
/// attributes all over the code).
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum PeerAddr {
    /// The peer address is TCP socket address.
    Tcp(SocketAddr),
    /// The peer address is Unix socket path. `None` if socket is unnamed.
    Unix(Option<PathBuf>),
}

/// A wrapper around TcpStream and UnixStream
///
/// This structure is yielded by the stream created by
/// [`ListenExt::backpressure_wrapper`](trait.ListenExt.html#method.backpressure_wrapper)
///
/// This wrapper serves two purposes:
///
/// 1. Holds backpressure token
/// 2. Abstract away differences between TcpStream and UnixStream
///
/// The structure implements AsyncRead and AsyncWrite so can be used for
/// protocol implementation directly.
#[derive(Debug)]
pub struct ByteStream {
    stream: Stream,
    token: Token,
}

trait Assert: AsyncRead + AsyncWrite + Send + Unpin + 'static { }
impl Assert for ByteStream {}

impl fmt::Display for PeerAddr {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            PeerAddr::Tcp(s) => s.fmt(f),
            PeerAddr::Unix(None) => "<unnamed>".fmt(f),
            PeerAddr::Unix(Some(s)) => s.display().fmt(f),
        }
    }
}

impl ByteStream {
    /// Create a bytestream for a tcp socket
    pub fn new_tcp(token: Token, stream: TcpStream) -> ByteStream {
        ByteStream {
            stream: Stream::Tcp(stream),
            token,
        }
    }

    /// Create a bytestream for a unix socket
    #[cfg(unix)]
    pub fn new_unix(token: Token, stream: UnixStream) -> ByteStream {
        ByteStream {
            stream: Stream::Unix(stream),
            token,
        }
    }

    /// Returns the remote address that this stream is connected to.
    ///
    /// Note: even on non-unix platforms (Windows)
    /// [`PeerAddr`](enum.PeerAddr.html) still contains `Unix` option so you
    /// don't have to use conditional compilation when matching.
    ///
    /// ## Examples
    ///
    /// ```ignore
    /// let peer = stream.peer_addr()?;
    /// match peer.peer_addr()? {
    ///     PeerAddr::Tcp(addr) => println!("TCP addr {}", addr),
    ///     PeerAddr::Unix(None) => println!("Unnamed unix socket"),
    ///     PeerAddr::Unix(Some(path)) => println!("Unix {}", path.display()),
    /// }
    /// ```
    pub fn peer_addr(&self) -> io::Result<PeerAddr> {
        match &self.stream {
            Stream::Tcp(s) => s.peer_addr().map(PeerAddr::Tcp),
            #[cfg(unix)]
            Stream::Unix(s) => {
                s.peer_addr()
                .map(|a| a.as_pathname().map(|p| p.to_owned()))
                .map(PeerAddr::Unix)
            }
        }
    }

    /// Gets the value of the `TCP_NODELAY` option on this socket.
    ///
    /// For Unix sockets this function always returns true (Unix sockets
    /// always behave like the option is off).
    ///
    /// For more information about this option, see [`set_nodelay`].
    ///
    /// [`set_nodelay`]: #method.set_nodelay
    pub fn nodelay(&self) -> io::Result<bool> {
        match &self.stream {
            Stream::Tcp(s) => s.nodelay(),
            #[cfg(unix)]
            Stream::Unix(_) => Ok(true),
        }
    }

    /// Sets the value of the `TCP_NODELAY` option on this socket.
    ///
    /// If set, this option disables the Nagle algorithm. This means that
    /// segments are always sent as soon as possible, even if there is only a
    /// small amount of data. When not set, data is buffered until there is a
    /// sufficient amount to send out, thereby avoiding the frequent sending of
    /// small packets.
    ///
    /// For Unix sockets this function does nothing (Unix sockets always behave
    /// like the option is enabled, and there is no way to change that).
    pub fn set_nodelay(&self, nodelay: bool) -> io::Result<()> {
        match &self.stream {
            Stream::Tcp(s) => s.set_nodelay(nodelay),
            #[cfg(unix)]
            Stream::Unix(_) => Ok(()),
        }
    }

    /// Shuts down the read, write, or both halves of this connection.
    ///
    /// This function will cause all pending and future I/O calls on the
    /// specified portions to immediately return with an appropriate value
    /// (see the documentation of Shutdown).
    pub fn shutdown(&self, how: Shutdown) -> Result<(), io::Error> {
        match &self.stream {
            Stream::Tcp(s) => s.shutdown(how),
            #[cfg(unix)]
            Stream::Unix(s) => s.shutdown(how),
        }
    }
}

impl From<(Token, TcpStream)> for ByteStream {
    fn from((token, stream): (Token, TcpStream)) -> ByteStream {
        ByteStream::new_tcp(token, stream)
    }
}

#[cfg(unix)]
impl From<(Token, UnixStream)> for ByteStream {
    fn from((token, stream): (Token, UnixStream)) -> ByteStream {
        ByteStream::new_unix(token, stream)
    }
}

impl AsyncRead for ByteStream {

    fn poll_read(mut self: Pin<&mut Self>, cx: &mut Context, buf: &mut [u8])
        -> Poll<Result<usize, io::Error>>
    {
        match &mut self.stream {
            Stream::Tcp(s) => {
                unsafe { Pin::new_unchecked(s) }.poll_read(cx, buf)
            }
            #[cfg(unix)]
            Stream::Unix(s) => {
                unsafe { Pin::new_unchecked(s) }.poll_read(cx, buf)
            }
        }
    }

    fn poll_read_vectored(mut self: Pin<&mut Self>, cx: &mut Context,
        bufs: &mut [IoSliceMut])
        -> Poll<Result<usize, io::Error>>
    {
        match &mut self.stream {
            Stream::Tcp(s) => {
                unsafe { Pin::new_unchecked(s) }.poll_read_vectored(cx, bufs)
            }
            #[cfg(unix)]
            Stream::Unix(s) => {
                unsafe { Pin::new_unchecked(s) }.poll_read_vectored(cx, bufs)
            }
        }
    }
}

impl AsyncWrite for ByteStream {
    fn poll_write(mut self: Pin<&mut Self>, cx: &mut Context, buf: &[u8])
        -> Poll<Result<usize, io::Error>>
    {
        match &mut self.stream {
            Stream::Tcp(s) => {
                unsafe { Pin::new_unchecked(s) }.poll_write(cx, buf)
            }
            #[cfg(unix)]
            Stream::Unix(s) => {
                unsafe { Pin::new_unchecked(s) }.poll_write(cx, buf)
            }
        }
    }
    fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context)
        -> Poll<Result<(), io::Error>>
    {
        match &mut self.stream {
            Stream::Tcp(s) => {
                unsafe { Pin::new_unchecked(s) }.poll_flush(cx)
            }
            #[cfg(unix)]
            Stream::Unix(s) => {
                unsafe { Pin::new_unchecked(s) }.poll_flush(cx)
            }
        }
    }
    fn poll_close(mut self: Pin<&mut Self>, cx: &mut Context)
        -> Poll<Result<(), io::Error>>
    {
        match &mut self.stream {
            Stream::Tcp(s) => {
                unsafe { Pin::new_unchecked(s) }.poll_close(cx)
            }
            #[cfg(unix)]
            Stream::Unix(s) => {
                unsafe { Pin::new_unchecked(s) }.poll_close(cx)
            }
        }
    }
    fn poll_write_vectored(mut self: Pin<&mut Self>, cx: &mut Context,
        bufs: &[IoSlice])
        -> Poll<Result<usize, io::Error>>
    {
        match &mut self.stream {
            Stream::Tcp(s) => {
                unsafe { Pin::new_unchecked(s) }.poll_write_vectored(cx, bufs)
            }
            #[cfg(unix)]
            Stream::Unix(s) => {
                unsafe { Pin::new_unchecked(s) }.poll_write_vectored(cx, bufs)
            }
        }
    }
}