Struct mio::net::UnixDatagram

source ·

pub struct UnixDatagram {
    inner: IoSource<UnixDatagram>,
}

Expand description

A Unix datagram socket.

Fields§

§inner: IoSource<UnixDatagram>

Implementations§

source §

impl UnixDatagram

source

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

Creates a Unix datagram socket bound to the given path.

source

pub fn bind_addr(address: &SocketAddr) -> Result<UnixDatagram>

Creates a new UnixDatagram bound to the specified socket address.

source

pub fn from_std(socket: UnixDatagram) -> UnixDatagram

Creates a new UnixDatagram from a standard net::UnixDatagram.

This function is intended to be used to wrap a Unix datagram from the standard library in the Mio equivalent. The conversion assumes nothing about the underlying datagram; it is left up to the user to set it in non-blocking mode.

source

pub fn connect<P: AsRef<Path>>(&self, path: P) -> Result<()>

Connects the socket to the specified address.

This may return a WouldBlock in which case the socket connection cannot be completed immediately.

source

pub fn unbound() -> Result<UnixDatagram>

Creates a Unix Datagram socket which is not bound to any address.

source

pub fn pair() -> Result<(UnixDatagram, UnixDatagram)>

Create an unnamed pair of connected sockets.

source

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

Returns the address of this socket.

source

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

Returns the address of this socket’s peer.

The connect method will connect the socket to a peer.

source

pub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>

Receives data from the socket.

On success, returns the number of bytes read and the address from whence the data came.

source

pub fn recv(&self, buf: &mut [u8]) -> Result<usize>

Receives data from the socket.

On success, returns the number of bytes read.

source

pub fn send_to<P: AsRef<Path>>(&self, buf: &[u8], path: P) -> Result<usize>

Sends data on the socket to the specified address.

On success, returns the number of bytes written.

source

pub fn send(&self, buf: &[u8]) -> Result<usize>

Sends data on the socket to the socket’s peer.

The peer address may be set by the connect method, and this method will return an error if the socket has not already been connected.

On success, returns the number of bytes written.

source

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

Returns the value of the SO_ERROR option.

source

pub fn shutdown(&self, how: Shutdown) -> Result<()>

Shut down the read, write, or both halves of this connection.

This function will cause all pending and future I/O calls on the specified portions to immediately return with an appropriate value (see the documentation of Shutdown).

source

pub fn try_io<F, T>(&self, f: F) -> Result<T>
where F: FnOnce() -> Result<T>,

Execute an I/O operation ensuring that the socket receives more events if it hits a WouldBlock error.

§Notes

This method is required to be called for all I/O operations to ensure the user will receive events once the socket is ready again after returning a WouldBlock error.

§Examples

use std::io;
use std::os::fd::AsRawFd;
use mio::net::UnixDatagram;

let (dgram1, dgram2) = UnixDatagram::pair()?;

// Wait until the dgram is writable...

// Write to the dgram using a direct libc call, of course the
// `io::Write` implementation would be easier to use.
let buf = b"hello";
let n = dgram1.try_io(|| {
    let buf_ptr = &buf as *const _ as *const _;
    let res = unsafe { libc::send(dgram1.as_raw_fd(), buf_ptr, buf.len(), 0) };
    if res != -1 {
        Ok(res as usize)
    } else {
        // If EAGAIN or EWOULDBLOCK is set by libc::send, the closure
        // should return `WouldBlock` error.
        Err(io::Error::last_os_error())
    }
})?;
eprintln!("write {} bytes", n);

// Wait until the dgram is readable...

// Read from the dgram using a direct libc call, of course the
// `io::Read` implementation would be easier to use.
let mut buf = [0; 512];
let n = dgram2.try_io(|| {
    let buf_ptr = &mut buf as *mut _ as *mut _;
    let res = unsafe { libc::recv(dgram2.as_raw_fd(), buf_ptr, buf.len(), 0) };
    if res != -1 {
        Ok(res as usize)
    } else {
        // If EAGAIN or EWOULDBLOCK is set by libc::recv, the closure
        // should return `WouldBlock` error.
        Err(io::Error::last_os_error())
    }
})?;
eprintln!("read {} bytes", n);