Struct tokio::net::UnixListener [−][src]
pub struct UnixListener { /* fields omitted */ }Expand description
A Unix socket which can accept connections from other Unix sockets.
You can accept a new connection by using the accept method.
A UnixListener can be turned into a Stream with UnixListenerStream.
Errors
Note that accepting a connection can lead to various errors and not all of them are necessarily fatal ‒ for example having too many open file descriptors or the other side closing the connection while it waits in an accept queue. These would terminate the stream if not handled in any way.
Examples
use tokio::net::UnixListener;
#[tokio::main]
async fn main() {
let listener = UnixListener::bind("/path/to/the/socket").unwrap();
loop {
match listener.accept().await {
Ok((stream, _addr)) => {
println!("new client!");
}
Err(e) => { /* connection failed */ }
}
}
}Implementations
Creates a new UnixListener bound to the specified path.
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 Runtime::enter function.
Creates new UnixListener from a std::os::unix::net::UnixListener .
This function is intended to be used to wrap a UnixListener from the standard library in the Tokio equivalent. The conversion assumes nothing about the underlying listener; it is left up to the user to set it in non-blocking mode.
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 Runtime::enter function.
Turns a tokio::net::UnixListener into a std::os::unix::net::UnixListener.
The returned std::os::unix::net::UnixListener will have nonblocking mode
set as true. Use set_nonblocking to change the blocking mode if needed.
Examples
use std::error::Error;
#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
let tokio_listener = tokio::net::UnixListener::bind("127.0.0.1:0")?;
let std_listener = tokio_listener.into_std()?;
std_listener.set_nonblocking(false)?;
Ok(())
}Returns the local socket address of this listener.
Returns the value of the SO_ERROR option.
Accepts a new incoming connection to this listener.
Cancel safety
This method is cancel safe. If the method is used as the event in a
tokio::select! statement and some other branch
completes first, then it is guaranteed that no new connections were
accepted by this method.
Polls to accept a new incoming connection to this listener.
If there is no connection to accept, Poll::Pending is returned and the
current task will be notified by a waker. Note that on multiple calls
to poll_accept, only the Waker from the Context passed to the most
recent call is scheduled to receive a wakeup.
Trait Implementations
Consumes stream, returning the tokio I/O object.
This is equivalent to
UnixListener::from_std(stream).