Struct UnixListener 

pub struct UnixListener { /* private fields */ }

Available on crate feature net only.

A Unix socket server, listening for connections.

You can accept a new connection by using the UnixListener::accept method.

Examples

use compio_io::{AsyncReadExt, AsyncWriteExt};
use compio_net::{UnixListener, UnixStream};
use tempfile::tempdir;

let dir = tempdir().unwrap();
let sock_file = dir.path().join("unix-server.sock");

let listener = UnixListener::bind(&sock_file).await.unwrap();

let (mut tx, (mut rx, _)) =
    futures_util::try_join!(UnixStream::connect(&sock_file), listener.accept()).unwrap();

tx.write_all("test").await.0.unwrap();

let (_, buf) = rx.read_exact(Vec::with_capacity(4)).await.unwrap();

assert_eq!(buf, b"test");

Implementations

impl UnixListener

pub async fn bind(path: impl AsRef<Path>) -> Result<UnixListener, Error>

Creates a new UnixListener, which will be bound to the specified file path. See UnixListener::bind_addr for more details.

pub async fn bind_addr(addr: &SockAddr) -> Result<UnixListener, Error>

Creates a new UnixListener with [SockAddr], which will be bound to the specified file path. The file path cannot yet exist.

To configure the socket before binding, you can use the UnixSocket type.

pub fn close(self) -> impl Future<Output = Result<(), Error>>

Close the socket. If the returned future is dropped before polling, the socket won’t be closed.

See TcpStream::close for more details.

pub async fn accept(&self) -> Result<(UnixStream, SockAddr), Error>

Accepts a new incoming connection from this listener.

This function will yield once a new Unix domain socket connection is established. When established, the corresponding UnixStream and the remote peer’s address will be returned.

pub async fn accept_with( &self, sock: UnixSocket, ) -> Result<(UnixStream, SockAddr), Error>

Available on Windows only.

Accepts a new incoming connection from this listener using the provided socket.

pub fn incoming(&self) -> UnixIncoming<'_>

Returns a stream of incoming connections to this listener.

pub fn local_addr(&self) -> Result<SockAddr, Error>

Returns the local address that this listener is bound to.

pub fn take_error(&self) -> Result<Option<Error>, Error>

Returns the value of the SO_ERROR option.

Trait Implementations

impl AsRawFd for UnixListener

fn as_raw_fd(&self) -> *mut c_void

Extracts the raw fd.

impl AsRawSocket for UnixListener

Available on Windows only.

fn as_raw_socket(&self) -> u64

Extracts the raw socket.

impl AsSocket for UnixListener

Available on Windows only.

fn as_socket(&self) -> BorrowedSocket<'_>

Borrows the socket.

impl Clone for UnixListener

fn clone(&self) -> UnixListener

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UnixListener

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl FromRawSocket for UnixListener

Available on Windows only.

unsafe fn from_raw_socket(sock: u64) -> UnixListener

Constructs a new I/O object from the specified raw socket.

impl ToSharedFd<Socket> for UnixListener

fn to_shared_fd(&self) -> SharedFd<Socket>

Return a cloned SharedFd.