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 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
//! 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 use {io, sys, Ready, Poll, PollOpt, Token}; use event::Evented; use poll::SelectorId; use std::fmt; use std::net::{self, Ipv4Addr, Ipv6Addr, SocketAddr}; #[cfg(all(unix, not(target_os = "fuchsia")))] use iovec::IoVec; /// 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. /// /// # Examples /// /// ``` /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// // An Echo program: /// // SENDER -> sends a message. /// // ECHOER -> listens and prints the message received. /// /// use mio::net::UdpSocket; /// use mio::{Events, Ready, Poll, PollOpt, Token}; /// use std::time::Duration; /// /// const SENDER: Token = Token(0); /// const ECHOER: Token = Token(1); /// /// // This operation will fail if the address is in use, so we select different ports for each /// // socket. /// let sender_socket = UdpSocket::bind(&"127.0.0.1:0".parse()?)?; /// let echoer_socket = UdpSocket::bind(&"127.0.0.1:0".parse()?)?; /// /// // If we do not use connect here, SENDER and ECHOER would need to call send_to and recv_from /// // respectively. /// sender_socket.connect(echoer_socket.local_addr().unwrap())?; /// /// // We need a Poll to check if SENDER is ready to be written into, and if ECHOER is ready to be /// // read from. /// let poll = Poll::new()?; /// /// // We register our sockets here so that we can check if they are ready to be written/read. /// poll.register(&sender_socket, SENDER, Ready::writable(), PollOpt::edge())?; /// poll.register(&echoer_socket, ECHOER, Ready::readable(), PollOpt::edge())?; /// /// let msg_to_send = [9; 9]; /// let mut buffer = [0; 9]; /// /// let mut events = Events::with_capacity(128); /// loop { /// poll.poll(&mut events, Some(Duration::from_millis(100)))?; /// for event in events.iter() { /// match event.token() { /// // Our SENDER is ready to be written into. /// SENDER => { /// let bytes_sent = sender_socket.send(&msg_to_send)?; /// assert_eq!(bytes_sent, 9); /// println!("sent {:?} -> {:?} bytes", msg_to_send, bytes_sent); /// }, /// // Our ECHOER is ready to be read from. /// ECHOER => { /// let num_recv = echoer_socket.recv(&mut buffer)?; /// println!("echo {:?} -> {:?}", buffer, num_recv); /// buffer = [0; 9]; /// # return Ok(()); /// } /// _ => unreachable!() /// } /// } /// } /// # /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` pub struct UdpSocket { sys: sys::UdpSocket, selector_id: SelectorId, } impl UdpSocket { /// Creates a UDP socket from the given address. /// /// # Examples /// /// ``` /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// use mio::net::UdpSocket; /// /// // We must bind it to an open address. /// let socket = match UdpSocket::bind(&"127.0.0.1:0".parse()?) { /// Ok(new_socket) => new_socket, /// Err(fail) => { /// // We panic! here, but you could try to bind it again on another address. /// panic!("Failed to bind socket. {:?}", fail); /// } /// }; /// /// // Our socket was created, but we should not use it before checking it's readiness. /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` 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. /// /// # Examples /// // This assertion is almost, but not quite, universal. It fails on // shared-IP FreeBSD jails. It's hard for mio to know whether we're jailed, // so simply disable the test on FreeBSD. #[cfg_attr(not(target_os = "freebsd"), doc = " ```")] #[cfg_attr(target_os = "freebsd", doc = " ```no_run")] /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// use mio::net::UdpSocket; /// /// let addr = "127.0.0.1:0".parse()?; /// let socket = UdpSocket::bind(&addr)?; /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` 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. /// /// # Examples /// /// ``` /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// 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()?); /// /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` 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. /// /// # Examples /// /// ```no_run /// # use std::error::Error; /// # fn try_main() -> Result<(), Box<Error>> { /// 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); /// # /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` pub fn send_to(&self, buf: &[u8], target: &SocketAddr) -> io::Result<usize> { self.sys.send_to(buf, target) } /// Receives data from the socket. On success, returns the number of bytes /// read and the address from whence the data came. /// /// # Examples /// /// ```no_run /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// 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); /// # /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { self.sys.recv_from(buf) } /// 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<usize> { self.sys.send(buf) } /// Receives data from the socket previously bound with connect(). On success, returns /// the number of bytes read. pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> { self.sys.recv(buf) } /// 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) } /// 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 std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// 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); /// # /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` pub fn set_broadcast(&self, on: bool) -> io::Result<()> { self.sys.set_broadcast(on) } /// 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 /// /// # Examples /// /// ``` /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// use mio::net::UdpSocket; /// /// let broadcast_socket = UdpSocket::bind(&"127.0.0.1:0".parse()?)?; /// assert_eq!(broadcast_socket.broadcast()?, false); /// # /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` pub fn broadcast(&self) -> io::Result<bool> { self.sys.broadcast() } /// 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_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_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 `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 `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 `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 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 std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// 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); /// # /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` pub fn set_ttl(&self, ttl: u32) -> io::Result<()> { self.sys.set_ttl(ttl) } /// 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 /// /// # Examples /// /// ``` /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// use mio::net::UdpSocket; /// /// let socket = UdpSocket::bind(&"127.0.0.1:0".parse()?)?; /// socket.set_ttl(255)?; /// /// assert_eq!(socket.ttl()?, 255); /// # /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` pub fn ttl(&self) -> io::Result<u32> { self.sys.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) } /// 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 set_only_v6(&self, only_v6: bool) -> io::Result<()> { self.sys.set_only_v6(only_v6) } /// Gets the value of the `IPV6_V6ONLY` option for this socket. /// /// For more information about this option, see [`set_only_v6`][link]. /// /// [link]: #method.set_only_v6 pub fn only_v6(&self) -> io::Result<bool> { self.sys.only_v6() } /// 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() } /// 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`][link] error is returned. This operation does not block. /// /// On Unix this corresponds to the `readv` syscall. /// /// [link]: https://doc.rust-lang.org/nightly/std/io/enum.ErrorKind.html#variant.WouldBlock #[cfg(all(unix, not(target_os = "fuchsia")))] pub fn recv_bufs(&self, bufs: &mut [&mut IoVec]) -> io::Result<usize> { self.sys.readv(bufs) } /// 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`][link] error is returned. This operation does not block. /// /// On Unix this corresponds to the `writev` syscall. /// /// [link]: https://doc.rust-lang.org/nightly/std/io/enum.ErrorKind.html#variant.WouldBlock #[cfg(all(unix, not(target_os = "fuchsia")))] pub fn send_bufs(&self, bufs: &[&IoVec]) -> io::Result<usize> { self.sys.writev(bufs) } } 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) } } impl fmt::Debug for UdpSocket { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(&self.sys, f) } } /* * * ===== 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(), } } }