Struct async_coap_tokio::TokioAsyncUdpSocket

pub struct TokioAsyncUdpSocket(_);

An asynchronous AsyncDatagramSocket wrapper around std::net::UdpSocket that uses Tokio for the event loop.

This type differs from AllowUdpSocket in that it provides a real asynchronous, event-driven interface instead of faking one.

In order to use this type, you must be using Tokio for your event loop.

Methods

impl TokioAsyncUdpSocket

pub fn bind<A>(addr: A) -> Result<TokioAsyncUdpSocket> where
    A: ToSocketAddrs, 

Analog of std::net::UdpSocket::bind for TokioAsyncUdpSocket.

Example

let async_socket = TokioAsyncUdpSocket::bind("[::]:0")?;

pub fn from_std(udp_socket: UdpSocket) -> TokioAsyncUdpSocket

Upgrades a std::net::UdpSocket by wrapping it in a TokioAsyncUdpSocket.

Methods from Deref<Target = UdpSocket>

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

Returns the socket address that this socket was created from.

Examples

use mio::net::UdpSocket;

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

pub fn try_clone(&self) -> Result<UdpSocket, Error>

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

use mio::net::UdpSocket;

// We must bind it to an open address.
let socket = UdpSocket::bind(&"127.0.0.1:0".parse()?)?;
let cloned_socket = socket.try_clone()?;

assert_eq!(socket.local_addr()?, cloned_socket.local_addr()?);

pub fn send_to(&self, buf: &[u8], target: &SocketAddr) -> Result<usize, Error>

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

Address type can be any implementor of ToSocketAddrs trait. See its documentation for concrete examples.

Examples

use mio::net::UdpSocket;

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

// We must check if the socket is writable before calling send_to,
// or we could run into a WouldBlock error.

let bytes_sent = socket.send_to(&[9; 9], &"127.0.0.1:11100".parse()?)?;
assert_eq!(bytes_sent, 9);

pub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr), Error>

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

Examples

use mio::net::UdpSocket;

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

// We must check if the socket is readable before calling recv_from,
// or we could run into a WouldBlock error.

let mut buf = [0; 9];
let (num_recv, from_addr) = socket.recv_from(&mut buf)?;
println!("Received {:?} -> {:?} bytes from {:?}", buf, num_recv, from_addr);

pub fn send(&self, buf: &[u8]) -> Result<usize, Error>

Sends data on the socket to the address previously bound via connect(). On success, returns the number of bytes written.

pub fn recv(&self, buf: &mut [u8]) -> Result<usize, Error>

Receives data from the socket previously bound with connect(). On success, returns the number of bytes read.

pub fn connect(&self, addr: SocketAddr) -> Result<(), Error>

Connects the UDP socket setting the default destination for send() and limiting packets that are read via recv from the address specified in addr.

pub fn set_broadcast(&self, on: bool) -> Result<(), Error>

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

use mio::net::UdpSocket;

let broadcast_socket = UdpSocket::bind(&"127.0.0.1:0".parse()?)?;
if broadcast_socket.broadcast()? == false {
    broadcast_socket.set_broadcast(true)?;
}

assert_eq!(broadcast_socket.broadcast()?, true);

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

Gets the value of the SO_BROADCAST option for this socket.

For more information about this option, see set_broadcast.

Examples

use mio::net::UdpSocket;

let broadcast_socket = UdpSocket::bind(&"127.0.0.1:0".parse()?)?;
assert_eq!(broadcast_socket.broadcast()?, false);

pub fn set_multicast_loop_v4(&self, on: bool) -> Result<(), Error>

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 may not have any affect on IPv6 sockets.

pub fn multicast_loop_v4(&self) -> Result<bool, Error>

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_ttl_v4(&self, ttl: u32) -> Result<(), Error>

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 may not have any affect on IPv6 sockets.

pub fn multicast_ttl_v4(&self) -> Result<u32, Error>

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_loop_v6(&self, on: bool) -> Result<(), Error>

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 may not have any affect on IPv4 sockets.

pub fn multicast_loop_v6(&self) -> Result<bool, Error>

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_ttl(&self, ttl: u32) -> Result<(), Error>

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

use mio::net::UdpSocket;

let socket = UdpSocket::bind(&"127.0.0.1:0".parse()?)?;
if socket.ttl()? < 255 {
    socket.set_ttl(255)?;
}

assert_eq!(socket.ttl()?, 255);

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

Gets the value of the IP_TTL option for this socket.

For more information about this option, see set_ttl.

Examples

use mio::net::UdpSocket;

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

assert_eq!(socket.ttl()?, 255);

pub fn join_multicast_v4(
    &self,
    multiaddr: &Ipv4Addr,
    interface: &Ipv4Addr
) -> Result<(), Error>

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.

pub fn join_multicast_v6(
    &self,
    multiaddr: &Ipv6Addr,
    interface: u32
) -> Result<(), Error>

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

pub fn leave_multicast_v4(
    &self,
    multiaddr: &Ipv4Addr,
    interface: &Ipv4Addr
) -> Result<(), Error>

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<(), Error>

Executes an operation of the IPV6_DROP_MEMBERSHIP type.

For more information about this option, see join_multicast_v6.

pub fn set_only_v6(&self, only_v6: bool) -> Result<(), Error>

Sets the value for the IPV6_V6ONLY option on this socket.

If this is set to true then the socket is restricted to sending and receiving IPv6 packets only. In this case two IPv4 and IPv6 applications can bind the same port at the same time.

If this is set to false then the socket can be used to send and receive packets from an IPv4-mapped IPv6 address.

pub fn only_v6(&self) -> Result<bool, Error>

Gets the value of the IPV6_V6ONLY option for this socket.

For more information about this option, see set_only_v6.

pub fn take_error(&self) -> Result<Option<Error>, Error>

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

pub fn recv_bufs(&self, bufs: &mut [&mut IoVec]) -> Result<usize, Error>

Receives a single datagram message socket previously bound with connect.

This operation will attempt to read bytes from this socket and place them into the list of buffers provided. Note that each buffer is an IoVec which can be created from a byte slice.

The buffers provided will be filled sequentially. A buffer will be entirely filled up before the next is written to.

The number of bytes read is returned, if successful, or an error is returned otherwise. If no bytes are available to be read yet then a WouldBlock error is returned. This operation does not block.

On Unix this corresponds to the readv syscall.

pub fn send_bufs(&self, bufs: &[&IoVec]) -> Result<usize, Error>

Sends data on the socket to the address previously bound via connect.

This operation will attempt to send a list of byte buffers to this socket in a single datagram. Note that each buffer is an IoVec which can be created from a byte slice.

The buffers provided will be written sequentially. A buffer will be entirely written before the next is written.

The number of bytes written is returned, if successful, or an error is returned otherwise. If the socket is not currently writable then a WouldBlock error is returned. This operation does not block.

On Unix this corresponds to the writev syscall.

Trait Implementations

impl Unpin for TokioAsyncUdpSocket

impl Deref for TokioAsyncUdpSocket

type Target = UdpSocket

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Debug for TokioAsyncUdpSocket

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

Formats the value using the given formatter.

impl AsyncDatagramSocket for TokioAsyncUdpSocket

impl DatagramSocketTypes for TokioAsyncUdpSocket

type SocketAddr = SocketAddr

The "SocketAddr" type used by this "socket". Typically [std::net::SocketAddr].

type Error = Error

The error type for errors emitted from this socket. Typically [std::io::Error].

fn local_addr(&self) -> Result<Self::SocketAddr, Self::Error>

Returns the local SocketAddr of this "socket".

fn lookup_host(
    host: &str,
    port: u16
) -> Result<IntoIter<Self::SocketAddr>, Self::Error> where
    Self: Sized, 

Performs a blocking hostname lookup.

impl AsyncSendTo for TokioAsyncUdpSocket

fn poll_send_to<B>(
    self: Pin<&Self>,
    cx: &mut Context,
    buf: &[u8],
    addr: B
) -> Poll<Result<usize, Self::Error>> where
    B: ToSocketAddrs<SocketAddr = Self::SocketAddr, Error = Self::Error>, 

A non-blocking, poll_* version of std::net::UdpSocket::send_to.

fn next_send_to<B>(
    &'a self,
    buf: &'b [u8],
    addr: B
) -> NextSendToFuture<'a, 'b, Self> where
    B: ToSocketAddrs<SocketAddr = Self::SocketAddr, Error = Self::Error>, 

Returns a future that uses [AsyncSendTo::poll_send_to].

fn send_to<B>(&self, buf: &[u8], addr: B) -> Result<usize, Self::Error> where
    B: ToSocketAddrs<SocketAddr = Self::SocketAddr, Error = Self::Error>, 

A synchronous version of [AsyncSendTo::poll_send_to]. If this isn't overridden by the trait's implementation, the default version will call poll_send_to() and panics if it returns Poll::Pending.

impl AsyncRecvFrom for TokioAsyncUdpSocket

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

A non-blocking, poll_* version of [std::net::UdpSocket::recv_from] that can optionally provide the destination (local) SocketAddr.

fn next_recv_from(
    &'a self,
    buf: &'b mut [u8]
) -> NextRecvFromFuture<'a, 'b, Self>

Returns a future that uses [poll_recv_from][AsyncRecvFrom::poll_recv_from].

impl MulticastSocket for TokioAsyncUdpSocket

type IpAddr = IpAddr

The "address" type for this socket.

fn join_multicast<A>(&self, addr: A) -> Result<(), Self::Error> where
    A: Into<Self::IpAddr>, 

Attempts to join the given multicast group.

fn leave_multicast<A>(&self, addr: A) -> Result<(), Self::Error> where
    A: Into<Self::IpAddr>, 

Attempts to leave the given multicast group.