W3cubDocs

/Rust

Struct std::os::unix::net::UnixListener

pub struct UnixListener(_);
This is supported on Unix only.

A structure representing a Unix domain socket server.

Examples

use std::thread;
use std::os::unix::net::{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;
        }
    }
}

Methods

impl UnixListener [src]

This is supported on Unix only.

Creates a new UnixListener bound to the specified socket.

Examples

use std::os::unix::net::UnixListener;

let listener = match UnixListener::bind("/path/to/the/socket") {
    Ok(sock) => sock,
    Err(e) => {
        println!("Couldn't connect: {:?}", e);
        return
    }
};

This is supported on Unix only.

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 std::os::unix::net::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),
}

This is supported on Unix only.

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 std::os::unix::net::UnixListener;

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

let listener_copy = listener.try_clone().expect("try_clone failed");

This is supported on Unix only.

Returns the local socket address of this listener.

Examples

use std::os::unix::net::UnixListener;

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

let addr = listener.local_addr().expect("Couldn't get local address");

This is supported on Unix only.

Moves the socket into or out of nonblocking mode.

Examples

use std::os::unix::net::UnixListener;

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

listener.set_nonblocking(true).expect("Couldn't set non blocking");

This is supported on Unix only.

Returns the value of the SO_ERROR option.

Examples

use std::os::unix::net::UnixListener;

let listener = UnixListener::bind("/tmp/sock").unwrap();

if let Ok(Some(err)) = listener.take_error() {
    println!("Got error: {:?}", err);
}

Platform specific

On Redox this always returns None.

ⓘImportant traits for Incoming<'a>
impl<'a> Iterator for Incoming<'a>
    type Item = Result<UnixStream>;
This is supported on Unix only.

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 std::os::unix::net::{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 Debug for UnixListener [src]

Formats the value using the given formatter. Read more

impl AsRawFd for UnixListener [src]

This is supported on Unix only.

Extracts the raw file descriptor. Read more

impl FromRawFd for UnixListener [src]

This is supported on Unix only.

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

impl IntoRawFd for UnixListener [src]

This is supported on Unix only.

Consumes this object, returning the raw underlying file descriptor. Read more

impl<'a> IntoIterator for &'a UnixListener [src]

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

ⓘImportant traits for Incoming<'a>
impl<'a> Iterator for Incoming<'a>
    type Item = Result<UnixStream>;

Creates an iterator from a value. Read more

Auto Trait Implementations

impl Send for UnixListener

impl Sync for UnixListener

Blanket Implementations

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from #33417)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from #33417)

Performs the conversion.

impl<T> From for T [src]

Performs the conversion.

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from #33417)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from #33417)

Performs the conversion.

impl<T, U> Into for T where
    U: From<T>, 
[src]

Performs the conversion.

impl<T> Borrow for T where
    T: ?Sized
[src]

ⓘImportant traits for &'a mut I
impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'a, R: Read + ?Sized> Read for &'a mut R
impl<'a, W: Write + ?Sized> Write for &'a mut W

Immutably borrows from an owned value. Read more

impl<T> BorrowMut for T where
    T: ?Sized
[src]

ⓘImportant traits for &'a mut I
impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'a, R: Read + ?Sized> Read for &'a mut R
impl<'a, W: Write + ?Sized> Write for &'a mut W

Mutably borrows from an owned value. Read more

impl<T> Any for T where
    T: 'static + ?Sized
[src]

🔬 This is a nightly-only experimental API. (get_type_id #27745)this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/os/unix/net/struct.UnixListener.html