Struct mio::net::UdpSocket [] [src]

pub struct UdpSocket { /* fields omitted */ }

A User Datagram Protocol socket.

This is an implementation of a bound UDP socket. This supports both IPv4 and IPv6 addresses, and there is no corresponding notion of a server because UDP is a datagram protocol.

Methods

impl UdpSocket
[src]

[src]

Creates a UDP socket from the given address.

[src]

Creates a new mio-wrapped socket from an underlying and bound std socket.

This function requires that socket has previously been bound to an address to work correctly, and returns an I/O object which can be used with mio to send/receive UDP messages.

This can be used in conjunction with net2's UdpBuilder interface to configure a socket before it's handed off to mio, such as setting options like reuse_address or binding to multiple addresses.

[src]

Returns the socket address that this socket was created from.

[src]

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.

[src]

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.

[src]

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

[src]

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

[src]

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

[src]

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

[src]

Sets the value of the SO_BROADCAST option for this socket.

When enabled, this socket is allowed to send packets to a broadcast address.

[src]

Gets the value of the SO_BROADCAST option for this socket.

For more information about this option, see set_broadcast.

[src]

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.

[src]

Gets the value of the IP_MULTICAST_LOOP option for this socket.

For more information about this option, see set_multicast_loop_v4.

[src]

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.

[src]

Gets the value of the IP_MULTICAST_TTL option for this socket.

For more information about this option, see set_multicast_ttl_v4.

[src]

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.

[src]

Gets the value of the IPV6_MULTICAST_LOOP option for this socket.

For more information about this option, see set_multicast_loop_v6.

[src]

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.

[src]

Gets the value of the IP_TTL option for this socket.

For more information about this option, see set_ttl.

[src]

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.

[src]

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

[src]

Executes an operation of the IP_DROP_MEMBERSHIP type.

For more information about this option, see join_multicast_v4.

[src]

Executes an operation of the IPV6_DROP_MEMBERSHIP type.

For more information about this option, see join_multicast_v6.

[src]

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.

[src]

Gets the value of the IPV6_V6ONLY option for this socket.

For more information about this option, see set_only_v6.

[src]

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.

Trait Implementations

impl Debug for UdpSocket
[src]

[src]

Formats the value using the given formatter.

impl Evented for UdpSocket
[src]

[src]

Register self with the given Poll instance. Read more

[src]

Re-register self with the given Poll instance. Read more

[src]

Deregister self from the given Poll instance Read more

impl IntoRawFd for UdpSocket
[src]

[src]

Consumes this object, returning the raw underlying file descriptor. Read more

impl AsRawFd for UdpSocket
[src]

[src]

Extracts the raw file descriptor. Read more

impl FromRawFd for UdpSocket
[src]

[src]

Constructs a new instance of Self from the given raw file descriptor. Read more