Struct std::os::unix::net::UnixDatagram
[−]
[src]
pub struct UnixDatagram(_);
A Unix datagram socket.
Examples
#![feature(unix_socket)] fn main() { use std::os::unix::net::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 {:?}", address, &buf[..count]); }#![feature(unix_socket)] use std::os::unix::net::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 {:?}", address, &buf[..count]);
Methods
impl UnixDatagram
fn bind<P: AsRef<Path>>(path: P) -> Result<UnixDatagram>
Creates a Unix datagram socket bound to the given path.
fn unbound() -> Result<UnixDatagram>
Creates a Unix Datagram socket which is not bound to any address.
fn pair() -> Result<(UnixDatagram, UnixDatagram)>
Create an unnamed pair of connected sockets.
Returns two UnixDatagrams
s which are connected to each other.
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.
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.
fn local_addr(&self) -> Result<SocketAddr>
Returns the address of this socket.
fn peer_addr(&self) -> Result<SocketAddr>
Returns the address of this socket's peer.
The connect
method will connect the socket to a peer.
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.
fn recv(&self, buf: &mut [u8]) -> Result<usize>
Receives data from the socket.
On success, returns the number of bytes read.
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.
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.
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.
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.
fn read_timeout(&self) -> Result<Option<Duration>>
Returns the read timeout of this socket.
fn write_timeout(&self) -> Result<Option<Duration>>
Returns the write timeout of this socket.
fn set_nonblocking(&self, nonblocking: bool) -> Result<()>
Moves the socket into or out of nonblocking mode.
fn take_error(&self) -> Result<Option<Error>>
Returns the value of the SO_ERROR
option.
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
).