Struct mio_uds::UnixListener

pub struct UnixListener { /* fields omitted */ }

A structure representing a Unix domain socket server.

This listener can be used to accept new streams connected to a remote endpoint, through which the read and write methods can be used to communicate.

Methods

impl UnixListener

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

Creates a new UnixListener bound to the specified socket.

pub fn from_listener(stream: UnixListener) -> Result<UnixListener>

Consumes a standard library UnixListener and returns a wrapped UnixListener compatible with mio.

The returned stream is moved into nonblocking mode and is otherwise ready to get associated with an event loop.

pub fn accept(&self) -> Result<Option<(UnixStream, SocketAddr)>>

Accepts a new incoming connection to this listener.

When established, the corresponding UnixStream and the remote peer's address will be returned as Ok(Some(...)). If there is no connection waiting to be accepted, then Ok(None) is returned.

If an error happens while accepting, Err is returned.

pub fn accept_std(&self) -> Result<Option<(UnixStream, SocketAddr)>>

Accepts a new incoming connection to this listener.

This method is the same as accept, except that it returns a UDP socket in blocking mode which isn't bound to a mio type. This can later be converted to a mio type, if necessary.

If an error happens while accepting, Err is returned.

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.

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

Returns the local socket address of this listener.

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

Returns the value of the SO_ERROR option.

Trait Implementations

impl AsRawFd for UnixListener

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor.

impl Debug for UnixListener

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

Formats the value using the given formatter.

impl Evented for UnixListener

fn register(
    &self,
    poll: &Poll,
    token: Token,
    events: Ready,
    opts: PollOpt
) -> Result<()>

Register self with the given Poll instance.

fn reregister(
    &self,
    poll: &Poll,
    token: Token,
    events: Ready,
    opts: PollOpt
) -> Result<()>

Re-register self with the given Poll instance.

fn deregister(&self, poll: &Poll) -> Result<()>

Deregister self from the given Poll instance

impl FromRawFd for UnixListener

unsafe fn from_raw_fd(fd: i32) -> UnixListener

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

impl IntoRawFd for UnixListener

fn into_raw_fd(self) -> i32

Consumes this object, returning the raw underlying file descriptor.