Struct interprocess::local_socket::LocalSocketListener

pub struct LocalSocketListener { /* fields omitted */ }

A local socket server, listening for connections.

Example

use interprocess::local_socket::{LocalSocketListener, LocalSocketStream};
use std::io::{self, prelude::*};

fn handle_error(connection: io::Result<LocalSocketStream>) -> Option<LocalSocketStream> {
    match connection {
        Ok(val) => Some(val),
        Err(error) => {
            eprintln!("Incoming connection failed: {}", error);
            None
        }
    }
}

let listener = LocalSocketListener::bind("/tmp/example.sock")?;
for mut connection in listener.incoming().filter_map(handle_error) {
    connection.write_all(b"Hello from server!")?;
    let mut buffer = String::new();
    connection.read_to_string(&mut buffer);
    println!("Client answered: {}", buffer);
}

Implementations

impl LocalSocketListener

pub fn bind<'a>(name: impl ToLocalSocketName<'a>) -> Result<Self>

Creates a socket server with the specified local socket name.

pub fn accept(&self) -> Result<LocalSocketStream>

Listens for incoming connections to the socket, blocking until a client is connected.

See incoming for a convenient way to create a main loop for a server.

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

Creates an infinite iterator which calls accept() with each iteration. Used together with for loops to conveniently create a main loop for a socket server.

Example

use interprocess::local_socket::{LocalSocketListener, LocalSocketStream};
use std::io::{self, prelude::*};

fn handle_error(connection: io::Result<LocalSocketStream>) -> Option<LocalSocketStream> {
    match connection {
        Ok(val) => Some(val),
        Err(error) => {
            eprintln!("Incoming connection failed: {}", error);
            None
        }
    }
}

let listener = LocalSocketListener::bind("/tmp/example.sock")?;
// Thanks to incoming(), you get a simple self-documenting infinite server loop
for mut connection in listener.incoming().filter_map(handle_error) {
    eprintln!("New client!");
}

Trait Implementations

impl Debug for LocalSocketListener

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

Formats the value using the given formatter.

impl<'a> From<&'a LocalSocketListener> for Incoming<'a>

fn from(listener: &'a LocalSocketListener) -> Self

Performs the conversion.