use crate::future::poll_fn; use crate::io::PollEvented; use crate::net::unix::datagram::split::{split, RecvHalf, SendHalf}; use crate::net::unix::datagram::split_owned::{split_owned, OwnedRecvHalf, OwnedSendHalf}; use std::convert::TryFrom; use std::fmt; use std::io; use std::net::Shutdown; use std::os::unix::io::{AsRawFd, RawFd}; use std::os::unix::net::{self, SocketAddr}; use std::path::Path; use std::task::{Context, Poll}; cfg_uds! { /// An I/O object representing a Unix datagram socket. pub struct UnixDatagram { io: PollEvented, } } impl UnixDatagram { /// Creates a new `UnixDatagram` bound to the specified path. pub fn bind

(path: P) -> io::Result where P: AsRef, { let socket = mio_uds::UnixDatagram::bind(path)?; UnixDatagram::new(socket) } /// Creates an unnamed pair of connected sockets. /// /// This function will create a pair of interconnected Unix sockets for /// communicating back and forth between one another. Each socket will /// be associated with the default event loop's handle. pub fn pair() -> io::Result<(UnixDatagram, UnixDatagram)> { let (a, b) = mio_uds::UnixDatagram::pair()?; let a = UnixDatagram::new(a)?; let b = UnixDatagram::new(b)?; Ok((a, b)) } /// Consumes a `UnixDatagram` in the standard library and returns a /// nonblocking `UnixDatagram` from this crate. /// /// The returned datagram will be associated with the given event loop /// specified by `handle` and is ready to perform I/O. /// /// # Panics /// /// This function panics if thread-local runtime is not set. /// /// The runtime is usually set implicitly when this function is called /// from a future driven by a tokio runtime, otherwise runtime can be set /// explicitly with [`Handle::enter`](crate::runtime::Handle::enter) function. pub fn from_std(datagram: net::UnixDatagram) -> io::Result { let socket = mio_uds::UnixDatagram::from_datagram(datagram)?; let io = PollEvented::new(socket)?; Ok(UnixDatagram { io }) } fn new(socket: mio_uds::UnixDatagram) -> io::Result { let io = PollEvented::new(socket)?; Ok(UnixDatagram { io }) } /// Creates a new `UnixDatagram` which is not bound to any address. pub fn unbound() -> io::Result { let socket = mio_uds::UnixDatagram::unbound()?; UnixDatagram::new(socket) } /// Connects the socket to the specified address. /// /// The `send` method may be used to send data to the specified address. /// `recv` and `recv_from` will only receive data from that address. pub fn connect>(&self, path: P) -> io::Result<()> { self.io.get_ref().connect(path) } /// Sends data on the socket to the socket's peer. pub async fn send(&mut self, buf: &[u8]) -> io::Result { poll_fn(|cx| self.poll_send_priv(cx, buf)).await } /// Try to send a datagram to the peer without waiting. /// /// ``` /// # #[tokio::main] /// # async fn main() -> Result<(), Box> { /// use tokio::net::UnixDatagram; /// /// let bytes = b"bytes"; /// // We use a socket pair so that they are assigned /// // each other as a peer. /// let (mut first, mut second) = UnixDatagram::pair()?; /// /// let size = first.try_send(bytes)?; /// assert_eq!(size, bytes.len()); /// /// let mut buffer = vec![0u8; 24]; /// let size = second.try_recv(&mut buffer)?; /// /// let dgram = &buffer.as_slice()[..size]; /// assert_eq!(dgram, bytes); /// # Ok(()) /// # } /// ``` pub fn try_send(&mut self, buf: &[u8]) -> io::Result { self.io.get_ref().send(buf) } /// Try to send a datagram to the peer without waiting. /// /// ``` /// # #[tokio::main] /// # async fn main() -> Result<(), Box> { /// use { /// tokio::net::UnixDatagram, /// tempfile::tempdir, /// }; /// /// let bytes = b"bytes"; /// // We use a temporary directory so that the socket /// // files left by the bound sockets will get cleaned up. /// let tmp = tempdir().unwrap(); /// /// let server_path = tmp.path().join("server"); /// let mut server = UnixDatagram::bind(&server_path)?; /// /// let client_path = tmp.path().join("client"); /// let mut client = UnixDatagram::bind(&client_path)?; /// /// let size = client.try_send_to(bytes, &server_path)?; /// assert_eq!(size, bytes.len()); /// /// let mut buffer = vec![0u8; 24]; /// let (size, addr) = server.try_recv_from(&mut buffer)?; /// /// let dgram = &buffer.as_slice()[..size]; /// assert_eq!(dgram, bytes); /// assert_eq!(addr.as_pathname().unwrap(), &client_path); /// # Ok(()) /// # } /// ``` pub fn try_send_to

(&mut self, buf: &[u8], target: P) -> io::Result where P: AsRef, { self.io.get_ref().send_to(buf, target) } // Poll IO functions that takes `&self` are provided for the split API. // // They are not public because (taken from the doc of `PollEvented`): // // While `PollEvented` is `Sync` (if the underlying I/O type is `Sync`), the // caller must ensure that there are at most two tasks that use a // `PollEvented` instance concurrently. One for reading and one for writing. // While violating this requirement is "safe" from a Rust memory model point // of view, it will result in unexpected behavior in the form of lost // notifications and tasks hanging. pub(crate) fn poll_send_priv( &self, cx: &mut Context<'_>, buf: &[u8], ) -> Poll> { ready!(self.io.poll_write_ready(cx))?; match self.io.get_ref().send(buf) { Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => { self.io.clear_write_ready(cx)?; Poll::Pending } x => Poll::Ready(x), } } /// Receives data from the socket. pub async fn recv(&mut self, buf: &mut [u8]) -> io::Result { poll_fn(|cx| self.poll_recv_priv(cx, buf)).await } /// Try to receive a datagram from the peer without waiting. pub fn try_recv(&mut self, buf: &mut [u8]) -> io::Result { self.io.get_ref().recv(buf) } pub(crate) fn poll_recv_priv( &self, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll> { ready!(self.io.poll_read_ready(cx, mio::Ready::readable()))?; match self.io.get_ref().recv(buf) { Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => { self.io.clear_read_ready(cx, mio::Ready::readable())?; Poll::Pending } x => Poll::Ready(x), } } /// Sends data on the socket to the specified address. pub async fn send_to

(&mut self, buf: &[u8], target: P) -> io::Result where P: AsRef + Unpin, { poll_fn(|cx| self.poll_send_to_priv(cx, buf, target.as_ref())).await } pub(crate) fn poll_send_to_priv( &self, cx: &mut Context<'_>, buf: &[u8], target: &Path, ) -> Poll> { ready!(self.io.poll_write_ready(cx))?; match self.io.get_ref().send_to(buf, target) { Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => { self.io.clear_write_ready(cx)?; Poll::Pending } x => Poll::Ready(x), } } /// Receives data from the socket. pub async fn recv_from(&mut self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { poll_fn(|cx| self.poll_recv_from_priv(cx, buf)).await } /// Try to receive data from the socket without waiting. pub fn try_recv_from(&mut self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { self.io.get_ref().recv_from(buf) } pub(crate) fn poll_recv_from_priv( &self, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll> { ready!(self.io.poll_read_ready(cx, mio::Ready::readable()))?; match self.io.get_ref().recv_from(buf) { Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => { self.io.clear_read_ready(cx, mio::Ready::readable())?; Poll::Pending } x => Poll::Ready(x), } } /// Returns the local address that this socket is bound to. pub fn local_addr(&self) -> io::Result { self.io.get_ref().local_addr() } /// Returns the address of this socket's peer. /// /// The `connect` method will connect the socket to a peer. pub fn peer_addr(&self) -> io::Result { self.io.get_ref().peer_addr() } /// Returns the value of the `SO_ERROR` option. pub fn take_error(&self) -> io::Result> { self.io.get_ref().take_error() } /// 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) -> io::Result<()> { self.io.get_ref().shutdown(how) } // These lifetime markers also appear in the generated documentation, and make // it more clear that this is a *borrowed* split. #[allow(clippy::needless_lifetimes)] /// Split a `UnixDatagram` into a receive half and a send half, which can be used /// to receive and send the datagram concurrently. /// /// This method is more efficient than [`into_split`], but the halves cannot /// be moved into independently spawned tasks. /// /// [`into_split`]: fn@crate::net::UnixDatagram::into_split pub fn split<'a>(&'a mut self) -> (RecvHalf<'a>, SendHalf<'a>) { split(self) } /// Split a `UnixDatagram` into a receive half and a send half, which can be used /// to receive and send the datagram concurrently. /// /// Unlike [`split`], the owned halves can be moved to separate tasks, /// however this comes at the cost of a heap allocation. /// /// **Note:** Dropping the write half will shut down the write half of the /// datagram. This is equivalent to calling [`shutdown(Write)`]. /// /// [`split`]: fn@crate::net::UnixDatagram::split /// [`shutdown(Write)`]:fn@crate::net::UnixDatagram::shutdown pub fn into_split(self) -> (OwnedRecvHalf, OwnedSendHalf) { split_owned(self) } } impl TryFrom for mio_uds::UnixDatagram { type Error = io::Error; /// Consumes value, returning the mio I/O object. /// /// See [`PollEvented::into_inner`] for more details about /// resource deregistration that happens during the call. /// /// [`PollEvented::into_inner`]: crate::io::PollEvented::into_inner fn try_from(value: UnixDatagram) -> Result { value.io.into_inner() } } impl TryFrom for UnixDatagram { type Error = io::Error; /// Consumes stream, returning the tokio I/O object. /// /// This is equivalent to /// [`UnixDatagram::from_std(stream)`](UnixDatagram::from_std). fn try_from(stream: net::UnixDatagram) -> Result { Self::from_std(stream) } } impl fmt::Debug for UnixDatagram { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { self.io.get_ref().fmt(f) } } impl AsRawFd for UnixDatagram { fn as_raw_fd(&self) -> RawFd { self.io.get_ref().as_raw_fd() } }