Struct tokio_core::net::UdpSocket
[−]
[src]
pub struct UdpSocket { // some fields omitted }
An I/O object representing a UDP socket.
Methods
impl UdpSocket
[src]
fn bind(addr: &SocketAddr, handle: &Handle) -> Result<UdpSocket>
Create a new UDP socket bound to the specified address.
This function will create a new UDP socket and attempt to bind it to the
addr
provided. The returned future will be resolved once the socket
has successfully bound. If an error happens during the binding or during
the socket creation, that error will be returned to the future instead.
fn from_socket(socket: UdpSocket, handle: &Handle) -> Result<UdpSocket>
Creates a new UdpSocket
from the previously bound socket provided.
The socket given will be registered with the event loop that handle
is
associated with. This function requires that socket
has previously
been bound to an address to work correctly.
This can be used in conjunction with net2's UdpBuilder
interface to
configure a socket before it's handed off, such as setting options like
reuse_address
or binding to multiple addresses.
fn local_addr(&self) -> Result<SocketAddr>
Returns the local address that this stream is bound to.
fn poll_read(&self) -> Async<()>
Test whether this socket is ready to be read or not.
If the socket is not readable then the current task is scheduled to
get a notification when the socket does become readable. That is, this
is only suitable for calling in a Future::poll
method and will
automatically handle ensuring a retry once the socket is readable again.
fn poll_write(&self) -> Async<()>
Test whether this socket is writey to be written to or not.
If the socket is not writable then the current task is scheduled to
get a notification when the socket does become writable. That is, this
is only suitable for calling in a Future::poll
method and will
automatically handle ensuring a retry once the socket is writable again.
fn send_to(&self, buf: &[u8], target: &SocketAddr) -> Result<usize>
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.
fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>
Receives data from the socket. On success, returns the number of bytes read and the address from whence the data came.
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
.
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.
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
.
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 that this may not have any affect on IPv6 sockets.
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
.
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 that this may not have any affect on IPv6 sockets.
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
.
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 that this may not have any affect on IPv4 sockets.
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
.
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.
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.
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).
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
.
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
.