Struct UnixDatagram

Source

pub struct UnixDatagram { /* private fields */ }

Expand description

A Unix datagram socket.

§Examples

use unix_socket::UnixDatagram;

let socket = UnixDatagram::bind("/path/to/my/socket").unwrap();
socket.send_to(b"hello world", "/path/to/other/socket").unwrap();
let mut buf = [0; 100];
let (count, address) = socket.recv_from(&mut buf).unwrap();
println!("socket {:?} sent us {:?}", address, &buf[..count]);

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.

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::UnixDatagram;

let socket = UnixDatagram::bind("/path/to/my/socket").unwrap();

Source

pub fn unbound() -> Result<UnixDatagram>

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

§Examples

use unix_socket::UnixDatagram;

let socket = UnixDatagram::unbound().unwrap();

Source

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

Create an unnamed pair of connected sockets.

Returns two UnixDatagramss which are connected to each other.

§Examples

use unix_socket::UnixDatagram;

let (socket1, socket2) = UnixDatagram::pair().unwrap();

Source

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

Connects the socket to the specified address.

The send method may be used to send data to the specified address. recv and recv_from will only receive data from that address.

§Examples

use unix_socket::UnixDatagram;

let socket = UnixDatagram::bind("/path/to/my/socket").unwrap();
socket.connect("/path/to/other/socket").unwrap();

Source

pub fn try_clone(&self) -> Result<UnixDatagram>

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::UnixDatagram;

let socket = UnixDatagram::unbound().unwrap();
let copy = socket.try_clone().unwrap();

Source

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

Returns the address of this socket.

§Example

use unix_socket::UnixDatagram;

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

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.

§Example

use unix_socket::UnixDatagram;

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

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.

§Examples

use unix_socket::UnixDatagram;

let socket = UnixDatagram::bind("/path/to/my/socket").unwrap();
let mut buf = [0; 100];
let (count, address) = socket.recv_from(&mut buf).unwrap();
println!("socket {:?} sent us {:?}", address, &buf[..count]);

Source

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

Receives data from the socket.

On success, returns the number of bytes read.

§Examples

use unix_socket::UnixDatagram;

let socket = UnixDatagram::bind("/path/to/my/socket").unwrap();
socket.connect("/path/to/other/socket").unwrap();
let mut buf = [0; 100];
let count = socket.recv(&mut buf).unwrap();
println!("we received {:?}", &buf[..count]);

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.

§Examples

use unix_socket::UnixDatagram;

let socket = UnixDatagram::bind("/path/to/my/socket").unwrap();

let mut data = b"hello world";
let mut sent = 0;
while sent < data.len() {
    match socket.send_to(&data[sent..(data.len() - sent)], "/path/to/other/socket") {
        Ok(data_sent) => { sent += data_sent; }
        Err(_) => {
            println!("an error occured while sending data...");
            break;
        }
    }
}

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.

§Examples

use unix_socket::UnixDatagram;

let socket = UnixDatagram::bind("/path/to/my/socket").unwrap();
socket.connect("/path/to/other/socket").unwrap();

let mut data = b"hello world";
let mut sent = 0;
while sent < data.len() {
    match socket.send(&data[sent..(data.len() - sent)]) {
        Ok(data_sent) => { sent += data_sent; }
        Err(_) => {
            println!("an error occured while sending data...");
            break;
        }
    }
}

Source

pub fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<()>

Sets the read timeout for the socket.

If the provided value is None, then recv and recv_from calls will block indefinitely. It is an error to pass the zero Duration to this method.

§Example

use unix_socket::UnixDatagram;
use std::time::Duration;

let socket = UnixDatagram::bind("/path/to/my/socket").unwrap();
socket.set_read_timeout(Some(Duration::from_millis(1500))).unwrap();

Source

pub fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<()>

Sets the write timeout for the socket.

If the provided value is None, then send and send_to calls will block indefinitely. It is an error to pass the zero Duration to this method.

§Example

use unix_socket::UnixDatagram;
use std::time::Duration;

let socket = UnixDatagram::bind("/path/to/my/socket").unwrap();
socket.set_write_timeout(Some(Duration::from_millis(1500))).unwrap();

Source

pub fn read_timeout(&self) -> Result<Option<Duration>>

Returns the read timeout of this socket.

§Example

use unix_socket::UnixDatagram;

let socket = UnixDatagram::bind("/path/to/my/socket").unwrap();
println!("{}", match socket.read_timeout() {
    Ok(timeout) => format!("read timeout: {:?}", timeout),
    Err(_) => "error".to_owned(),
});

Source

pub fn write_timeout(&self) -> Result<Option<Duration>>

Returns the write timeout of this socket.

§Example

use unix_socket::UnixDatagram;

let socket = UnixDatagram::bind("/path/to/my/socket").unwrap();
println!("{}", match socket.write_timeout() {
    Ok(timeout) => format!("write timeout: {:?}", timeout),
    Err(_) => "error".to_owned(),
});

Source

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

Moves the socket into or out of nonblocking mode.

§Example

use unix_socket::UnixDatagram;

let socket = UnixDatagram::bind("/path/to/my/socket").unwrap();
socket.set_nonblocking(true).unwrap();

Source

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

Returns the value of the SO_ERROR option.

§Example

use unix_socket::UnixDatagram;

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

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).

§Example

use std::net::Shutdown;
use unix_socket::UnixDatagram;

let socket = UnixDatagram::bind("/path/to/my/socket").unwrap();
socket.connect("/path/to/other/socket").unwrap();
socket.shutdown(Shutdown::Both).unwrap();