pub struct UdpSocket(/* private fields */);
Expand description
A UDP socket.
After creating a UdpSocket
by bind
ing it to a socket address, data can be
sent to and received from any other socket address.
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 std::net::UdpSocket;
fn main() -> std::io::Result<()> {
{
let socket = UdpSocket::bind("127.0.0.1:34254")?;
// Receives a single datagram message on the socket. If `buf` is too small to hold
// the message, it will be cut off.
let mut buf = [0; 10];
let (amt, src) = socket.recv_from(&mut buf)?;
// Redeclare `buf` as slice of the received data and send reverse data back to origin.
let buf = &mut buf[..amt];
buf.reverse();
socket.send_to(buf, &src)?;
} // the socket is closed here
Ok(())
}
Implementations§
source§impl UdpSocket
impl UdpSocket
1.0.0 · sourcepub fn bind<A: ToSocketAddrs>(addr: A) -> Result<UdpSocket>
pub fn bind<A: ToSocketAddrs>(addr: A) -> Result<UdpSocket>
Creates a UDP socket from the given address.
The address type can be any implementor of ToSocketAddrs
trait. See
its documentation for concrete examples.
If addr
yields multiple addresses, bind
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 returned from
the last attempt (the last address) is returned.
§Examples
Creates a UDP socket bound to 127.0.0.1:3400
:
use std::net::UdpSocket;
let socket = UdpSocket::bind("127.0.0.1:3400").expect("couldn't bind to address");
Creates a UDP socket bound to 127.0.0.1:3400
. If the socket cannot be
bound to that address, create a UDP socket bound to 127.0.0.1:3401
:
use std::net::{SocketAddr, UdpSocket};
let addrs = [
SocketAddr::from(([127, 0, 0, 1], 3400)),
SocketAddr::from(([127, 0, 0, 1], 3401)),
];
let socket = UdpSocket::bind(&addrs[..]).expect("couldn't bind to address");
Creates a UDP socket bound to a port assigned by the operating system
at 127.0.0.1
.
Note that bind
declares the scope of your network connection.
You can only receive datagrams from and send datagrams to
participants in that view of the network.
For instance, binding to a loopback address as in the example
above will prevent you from sending datagrams to another device
in your local network.
In order to limit your view of the network the least, bind
to
Ipv4Addr::UNSPECIFIED
or Ipv6Addr::UNSPECIFIED
.
1.0.0 · sourcepub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>
pub 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
1.18.0 · sourcepub fn peek_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>
pub 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.
Successive calls return the same data. This is accomplished by passing
MSG_PEEK
as a flag to the underlying recvfrom
system call.
Do not use this function to implement busy waiting, instead use libc::poll
to
synchronize IO events on one or more sockets.
§Examples
1.0.0 · sourcepub fn send_to<A: ToSocketAddrs>(&self, buf: &[u8], addr: A) -> Result<usize>
pub 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. Note that the operating system may refuse
buffers larger than 65507. However, partial writes are not possible
until buffer sizes above i32::MAX
.
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
.
This will return an error when the IP version of the local socket
does not match that returned from ToSocketAddrs
.
See Issue #34202 for more details.
§Examples
1.40.0 · sourcepub fn peer_addr(&self) -> Result<SocketAddr>
pub fn peer_addr(&self) -> Result<SocketAddr>
Returns the socket address of the remote peer this socket was connected to.
§Examples
use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4, UdpSocket};
let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
socket.connect("192.168.0.1:41203").expect("couldn't connect to address");
assert_eq!(socket.peer_addr().unwrap(),
SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::new(192, 168, 0, 1), 41203)));
If the socket isn’t connected, it will return a NotConnected
error.
1.0.0 · sourcepub fn local_addr(&self) -> Result<SocketAddr>
pub fn local_addr(&self) -> Result<SocketAddr>
Returns the socket address that this socket was created from.
§Examples
1.0.0 · sourcepub fn try_clone(&self) -> Result<UdpSocket>
pub fn try_clone(&self) -> Result<UdpSocket>
Creates a new independently owned handle to the underlying socket.
The returned UdpSocket
is a reference to the same socket that this
object references. Both handles will read and write the same port, and
options set on one socket will be propagated to the other.
§Examples
1.4.0 · sourcepub fn set_read_timeout(&self, dur: Option<Duration>) -> Result<()>
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.
§Platform-specific behavior
Platforms may return a different error code whenever a read times out as
a result of setting this option. For example Unix typically returns an
error of the kind WouldBlock
, but Windows may return TimedOut
.
§Examples
use std::net::UdpSocket;
let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
socket.set_read_timeout(None).expect("set_read_timeout call failed");
An Err
is returned if the zero Duration
is passed to this
method:
1.4.0 · sourcepub fn set_write_timeout(&self, dur: Option<Duration>) -> Result<()>
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.
§Platform-specific behavior
Platforms may return a different error code whenever a write times out
as a result of setting this option. For example Unix typically returns
an error of the kind WouldBlock
, but Windows may return TimedOut
.
§Examples
use std::net::UdpSocket;
let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
socket.set_write_timeout(None).expect("set_write_timeout call failed");
An Err
is returned if the zero Duration
is passed to this
method:
1.4.0 · sourcepub fn read_timeout(&self) -> Result<Option<Duration>>
pub fn read_timeout(&self) -> Result<Option<Duration>>
1.4.0 · sourcepub fn write_timeout(&self) -> Result<Option<Duration>>
pub fn write_timeout(&self) -> Result<Option<Duration>>
1.9.0 · sourcepub fn set_broadcast(&self, broadcast: bool) -> Result<()>
pub fn set_broadcast(&self, broadcast: bool) -> Result<()>
Sets the value of the SO_BROADCAST
option for this socket.
When enabled, this socket is allowed to send packets to a broadcast address.
§Examples
1.9.0 · sourcepub fn broadcast(&self) -> Result<bool>
pub fn broadcast(&self) -> Result<bool>
Gets the value of the SO_BROADCAST
option for this socket.
For more information about this option, see UdpSocket::set_broadcast
.
§Examples
1.9.0 · sourcepub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> Result<()>
pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> Result<()>
Sets the value of the IP_MULTICAST_LOOP
option for this socket.
If enabled, multicast packets will be looped back to the local socket. Note that this might not have any effect on IPv6 sockets.
§Examples
1.9.0 · sourcepub fn multicast_loop_v4(&self) -> Result<bool>
pub fn multicast_loop_v4(&self) -> Result<bool>
Gets the value of the IP_MULTICAST_LOOP
option for this socket.
For more information about this option, see UdpSocket::set_multicast_loop_v4
.
§Examples
1.9.0 · sourcepub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> Result<()>
pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> Result<()>
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 might not have any effect on IPv6 sockets.
§Examples
1.9.0 · sourcepub fn multicast_ttl_v4(&self) -> Result<u32>
pub fn multicast_ttl_v4(&self) -> Result<u32>
Gets the value of the IP_MULTICAST_TTL
option for this socket.
For more information about this option, see UdpSocket::set_multicast_ttl_v4
.
§Examples
1.9.0 · sourcepub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> Result<()>
pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> Result<()>
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 might not have any affect on IPv4 sockets.
§Examples
1.9.0 · sourcepub fn multicast_loop_v6(&self) -> Result<bool>
pub fn multicast_loop_v6(&self) -> Result<bool>
Gets the value of the IPV6_MULTICAST_LOOP
option for this socket.
For more information about this option, see UdpSocket::set_multicast_loop_v6
.
§Examples
1.9.0 · sourcepub fn set_ttl(&self, ttl: u32) -> Result<()>
pub fn set_ttl(&self, ttl: u32) -> Result<()>
Sets the value for the IP_TTL
option on this socket.
This value sets the time-to-live field that is used in every packet sent from this socket.
§Examples
1.9.0 · sourcepub fn ttl(&self) -> Result<u32>
pub fn ttl(&self) -> Result<u32>
Gets the value of the IP_TTL
option for this socket.
For more information about this option, see UdpSocket::set_ttl
.
§Examples
1.9.0 · sourcepub fn join_multicast_v4(
&self,
multiaddr: &Ipv4Addr,
interface: &Ipv4Addr,
) -> Result<()>
pub fn join_multicast_v4( &self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr, ) -> Result<()>
Executes an operation of the IP_ADD_MEMBERSHIP
type.
This function specifies a new multicast group for this socket to join.
The address 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.
1.9.0 · sourcepub fn join_multicast_v6(
&self,
multiaddr: &Ipv6Addr,
interface: u32,
) -> Result<()>
pub fn join_multicast_v6( &self, multiaddr: &Ipv6Addr, interface: u32, ) -> Result<()>
Executes an operation of the IPV6_ADD_MEMBERSHIP
type.
This function specifies a new multicast group for this socket to join.
The address must be a valid multicast address, and interface
is the
index of the interface to join/leave (or 0 to indicate any interface).
1.9.0 · sourcepub fn leave_multicast_v4(
&self,
multiaddr: &Ipv4Addr,
interface: &Ipv4Addr,
) -> Result<()>
pub fn leave_multicast_v4( &self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr, ) -> Result<()>
Executes an operation of the IP_DROP_MEMBERSHIP
type.
For more information about this option, see UdpSocket::join_multicast_v4
.
1.9.0 · sourcepub fn leave_multicast_v6(
&self,
multiaddr: &Ipv6Addr,
interface: u32,
) -> Result<()>
pub fn leave_multicast_v6( &self, multiaddr: &Ipv6Addr, interface: u32, ) -> Result<()>
Executes an operation of the IPV6_DROP_MEMBERSHIP
type.
For more information about this option, see UdpSocket::join_multicast_v6
.
1.9.0 · sourcepub fn take_error(&self) -> Result<Option<Error>>
pub fn take_error(&self) -> Result<Option<Error>>
Gets the value of the SO_ERROR
option on this socket.
This will retrieve the stored error in the underlying socket, clearing the field in the process. This can be useful for checking errors between calls.
§Examples
1.9.0 · sourcepub fn connect<A: ToSocketAddrs>(&self, addr: A) -> Result<()>
pub fn connect<A: ToSocketAddrs>(&self, addr: A) -> Result<()>
Connects this UDP socket to a remote address, allowing the send
and
recv
syscalls 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
Creates a UDP socket bound to 127.0.0.1:3400
and connect the socket to
127.0.0.1:8080
:
use std::net::UdpSocket;
let socket = UdpSocket::bind("127.0.0.1:3400").expect("couldn't bind to address");
socket.connect("127.0.0.1:8080").expect("connect function failed");
Unlike in the TCP case, passing an array of addresses to the connect
function of a UDP socket is not a useful thing to do: The OS will be
unable to determine whether something is listening on the remote
address without the application sending data.
If your first connect
is to a loopback address, subsequent
connect
s to non-loopback addresses might fail, depending
on the platform.
1.9.0 · sourcepub fn send(&self, buf: &[u8]) -> Result<usize>
pub fn send(&self, buf: &[u8]) -> Result<usize>
Sends data on the socket to the remote address to which it is connected.
On success, returns the number of bytes written. Note that the operating
system may refuse buffers larger than 65507. However, partial writes are
not possible until buffer sizes above i32::MAX
.
UdpSocket::connect
will connect this socket to a remote address. This
method will fail if the socket is not connected.
§Examples
1.9.0 · sourcepub fn recv(&self, buf: &mut [u8]) -> Result<usize>
pub 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.
UdpSocket::connect
will connect this socket to a remote address. This
method will fail if the socket is not connected.
§Examples
use std::net::UdpSocket;
let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
socket.connect("127.0.0.1:8080").expect("connect function failed");
let mut buf = [0; 10];
match socket.recv(&mut buf) {
Ok(received) => println!("received {received} bytes {:?}", &buf[..received]),
Err(e) => println!("recv function failed: {e:?}"),
}
1.18.0 · sourcepub fn peek(&self, buf: &mut [u8]) -> Result<usize>
pub 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.
Successive calls return the same data. This is accomplished by passing
MSG_PEEK
as a flag to the underlying recv
system call.
Do not use this function to implement busy waiting, instead use libc::poll
to
synchronize IO events on one or more sockets.
UdpSocket::connect
will connect this socket to a remote address. This
method will fail if the socket is not connected.
§Errors
This method will fail if the socket is not connected. The connect
method
will connect this socket to a remote address.
§Examples
use std::net::UdpSocket;
let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
socket.connect("127.0.0.1:8080").expect("connect function failed");
let mut buf = [0; 10];
match socket.peek(&mut buf) {
Ok(received) => println!("received {received} bytes"),
Err(e) => println!("peek function failed: {e:?}"),
}
1.9.0 · sourcepub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>
pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>
Moves this UDP socket into or out of nonblocking mode.
This will result in recv
, recv_from
, send
, and send_to
operations becoming nonblocking, i.e., immediately returning from their
calls. If the IO operation is successful, Ok
is returned and no
further action is required. If the IO operation could not be completed
and needs to be retried, an error with kind
io::ErrorKind::WouldBlock
is returned.
On Unix platforms, calling this method corresponds to calling fcntl
FIONBIO
. On Windows calling this method corresponds to calling
ioctlsocket
FIONBIO
.
§Examples
Creates a UDP socket bound to 127.0.0.1:7878
and read bytes in
nonblocking mode:
use std::io;
use std::net::UdpSocket;
let socket = UdpSocket::bind("127.0.0.1:7878").unwrap();
socket.set_nonblocking(true).unwrap();
let mut buf = [0; 10];
let (num_bytes_read, _) = loop {
match socket.recv_from(&mut buf) {
Ok(n) => break n,
Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => {
// wait until network socket is ready, typically implemented
// via platform-specific APIs such as epoll or IOCP
wait_for_fd();
}
Err(e) => panic!("encountered IO error: {e}"),
}
};
println!("bytes: {:?}", &buf[..num_bytes_read]);