Struct uds_windows::UnixListener

pub struct UnixListener(_);

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

impl 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
    }
};

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),
}

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");

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");

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");

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);
}

pub fn incoming<'a>(&'a self) -> Incoming<'a>

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

impl AsRawSocket for UnixListener

fn as_raw_socket(&self) -> RawSocket

Extracts the underlying raw socket from this object.

impl Debug for UnixListener

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

Formats the value using the given formatter.

impl FromRawSocket for UnixListener

unsafe fn from_raw_socket(sock: RawSocket) -> Self

Creates a new I/O object from the given raw socket.

impl<'a> IntoIterator for &'a UnixListener

type Item = Result<UnixStream>

The type of the elements being iterated over.

type IntoIter = Incoming<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Incoming<'a>

Creates an iterator from a value.

impl IntoRawSocket for UnixListener

fn into_raw_socket(self) -> RawSocket

Consumes this object, returning the raw underlying socket.

impl UnixListenerExt for UnixListener

unsafe fn accept_overlapped(
    &self,
    socket: &UnixStream,
    addrs: &mut AcceptAddrsBuf,
    overlapped: *mut OVERLAPPED
) -> Result<bool>

Perform an accept operation on this listener, accepting a connection in an overlapped fashion.

fn accept_complete(&self, socket: &UnixStream) -> Result<()>

Once an accept_overlapped has finished, this function needs to be called to finish the accept operation.

unsafe fn result(&self, overlapped: *mut OVERLAPPED) -> Result<(usize, u32)>

Calls the GetOverlappedResult function to get the result of an overlapped operation for this handle.