Struct romio::UdpSocket

pub struct UdpSocket { /* fields omitted */ }

A UDP socket.

Methods

impl UdpSocket

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 romio::udp::UdpSocket;

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

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 romio::udp::UdpSocket;

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

Important traits for SendTo<'a, 'b>

impl<'a, 'b> Future for SendTo<'a, 'b> type Output = Result<usize>;

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 romio::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?;

Important traits for RecvFrom<'a, 'b>

impl<'a, 'b> Future for RecvFrom<'a, 'b> type Output = Result<(usize, SocketAddr)>;

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 romio::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?;

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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 romio::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)?;

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 romio::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)?;

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

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

Trait Implementations

impl Debug for UdpSocket

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

Formats the value using the given formatter.

impl AsRawFd for UdpSocket

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncWriteReady for UdpSocket

type Ok = Ready

The type of successful values yielded by this trait.

type Err = Error

The type of failures yielded by this trait.

fn poll_write_ready(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<Self::Ok, Self::Err>>

Check the UDP socket's write readiness state.

If the socket is not ready for sending then Poll::Pending is returned and the current task is notified once a new event is received.

The I/O resource will remain in a write-ready state until calls to poll_send return Pending.

fn poll_write_ready_unpin(
    &mut self,
    cx: &mut Context
) -> Poll<Result<Self::Ok, Self::Err>> where
    Self: Unpin, 

A convenience for calling AsyncWriteReady::poll_write_ready on Unpin types.

impl AsyncReadReady for UdpSocket where
    Self: Unpin, 

type Ok = Ready

The type of successful values yielded by this trait.

type Err = Error

The type of failures yielded by this trait.

fn poll_read_ready(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<Self::Ok, Self::Err>>

Check the UDP socket's read readiness state.

If the socket is not ready for receiving then Poll::Pending is returned and the current task is notified once a new event is received.

The socket will remain in a read-ready state until calls to poll_recv return Pending.

fn poll_read_ready_unpin(
    &mut self,
    cx: &mut Context
) -> Poll<Result<Self::Ok, Self::Err>> where
    Self: Unpin, 

A convenience for calling AsyncReadReady::poll_read_ready on Unpin types.

impl AsyncDatagram for UdpSocket

type Sender = SocketAddr

Specifies which target to send the data to.

type Receiver = SocketAddr

Specifies which target the data was received from.

type Err = Error

The type of failures yielded by this trait.

fn poll_send_to(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &[u8],
    receiver: &Self::Receiver
) -> Poll<Result<usize>>

Sends data on the IO interface to the specified target.

fn poll_recv_from(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<(usize, Self::Sender)>>

Receives data from the IO interface.