      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326

    //! Primitives for working with UDP
    //!
    //! The types provided in this module are non-blocking by default and are
    //! designed to be portable across all supported Mio platforms. As long as the
    //! [portability guidelines] are followed, the behavior should be identical no
    //! matter the target platform.
    //!
    //! [portability guidelines]: ../struct.Poll.html#portability

    #![allow(deprecated)]

    use {sys, Ready, Poll, PollOpt, Token};
    use io::{self, MapNonBlock};
    use event::Evented;
    use poll::SelectorId;
    use std::net::{self, Ipv4Addr, Ipv6Addr, SocketAddr};

    /// 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.
    #[derive(Debug)]
    pub struct UdpSocket {
        sys: sys::UdpSocket,
        selector_id: SelectorId,
    }

    impl UdpSocket {
        /// Creates a UDP socket from the given address.
        pub fn bind(addr: &SocketAddr) -> io::Result<UdpSocket> {
            let socket = net::UdpSocket::bind(addr)?;
            UdpSocket::from_socket(socket)
        }

        /// 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.
        pub fn from_socket(socket: net::UdpSocket) -> io::Result<UdpSocket> {
            Ok(UdpSocket {
                sys: sys::UdpSocket::new(socket)?,
                selector_id: SelectorId::new(),
            })
        }

        /// Returns the socket address that this socket was created from.
        pub fn local_addr(&self) -> io::Result<SocketAddr> {
            self.sys.local_addr()
        }

        /// 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.
        pub fn try_clone(&self) -> io::Result<UdpSocket> {
            self.sys.try_clone()
                .map(|s| {
                    UdpSocket {
                        sys: s,
                        selector_id: self.selector_id.clone(),
                    }
                })
        }

        /// 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.
        pub fn send_to(&self, buf: &[u8], target: &SocketAddr)
                       -> io::Result<Option<usize>> {
            self.sys.send_to(buf, target).map_non_block()
        }

        /// Receives data from the socket and stores data in the supplied buffer `buf`. On success,
        /// returns the number of bytes read and the address from whence the data came.
        ///
        /// The function must be called with valid byte array `buf` of sufficient size to
        /// hold the message bytes. If a message is too long to fit in the supplied buffer,
        /// excess bytes may be discarded.
        ///
        /// The function does not read from `buf`, but is overwriting previous content of `buf`.
        ///
        /// Assuming the function has read `n` bytes, slicing `&buf[..n]` provides
        /// efficient access with iterators and boundary checks.
        pub fn recv_from(&self, buf: &mut [u8])
                         -> io::Result<Option<(usize, SocketAddr)>> {
            self.sys.recv_from(buf).map_non_block()
        }

        /// Sends data on the socket to the address previously bound via connect(). On success,
        /// returns the number of bytes written.
        pub fn send(&self, buf: &[u8])
                       -> io::Result<Option<usize>> {
            self.sys.send(buf).map_non_block()
        }

        /// Receives data from the socket previously bound with connect() and stores data in
        /// the supplied buffer `buf`. On success, returns the number of bytes read.
        ///
        /// The function must be called with valid byte array `buf` of sufficient size to
        /// hold the message bytes. If a message is too long to fit in the supplied buffer,
        /// excess bytes may be discarded.
        ///
        /// The function does not read from `buf`, but is overwriting previous content of `buf`.
        ///
        /// Assuming the function has read `n` bytes, slicing `&buf[..n]` provides
        /// efficient access with iterators and boundary checks.
        pub fn recv(&self, buf: &mut [u8])
                         -> io::Result<Option<usize>> {
            self.sys.recv(buf).map_non_block()
        }

        /// 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 connect(&self, addr: SocketAddr)
                     -> io::Result<()> {
            self.sys.connect(addr)
        }

        /// Gets the value of the `SO_BROADCAST` option for this socket.
        ///
        /// For more information about this option, see
        /// [`set_broadcast`][link].
        ///
        /// [link]: #method.set_broadcast
        pub fn broadcast(&self) -> io::Result<bool> {
            self.sys.broadcast()
        }

        /// 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 set_broadcast(&self, on: bool) -> io::Result<()> {
            self.sys.set_broadcast(on)
        }

        /// Gets the value of the `IP_MULTICAST_LOOP` option for this socket.
        ///
        /// For more information about this option, see
        /// [`set_multicast_loop_v4`][link].
        ///
        /// [link]: #method.set_multicast_loop_v4
        pub fn multicast_loop_v4(&self) -> io::Result<bool> {
            self.sys.multicast_loop_v4()
        }

        /// 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 set_multicast_loop_v4(&self, on: bool) -> io::Result<()> {
            self.sys.set_multicast_loop_v4(on)
        }

        /// Gets the value of the `IP_MULTICAST_TTL` option for this socket.
        ///
        /// For more information about this option, see
        /// [`set_multicast_ttl_v4`][link].
        ///
        /// [link]: #method.set_multicast_ttl_v4
        pub fn multicast_ttl_v4(&self) -> io::Result<u32> {
            self.sys.multicast_ttl_v4()
        }

        /// 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 set_multicast_ttl_v4(&self, ttl: u32) -> io::Result<()> {
            self.sys.set_multicast_ttl_v4(ttl)
        }

        /// Gets the value of the `IPV6_MULTICAST_LOOP` option for this socket.
        ///
        /// For more information about this option, see
        /// [`set_multicast_loop_v6`][link].
        ///
        /// [link]: #method.set_multicast_loop_v6
        pub fn multicast_loop_v6(&self) -> io::Result<bool> {
            self.sys.multicast_loop_v6()
        }

        /// 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 set_multicast_loop_v6(&self, on: bool) -> io::Result<()> {
            self.sys.set_multicast_loop_v6(on)
        }

        /// Gets the value of the `IP_TTL` option for this socket.
        ///
        /// For more information about this option, see [`set_ttl`][link].
        ///
        /// [link]: #method.set_ttl
        pub fn ttl(&self) -> io::Result<u32> {
            self.sys.ttl()
        }

        /// 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 set_ttl(&self, ttl: u32) -> io::Result<()> {
            self.sys.set_ttl(ttl)
        }

        /// 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_v4(&self,
                                 multiaddr: &Ipv4Addr,
                                 interface: &Ipv4Addr) -> io::Result<()> {
            self.sys.join_multicast_v4(multiaddr, interface)
        }

        /// 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 join_multicast_v6(&self,
                                 multiaddr: &Ipv6Addr,
                                 interface: u32) -> io::Result<()> {
            self.sys.join_multicast_v6(multiaddr, interface)
        }

        /// Executes an operation of the `IP_DROP_MEMBERSHIP` type.
        ///
        /// For more information about this option, see
        /// [`join_multicast_v4`][link].
        ///
        /// [link]: #method.join_multicast_v4
        pub fn leave_multicast_v4(&self,
                                  multiaddr: &Ipv4Addr,
                                  interface: &Ipv4Addr) -> io::Result<()> {
            self.sys.leave_multicast_v4(multiaddr, interface)
        }

        /// Executes an operation of the `IPV6_DROP_MEMBERSHIP` type.
        ///
        /// For more information about this option, see
        /// [`join_multicast_v6`][link].
        ///
        /// [link]: #method.join_multicast_v6
        pub fn leave_multicast_v6(&self,
                                  multiaddr: &Ipv6Addr,
                                  interface: u32) -> io::Result<()> {
            self.sys.leave_multicast_v6(multiaddr, interface)
        }

        /// 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 take_error(&self) -> io::Result<Option<io::Error>> {
            self.sys.take_error()
        }
    }

    impl Evented for UdpSocket {
        fn register(&self, poll: &Poll, token: Token, interest: Ready, opts: PollOpt) -> io::Result<()> {
            self.selector_id.associate_selector(poll)?;
            self.sys.register(poll, token, interest, opts)
        }

        fn reregister(&self, poll: &Poll, token: Token, interest: Ready, opts: PollOpt) -> io::Result<()> {
            self.sys.reregister(poll, token, interest, opts)
        }

        fn deregister(&self, poll: &Poll) -> io::Result<()> {
            self.sys.deregister(poll)
        }
    }

    /*
     *
     * ===== UNIX ext =====
     *
     */

    #[cfg(all(unix, not(target_os = "fuchsia")))]
    use std::os::unix::io::{IntoRawFd, AsRawFd, FromRawFd, RawFd};

    #[cfg(all(unix, not(target_os = "fuchsia")))]
    impl IntoRawFd for UdpSocket {
        fn into_raw_fd(self) -> RawFd {
            self.sys.into_raw_fd()
        }
    }

    #[cfg(all(unix, not(target_os = "fuchsia")))]
    impl AsRawFd for UdpSocket {
        fn as_raw_fd(&self) -> RawFd {
            self.sys.as_raw_fd()
        }
    }

    #[cfg(all(unix, not(target_os = "fuchsia")))]
    impl FromRawFd for UdpSocket {
        unsafe fn from_raw_fd(fd: RawFd) -> UdpSocket {
            UdpSocket {
                sys: FromRawFd::from_raw_fd(fd),
                selector_id: SelectorId::new(),
            }
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)