Struct glommio::net::UdpSocket

pub struct UdpSocket { /* fields omitted */ }

An Udp Socket.

Implementations

impl UdpSocket

pub fn bind<A: ToSocketAddrs>(addr: A) -> Result<UdpSocket, ()>

Creates a UDP socket bound to the specified address.

Binding with port number 0 will request an available port from the OS.

This sets the ReusePort option on the socket, so if the OS-provided load balancing is enough, it is possible to just bind to the same address from multiple executors.

Examples

use glommio::{net::UdpSocket, LocalExecutor};

let ex = LocalExecutor::default();
ex.run(async move {
    let listener = UdpSocket::bind("127.0.0.1:8000").unwrap();
    println!("Listening on {}", listener.local_addr().unwrap());
});

pub async fn connect<A: ToSocketAddrs>(&self, addr: A) -> Result<(), ()>

Connects this UDP socket to a remote address, allowing the send and recv methods to be used to send data and also applies filters to only receive data from the specified address.

If addr yields multiple addresses, connect will be attempted with each of the addresses until the underlying OS function returns no error. Note that usually, a successful connect call does not specify that there is a remote server listening on the port, rather, such an error would only be detected after the first send. If the OS returns an error for each of the specified addresses, the error returned from the last connection attempt (the last address) is returned.

Examples

use glommio::{net::UdpSocket, LocalExecutor};

let ex = LocalExecutor::default();
ex.run(async move {
    let receiver = UdpSocket::bind("127.0.0.1:0").unwrap();
    let sender = UdpSocket::bind("127.0.0.1:0").unwrap();
    receiver
        .connect(sender.local_addr().unwrap())
        .await
        .unwrap();
    sender
        .connect(receiver.local_addr().unwrap())
        .await
        .unwrap();
});

pub fn set_buffer_size(&mut self, buffer_size: usize)

Sets the buffer size used on the receive path

pub fn buffer_size(&mut self) -> usize

gets the buffer size used

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

Sets the read timeout to the timeout specified.

If the value specified is None, then read calls will block indefinitely. An Err is returned if the zero Duration is passed to this method.

Examples

let s = UdpSocket::bind("127.0.0.1:10000").unwrap();
s.set_read_timeout(Some(Duration::from_secs(1))).unwrap();

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

Sets the write timeout to the timeout specified.

If the value specified is None, then write calls will block indefinitely. An Err is returned if the zero Duration is passed to this method.

let s = UdpSocket::bind("127.0.0.1:10000").unwrap();
s.set_write_timeout(Some(Duration::from_secs(1))).unwrap();

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

Returns the read timeout of this socket.

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

Returns the write timeout of this socket.

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

Receives single datagram on the socket from the remote address to which it is connected, without removing the message from input queue. On success, returns the number of bytes peeked.

The function must be called with valid byte array buf of sufficient size to hold the message bytes. If a message is too long to fit in the supplied buffer, excess bytes may be discarded.

To use this function, connect must have been called

Examples

use glommio::{net::UdpSocket, LocalExecutor};

let ex = LocalExecutor::default();
ex.run(async move {
    let receiver = UdpSocket::bind("127.0.0.1:0").unwrap();
    let sender = UdpSocket::bind("127.0.0.1:0").unwrap();
    receiver
        .connect(sender.local_addr().unwrap())
        .await
        .unwrap();
    sender
        .send_to(&[1; 1], receiver.local_addr().unwrap())
        .await
        .unwrap();
    let mut buf = vec![0; 32];
    let sz = receiver.peek(&mut buf).await.unwrap();
    assert_eq!(sz, 1);
})

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

Receives a single datagram message on the socket, without removing it from the queue. On success, returns the number of bytes read and the origin.

The function must be called with valid byte array buf of sufficient size to hold the message bytes. If a message is too long to fit in the supplied buffer, excess bytes may be discarded.

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

Returns the socket address of the remote peer this socket was connected to.

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

Returns the socket address of the local half of this UDP connection.

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

Receives a single datagram message on the socket from the remote address to which it is connected.

On success, returns the number of bytes read. The function must be called with valid byte array buf of sufficient size to hold the message bytes. If a message is too long to fit in the supplied buffer, excess bytes may be discarded.

To use this function, connect must have been called

Examples

use glommio::{net::UdpSocket, LocalExecutor};

let ex = LocalExecutor::default();
ex.run(async move {
    let receiver = UdpSocket::bind("127.0.0.1:0").unwrap();
    let sender = UdpSocket::bind("127.0.0.1:0").unwrap();
    receiver
        .connect(sender.local_addr().unwrap())
        .await
        .unwrap();
    sender
        .send_to(&[1; 1], receiver.local_addr().unwrap())
        .await
        .unwrap();
    let mut buf = vec![0; 32];
    let sz = receiver.recv(&mut buf).await.unwrap();
    assert_eq!(sz, 1);
})

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

Receives a single datagram message on the socket. On success, returns the number of bytes read and the origin.

The function must be called with valid byte array buf of sufficient size to hold the message bytes. If a message is too long to fit in the supplied buffer, excess bytes may be discarded.

Examples

use glommio::{net::UdpSocket, LocalExecutor};

let ex = LocalExecutor::default();
ex.run(async move {
    let receiver = UdpSocket::bind("127.0.0.1:0").unwrap();
    let sender = UdpSocket::bind("127.0.0.1:0").unwrap();
    sender
        .send_to(&[1; 1], receiver.local_addr().unwrap())
        .await
        .unwrap();
    let mut buf = vec![0; 32];
    let (sz, addr) = receiver.recv_from(&mut buf).await.unwrap();
    assert_eq!(sz, 1);
    assert_eq!(addr, sender.local_addr().unwrap());
})

pub async fn send_to<A: ToSocketAddrs>(
    &self,
    buf: &[u8],
    addr: A
) -> Result<usize, ()>

Sends data on the socket to the given address. On success, returns the number of bytes written. Address type can be any implementor of ToSocketAddrs trait. See its documentation for concrete examples. It is possible for addr to yield multiple addresses, but send_to will only send data to the first address yielded by addr.

Examples

use glommio::{net::UdpSocket, LocalExecutor};

let ex = LocalExecutor::default();
ex.run(async move {
    let receiver = UdpSocket::bind("127.0.0.1:0").unwrap();
    let sender = UdpSocket::bind("127.0.0.1:0").unwrap();
    sender
        .send_to(&[1; 1], receiver.local_addr().unwrap())
        .await
        .unwrap();
    let mut buf = vec![0; 32];
    let (sz, addr) = receiver.recv_from(&mut buf).await.unwrap();
    assert_eq!(sz, 1);
    assert_eq!(addr, sender.local_addr().unwrap());
})

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

Sends data on the socket to the remote address to which it is connected.

UdpSocket::connect will connect this socket to a remote address. This method will fail if the socket is not connected.

Examples

use glommio::{net::UdpSocket, LocalExecutor};

let ex = LocalExecutor::default();
ex.run(async move {
    let receiver = UdpSocket::bind("127.0.0.1:0").unwrap();
    let sender = UdpSocket::bind("127.0.0.1:0").unwrap();
    sender
        .connect(receiver.local_addr().unwrap())
        .await
        .unwrap();
    sender.send(&[1; 1]).await.unwrap();
})

[UdpSocket::connect]: UdpSocket::connect

Trait Implementations

impl AsRawFd for UdpSocket

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for UdpSocket

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

Formats the value using the given formatter.

impl From<Socket> for UdpSocket

fn from(socket: Socket) -> UdpSocket

Performs the conversion.

impl FromRawFd for UdpSocket

unsafe fn from_raw_fd(fd: RawFd) -> Self

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