Struct uds_windows::UnixListener
source · pub struct UnixListener(/* private fields */);
Expand description
A Unix domain socket server
Examples
use std::thread;
use uds_windows::{UnixStream, UnixListener};
fn handle_client(stream: UnixStream) {
// ...
}
let listener = UnixListener::bind("/path/to/the/socket").unwrap();
// accept connections and process them, spawning a new thread for each one
for stream in listener.incoming() {
match stream {
Ok(stream) => {
/* connection succeeded */
thread::spawn(|| handle_client(stream));
}
Err(err) => {
/* connection failed */
break;
}
}
}
Implementations§
source§impl UnixListener
impl UnixListener
sourcepub fn bind<P: AsRef<Path>>(path: P) -> Result<UnixListener>
pub fn bind<P: AsRef<Path>>(path: P) -> Result<UnixListener>
Creates a new UnixListener
bound to the specified socket.
Examples
use uds_windows::UnixListener;
let listener = match UnixListener::bind("/path/to/the/socket") {
Ok(sock) => sock,
Err(e) => {
println!("Couldn't connect: {:?}", e);
return
}
};
sourcepub fn accept(&self) -> Result<(UnixStream, SocketAddr)>
pub fn accept(&self) -> Result<(UnixStream, SocketAddr)>
Accepts a new incoming connection to this listener.
This function will block the calling thread until a new Unix connection
is established. When established, the corresponding UnixStream
and
the remote peer’s address will be returned.
Examples
use uds_windows::UnixListener;
let listener = UnixListener::bind("/path/to/the/socket").unwrap();
match listener.accept() {
Ok((socket, addr)) => println!("Got a client: {:?}", addr),
Err(e) => println!("accept function failed: {:?}", e),
}
sourcepub fn try_clone(&self) -> Result<UnixListener>
pub fn try_clone(&self) -> Result<UnixListener>
Creates a new independently owned handle to the underlying socket.
The returned UnixListener
is a reference to the same socket that this
object references. Both handles can be used to accept incoming
connections and options set on one listener will affect the other.
Examples
use uds_windows::UnixListener;
let listener = UnixListener::bind("/path/to/the/socket").unwrap();
let listener_copy = listener.try_clone().expect("Couldn't clone socket");
sourcepub fn local_addr(&self) -> Result<SocketAddr>
pub fn local_addr(&self) -> Result<SocketAddr>
Returns the local socket address of this listener.
Examples
use uds_windows::UnixListener;
let listener = UnixListener::bind("/path/to/the/socket").unwrap();
let addr = listener.local_addr().expect("Couldn't get local address");
sourcepub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>
pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>
Moves the socket into or out of nonblocking mode.
Examples
use uds_windows::UnixListener;
let listener = UnixListener::bind("/path/to/the/socket").unwrap();
listener.set_nonblocking(true).expect("Couldn't set nonblocking");
sourcepub fn take_error(&self) -> Result<Option<Error>>
pub fn take_error(&self) -> Result<Option<Error>>
Returns the value of the SO_ERROR
option.
Examples
use uds_windows::UnixListener;
let listener = UnixListener::bind("/tmp/sock").unwrap();
if let Ok(Some(err)) = listener.take_error() {
println!("Got error: {:?}", err);
}
sourcepub fn incoming(&self) -> Incoming<'_>
pub fn incoming(&self) -> Incoming<'_>
Returns an iterator over incoming connections.
The iterator will never return None
and will also not yield the
peer’s SocketAddr
structure.
Examples
use std::thread;
use uds_windows::{UnixStream, UnixListener};
fn handle_client(stream: UnixStream) {
// ...
}
let listener = UnixListener::bind("/path/to/the/socket").unwrap();
for stream in listener.incoming() {
match stream {
Ok(stream) => {
thread::spawn(|| handle_client(stream));
}
Err(err) => {
break;
}
}
}
Trait Implementations§
source§impl AsRawSocket for UnixListener
impl AsRawSocket for UnixListener
source§fn as_raw_socket(&self) -> RawSocket
fn as_raw_socket(&self) -> RawSocket
source§impl Debug for UnixListener
impl Debug for UnixListener
source§impl FromRawSocket for UnixListener
impl FromRawSocket for UnixListener
source§unsafe fn from_raw_socket(sock: RawSocket) -> Self
unsafe fn from_raw_socket(sock: RawSocket) -> Self
source§impl<'a> IntoIterator for &'a UnixListener
impl<'a> IntoIterator for &'a UnixListener
source§impl IntoRawSocket for UnixListener
impl IntoRawSocket for UnixListener
source§fn into_raw_socket(self) -> RawSocket
fn into_raw_socket(self) -> RawSocket
source§impl UnixListenerExt for UnixListener
impl UnixListenerExt for UnixListener
source§unsafe fn accept_overlapped(
&self,
socket: &UnixStream,
addrs: &mut AcceptAddrsBuf,
overlapped: *mut OVERLAPPED
) -> Result<bool>
unsafe fn accept_overlapped( &self, socket: &UnixStream, addrs: &mut AcceptAddrsBuf, overlapped: *mut OVERLAPPED ) -> Result<bool>
source§fn accept_complete(&self, socket: &UnixStream) -> Result<()>
fn accept_complete(&self, socket: &UnixStream) -> Result<()>
accept_overlapped
has finished, this function needs to be
called to finish the accept operation. Read more