Struct async_net::UdpSocket

source · [−]
pub struct UdpSocket { /* private fields */ }
Expand description

A UDP socket.

After creating a UdpSocket by binding it to a socket address, data can be sent to and received from any other socket address.

Cloning a UdpSocket creates another handle to the same socket. The socket will be closed when all handles to it are dropped.

Although UDP is a connectionless protocol, this implementation provides an interface to set an address where data should be sent and received from. After setting a remote address with connect(), data can be sent to and received from that address with send() and recv().

As stated in the User Datagram Protocol’s specification in IETF RFC 768, UDP is an unordered, unreliable protocol. Refer to TcpListener and TcpStream for TCP primitives.

Examples

use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:8080").await?;
let mut buf = vec![0u8; 20];

loop {
    // Receive a single datagram message.
    // If `buf` is too small to hold the entire message, it will be cut off.
    let (n, addr) = socket.recv_from(&mut buf).await?;

    // Send the message back to the same address that has sent it.
    socket.send_to(&buf[..n], &addr).await?;
}

Implementations

Creates a new UdpSocket bound to the given address.

Binding with a port number of 0 will request that the operating system assigns an available port to this socket. The assigned port can be queried via the local_addr() method.

If addr yields multiple addresses, binding will be attempted with each of the addresses until one succeeds and returns the socket. If none of the addresses succeed in creating a socket, the error from the last attempt is returned.

Examples

Create a UDP socket bound to 127.0.0.1:3400:

use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:3400").await?;

Create a UDP socket bound to 127.0.0.1:3400. If that address is unavailable, then try binding to 127.0.0.1:3401:

use async_net::{SocketAddr, UdpSocket};

let addrs = [
    SocketAddr::from(([127, 0, 0, 1], 3400)),
    SocketAddr::from(([127, 0, 0, 1], 3401)),
];
let socket = UdpSocket::bind(&addrs[..]).await?;

Returns the local address this socket is bound to.

This can be useful, for example, when binding to port 0 to figure out which port was actually bound.

Examples

Bind to port 0 and then see which port was assigned by the operating system:

use async_net::{SocketAddr, UdpSocket};

let socket = UdpSocket::bind("127.0.0.1:0").await?;
println!("Bound to {}", socket.local_addr()?);

Returns the remote address this socket is connected to.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
socket.connect("192.168.0.1:41203").await?;
println!("Connected to {}", socket.peer_addr()?);

Connects the UDP socket to an address.

When connected, methods send() and recv() will use the specified address for sending and receiving messages. Additionally, a filter will be applied to recv_from() so that it only receives messages from that same address.

If addr yields multiple addresses, connecting will be attempted with each of the addresses until the operating system accepts one. If none of the addresses are accepted, the error from the last attempt is returned.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:3400").await?;
socket.connect("127.0.0.1:8080").await?;

Receives a single datagram message.

On success, returns the number of bytes received and the address message came from.

This method must be called with a valid byte buffer of sufficient size to hold a message. If the received message is too long to fit into the buffer, it may be truncated.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;

let mut buf = vec![0u8; 1024];
let (n, addr) = socket.recv_from(&mut buf).await?;
println!("Received {} bytes from {}", n, addr);

Receives a single datagram message without removing it from the queue.

On success, returns the number of bytes peeked and the address message came from.

This method must be called with a valid byte buffer of sufficient size to hold a message. If the received message is too long to fit into the buffer, it may be truncated.

Successive calls return the same message. This is accomplished by passing MSG_PEEK as a flag to the underlying recvfrom system call.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;

let mut buf = vec![0u8; 1024];
let (n, addr) = socket.peek_from(&mut buf).await?;
println!("Peeked {} bytes from {}", n, addr);

Sends data to the given address.

On success, returns the number of bytes sent.

If addr yields multiple addresses, the message will only be sent to the first address.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
socket.send_to(b"hello", "127.0.0.1:4242").await?;

Receives a single datagram message from the connected address.

On success, returns the number of bytes received.

This method must be called with a valid byte buffer of sufficient size to hold a message. If the received message is too long to fit into the buffer, it may be truncated.

The connect() method connects this socket to an address. This method will fail if the socket is not connected.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
socket.connect("127.0.0.1:8080").await?;

let mut buf = vec![0u8; 1024];
let n = socket.recv(&mut buf).await?;
println!("Received {} bytes", n);

Receives a single datagram from the connected address without removing it from the queue.

On success, returns the number of bytes peeked.

This method must be called with a valid byte buffer of sufficient size to hold a message. If the received message is too long to fit into the buffer, it may be truncated.

Successive calls return the same message. This is accomplished by passing MSG_PEEK as a flag to the underlying recv system call.

The connect() method connects this socket to an address. This method will fail if the socket is not connected.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
socket.connect("127.0.0.1:8080").await?;

let mut buf = vec![0u8; 1024];
let n = socket.peek(&mut buf).await?;
println!("Peeked {} bytes", n);

Sends data to the connected address.

The connect() method connects this socket to an address. This method will fail if the socket is not connected.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
socket.connect("127.0.0.1:8080").await?;
socket.send(b"hello").await?;

Gets the value of the SO_BROADCAST option for this socket.

If set to true, this socket is allowed to send packets to a broadcast address.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
println!("SO_BROADCAST is set to {}", socket.broadcast()?);

Sets the value of the SO_BROADCAST option for this socket.

If set to true, this socket is allowed to send packets to a broadcast address.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
socket.set_broadcast(true)?;

Gets the value of the IP_MULTICAST_LOOP option for this socket.

If set to true, multicast packets will be looped back to the local socket.

Note that this option may not have any affect on IPv6 sockets.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
println!("IP_MULTICAST_LOOP is set to {}", socket.multicast_loop_v4()?);

Sets the value of the IP_MULTICAST_LOOP option for this socket.

If set to true, multicast packets will be looped back to the local socket.

Note that this option may not have any affect on IPv6 sockets.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
socket.set_multicast_loop_v4(true)?;

Gets the value of the IP_MULTICAST_TTL option for this socket.

Indicates the time-to-live value of outgoing multicast packets for this socket. The default value is 1, which means that multicast packets don’t leave the local network unless explicitly requested.

Note that this option may not have any effect on IPv6 sockets.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
println!("IP_MULTICAST_TTL is set to {}", socket.multicast_loop_v4()?);

Sets the value of the IP_MULTICAST_TTL option for this socket.

Indicates the time-to-live value of outgoing multicast packets for this socket. The default value is 1, which means that multicast packets don’t leave the local network unless explicitly requested.

Note that this option may not have any effect on IPv6 sockets.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
socket.set_multicast_ttl_v4(10)?;

Gets the value of the IPV6_MULTICAST_LOOP option for this socket.

Controls whether this socket sees the multicast packets it sends itself.

Note that this option may not have any effect on IPv4 sockets.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
println!("IPV6_MULTICAST_LOOP is set to {}", socket.multicast_loop_v6()?);

Sets the value of the IPV6_MULTICAST_LOOP option for this socket.

Controls whether this socket sees the multicast packets it sends itself.

Note that this option may not have any effect on IPv4 sockets.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
socket.set_multicast_loop_v6(true)?;

Gets the value of the IP_TTL option for this socket.

This option configures the time-to-live field that is used in every packet sent from this socket.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
println!("IP_TTL is set to {}", socket.ttl()?);

Sets the value of the IP_TTL option for this socket.

This option configures the time-to-live field that is used in every packet sent from this socket.

Examples
use async_net::UdpSocket;

let socket = UdpSocket::bind("127.0.0.1:34254").await?;
socket.set_ttl(100)?;

Executes an operation of the IP_ADD_MEMBERSHIP type.

This method specifies a new multicast group for this socket to join. Argument multiaddr must be a valid multicast address, and interface is the address of the local interface with which the system should join the multicast group. If it’s equal to INADDR_ANY then an appropriate interface is chosen by the system.

Executes an operation of the IP_DROP_MEMBERSHIP type.

This method leaves a multicast group. Argument multiaddr must be a valid multicast address, and interface is the index of the interface to leave.

Executes an operation of the IPV6_ADD_MEMBERSHIP type.

This method specifies a new multicast group for this socket to join. Argument multiaddr must be a valid multicast address, and interface is the index of the interface to join (or 0 to indicate any interface).

Executes an operation of the IPV6_DROP_MEMBERSHIP type.

This method leaves a multicast group. Argument multiaddr must be a valid multicast address, and interface is the index of the interface to leave.

Trait Implementations

Borrows the file descriptor. Read more

Extracts the raw file descriptor. Read more

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Converts to this type from the input type.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.