Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

UDP transport

UDP transport wrapper for Tokio’s UdpSocket.

This transport inherits UDP semantics:

  • unreliable: messages may be dropped,
  • unordered: messages may arrive out of order or be duplicated,
  • size-limited: messages are bounded by the datagram size for the underlying socket.

The transport type is UdpTransport<U, Codec, Incoming, Outgoing> where U borrows a UdpSocket. It supports both connected sockets via Sink<Outgoing> and unconnected send via send_to.

Warning

This is an unreliable transport.
Messages may be dropped, arrive out of order, or be delivered multiple times.

Example

Connected UDP

use futures::SinkExt;
use tokio::net::UdpSocket;
use dnet::{codecs::BincodeCodec, udp::UdpTransport, Receive};

let udp_socket = UdpSocket::bind("127.0.0.1:1234").await?;
udp_socket.connect("127.0.0.1:1235").await?;
let mut transport = UdpTransport::new(udp_socket, BincodeCodec::default());

transport.send("hello".to_string()).await?;
let reply: String = transport.receive().await?;

Unconnected send/receive

use tokio::net::UdpSocket;
use dnet::{codecs::BincodeCodec, udp::UdpTransport};

let udp_socket = UdpSocket::bind("127.0.0.1:1236").await?;
let mut transport = UdpTransport::new(udp_socket, BincodeCodec::default());

transport.send_to("hello".to_string(), "127.0.0.1:1237").await?;
let (message, peer_addr) = transport.receive_from().await?;
println!("received {:?} from {}", message, peer_addr);

Notes

  • Use send_to when you need to send to different endpoints.
  • Use the sink interface after UdpSocket::connect(...) for a simple connected UDP workflow.
  • Use receive_from() if you need the sender address for each incoming message.