Struct UdpSocket

Source

pub struct UdpSocket { /* private fields */ }

Expand description

A UDP socket.

Implementations§

Source §

impl UdpSocket

Source

pub fn bind(addr: &SocketAddr) -> Result<UdpSocket>

Creates a UDP socket from the given address.

Binding with a port number of 0 will request that the OS assigns a port to this socket. The port allocated can be queried via the local_addr method.

§Examples

use futures_net::udp::UdpSocket;

let socket_addr = "127.0.0.1:0".parse()?;
let socket = UdpSocket::bind(&socket_addr)?;

Source

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

Returns the local address that this listener is bound to.

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

§Examples

use futures_net::udp::UdpSocket;

println!("Socket addr: {:?}", socket.local_addr());

Source

pub fn send_to<'a, 'b>( &'a mut self, buf: &'b [u8], target: &'b SocketAddr, ) -> SendTo<'a, 'b> ⓘ

Sends data on the socket to the given address. On success, returns the number of bytes written.

§Examples

use futures_net::udp::UdpSocket;

const THE_MERCHANT_OF_VENICE: &[u8] = b"
    If you prick us, do we not bleed?
    If you tickle us, do we not laugh?
    If you poison us, do we not die?
    And if you wrong us, shall we not revenge?
";

let addr = "127.0.0.1:0".parse()?;
let target = "127.0.0.1:7878".parse()?;
let mut socket = UdpSocket::bind(&addr)?;

socket.send_to(THE_MERCHANT_OF_VENICE, &target).await?;

Source

pub fn recv_from<'a, 'b>(&'a mut self, buf: &'b mut [u8]) -> RecvFrom<'a, 'b> ⓘ

Receives data from the socket. On success, returns the number of bytes read and the address from whence the data came.

§Exampes

use futures_net::udp::UdpSocket;

let addr = "127.0.0.1:0".parse()?;
let mut socket = UdpSocket::bind(&addr)?;
let mut buf = vec![0; 1024];

socket.recv_from(&mut buf).await?;

Source

pub fn broadcast(&self) -> Result<bool>

Gets the value of the SO_BROADCAST option for this socket.

For more information about this option, see set_broadcast.

Source

pub fn set_broadcast(&self, on: 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.

Source

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 set_multicast_loop_v4.

Source

pub fn set_multicast_loop_v4(&self, on: 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

This may not have any affect on IPv6 sockets.

Source

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 set_multicast_ttl_v4.

Source

pub fn set_multicast_ttl_v4(&self, ttl: 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

This may not have any affect on IPv6 sockets.

Source

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 set_multicast_loop_v6.

Source

pub fn set_multicast_loop_v6(&self, on: 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

This may not have any affect on IPv4 sockets.

Source

pub fn ttl(&self) -> Result<u32>

Gets the value of the IP_TTL option for this socket.

For more information about this option, see set_ttl.

Source

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.

Source

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.

§Examples

use futures_net::udp::UdpSocket;
use std::net::Ipv4Addr;

let socket_addr = "127.0.0.1:0".parse()?;
let interface = Ipv4Addr::new(0, 0, 0, 0);
let mdns_addr = Ipv4Addr::new(224, 0, 0, 123);

let socket = UdpSocket::bind(&socket_addr)?;
socket.join_multicast_v4(&mdns_addr, &interface)?;

Source

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).

§Examples

use futures_net::udp::UdpSocket;
use std::net::{Ipv6Addr, SocketAddr};
let socket_addr = SocketAddr::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).into(), 0);
let mdns_addr = Ipv6Addr::new(0xFF02, 0, 0, 0, 0, 0, 0, 0x0123) ;
let socket = UdpSocket::bind(&socket_addr)?;

socket.join_multicast_v6(&mdns_addr, 0)?;