Struct unix_socket::UnixListener

pub struct UnixListener { /* fields omitted */ }

A structure representing a Unix domain socket server.

Examples

use std::thread;
use unix_socket::{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;
        }
    }
}

// close the listener socket
drop(listener);

Implementations

impl UnixListener

pub fn bind<P: AsRef<Path>>(path: P) -> Result<UnixListener>

Creates a new UnixListener bound to the specified socket.

Linux provides, as a nonportable extension, a separate “abstract” address namespace as opposed to filesystem-based addressing. If path begins with a null byte, it will be interpreted as an “abstract” address. Otherwise, it will be interpreted as a “pathname” address, corresponding to a path on the filesystem.

Examples

use unix_socket::UnixListener;

let listener = UnixListener::bind("/path/to/the/socket").unwrap();

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 corersponding UnixStream and the remote peer’s address will be returned.

Examples

use unix_socket::UnixListener;

let listener = UnixListener::bind("/path/to/the/socket").unwrap();
let (client_stream, addr) = listener.accept().unwrap();

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 unix_socket::UnixListener;

let listener = UnixListener::bind("/path/to/the/socket").unwrap();
let copy = listener.try_clone().unwrap();

pub fn local_addr(&self) -> Result<SocketAddr>

Returns the local socket address of this listener.

Example

use unix_socket::UnixListener;

let listener = UnixListener::bind("/path/to/the/socket").unwrap();
println!("{}", match listener.local_addr() {
    Ok(addr) => format!("local address: {:?}", addr),
    Err(_) => "no local address".to_owned(),
});

pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>

Moves the socket into or out of nonblocking mode.

Example

use unix_socket::UnixListener;

let mut listener = UnixListener::bind("/path/to/the/socket").unwrap();
listener.set_nonblocking(true).unwrap();

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

Returns the value of the SO_ERROR option.

Example

use unix_socket::UnixListener;

let listener = UnixListener::bind("/path/to/the/socket").unwrap();
println!("{}", match listener.take_error() {
    Ok(ret) => format!("error: {:?}", ret),
    Err(_) => "error".to_owned(),
});

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 unix_socket::{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 */
            println!("incoming connection succeeded!");
            thread::spawn(|| handle_client(stream));
        }
        Err(err) => {
            /* connection failed */
            println!("incoming connection failed...");
        }
    }
}

Trait Implementations

impl AsRawFd for UnixListener

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for UnixListener

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

Formats the value using the given formatter.

impl FromRawFd for UnixListener

unsafe fn from_raw_fd(fd: RawFd) -> UnixListener

Constructs a new instance of Self from the given raw file descriptor.

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 IntoRawFd for UnixListener

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.