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 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
#[cfg(all(test, not(any(target_os = "emscripten", target_env = "sgx"))))]
mod tests;
use crate::fmt;
use crate::io::{self, ErrorKind};
use crate::net::{Ipv4Addr, Ipv6Addr, SocketAddr, ToSocketAddrs};
use crate::sys_common::net as net_imp;
use crate::sys_common::{AsInner, FromInner, IntoInner};
use crate::time::Duration;
/// UDP 套接字。
///
/// 通过将 `UdpSocket` 绑定到一个套接字地址来创建 `UdpSocket` 之后,数据可以是 [发送到][sent to] 和 [从哪里接收][received from] 任何其他套接字地址。
///
/// 尽管 UDP 是无连接协议,但是此实现提供了一个接口,用于设置一个地址,在该地址处应发送和接收数据。
/// 使用 [`connect`] 设置远程地址后,可以使用 [`send`] 和 [`recv`] 向该地址发送数据和从该地址接收数据。
///
/// 如 [IETF RFC 768] 中的用户数据报协议规范中所述,UDP 是无序,不可靠的协议。有关 TCP 原语,请参考 [`TcpListener`] 和 [`TcpStream`]。
///
///
/// [`bind`]: UdpSocket::bind
/// [`connect`]: UdpSocket::connect
/// [IETF RFC 768]: https://tools.ietf.org/html/rfc768
/// [`recv`]: UdpSocket::recv
/// [received from]: UdpSocket::recv_from
/// [`send`]: UdpSocket::send
/// [sent to]: UdpSocket::send_to
/// [`TcpListener`]: crate::net::TcpListener
/// [`TcpStream`]: crate::net::TcpStream
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// fn main() -> std::io::Result<()> {
/// {
/// let socket = UdpSocket::bind("127.0.0.1:34254")?;
///
/// // 在套接字上接收单个数据报消息。
/// // 如果 `buf` 太小而无法容纳该消息,它将被切断。
/// let mut buf = [0; 10];
/// let (amt, src) = socket.recv_from(&mut buf)?;
///
/// // 将 `buf` 声明为接收数据的切片,并将反向数据发送回原点。
/// let buf = &mut buf[..amt];
/// buf.reverse();
/// socket.send_to(buf, &src)?;
/// } // 套接字在这里关闭
/// Ok(())
/// }
/// ```
///
///
///
///
#[stable(feature = "rust1", since = "1.0.0")]
pub struct UdpSocket(net_imp::UdpSocket);
impl UdpSocket {
/// 从给定的地址创建一个 UDP 套接字。
///
/// 地址类型可以是 [`ToSocketAddrs`] trait 的任何实现者。有关具体的例子,请参见其文档。
///
/// 如果 `addr` 产生多个地址,则将使用每个地址尝试 `bind`,直到一个成功并返回套接字为止。
///
/// 如果没有一个地址成功创建套接字,则返回上一次尝试返回的错误 (最后一个地址)。
///
/// # Examples
///
/// 创建绑定到 `127.0.0.1:3400` 的 UDP 套接字:
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:3400").expect("couldn't bind to address");
/// ```
///
/// 创建绑定到 `127.0.0.1:3400` 的 UDP 套接字。
/// 如果套接字无法绑定到该地址,请创建绑定到 `127.0.0.1:3401` 的 UDP 套接字:
///
/// ```no_run
/// use std::net::{SocketAddr, UdpSocket};
///
/// let addrs = [
/// SocketAddr::from(([127, 0, 0, 1], 3400)),
/// SocketAddr::from(([127, 0, 0, 1], 3401)),
/// ];
/// let socket = UdpSocket::bind(&addrs[..]).expect("couldn't bind to address");
/// ```
///
/// 创建绑定到操作系统在 `127.0.0.1` 分配的端口的 UDP 套接字。
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:0").unwrap();
/// ```
///
///
///
#[stable(feature = "rust1", since = "1.0.0")]
pub fn bind<A: ToSocketAddrs>(addr: A) -> io::Result<UdpSocket> {
super::each_addr(addr, net_imp::UdpSocket::bind).map(UdpSocket)
}
/// 在套接字上接收单个数据报消息。
/// 成功时,返回读取的字节数和源。
///
/// 必须使用足够大的有效字节数组 `buf` 来调用函数,以容纳消息字节。
///
/// 如果消息太长而无法容纳在提供的缓冲区中,则多余的字节可能会被丢弃。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// let mut buf = [0; 10];
/// let (number_of_bytes, src_addr) = socket.recv_from(&mut buf)
/// .expect("Didn't receive data");
/// let filled_buf = &mut buf[..number_of_bytes];
/// ```
#[stable(feature = "rust1", since = "1.0.0")]
pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
self.0.recv_from(buf)
}
/// 在套接字上接收单个数据报消息,而无需将其从队列中删除。
/// 成功时,返回读取的字节数和源。
///
/// 必须使用足够大的有效字节数组 `buf` 来调用函数,以容纳消息字节。
/// 如果消息太长而无法容纳在提供的缓冲区中,则多余的字节可能会被丢弃。
///
/// 连续调用返回相同的数据。
/// 这是通过将 `MSG_PEEK` 作为标志传递到底层的 `recvfrom` 系统调用来实现的。
///
/// 不要使用此函数来实现繁忙等待,而应使用 `libc::poll` 来同步一个或多个套接字上的 IO 事件。
///
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// let mut buf = [0; 10];
/// let (number_of_bytes, src_addr) = socket.peek_from(&mut buf)
/// .expect("Didn't receive data");
/// let filled_buf = &mut buf[..number_of_bytes];
/// ```
///
#[stable(feature = "peek", since = "1.18.0")]
pub fn peek_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
self.0.peek_from(buf)
}
/// 将套接字上的数据发送到给定的地址。成功时,返回写入的字节数。
///
/// 地址类型可以是 [`ToSocketAddrs`] trait 的任何实现者。有关具体的例子,请参见其文档。
///
/// `addr` 可以产生多个地址,但是 `send_to` 只会将数据发送到 `addr` 产生的第一个地址。
///
///
/// 当本地套接字的 IP 版本与 [`ToSocketAddrs`] 返回的 IP 版本不匹配时,这将返回错误。
///
/// 有关更多详细信息,请参见 [Issue #34202]。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.send_to(&[0; 10], "127.0.0.1:4242").expect("couldn't send data");
/// ```
///
/// [Issue #34202]: https://github.com/rust-lang/rust/issues/34202
///
///
///
#[stable(feature = "rust1", since = "1.0.0")]
pub fn send_to<A: ToSocketAddrs>(&self, buf: &[u8], addr: A) -> io::Result<usize> {
match addr.to_socket_addrs()?.next() {
Some(addr) => self.0.send_to(buf, &addr),
None => {
Err(io::const_io_error!(ErrorKind::InvalidInput, "no addresses to send data to"))
}
}
}
/// 返回此套接字连接到的远程对等方的套接字地址。
///
/// # Examples
///
/// ```no_run
/// use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4, UdpSocket};
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.connect("192.168.0.1:41203").expect("couldn't connect to address");
/// assert_eq!(socket.peer_addr().unwrap(),
/// SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::new(192, 168, 0, 1), 41203)));
/// ```
///
/// 如果未连接套接字,它将返回 [`NotConnected`] 错误。
///
/// [`NotConnected`]: io::ErrorKind::NotConnected
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// assert_eq!(socket.peer_addr().unwrap_err().kind(),
/// std::io::ErrorKind::NotConnected);
/// ```
#[stable(feature = "udp_peer_addr", since = "1.40.0")]
pub fn peer_addr(&self) -> io::Result<SocketAddr> {
self.0.peer_addr()
}
/// 返回创建此套接字的套接字地址。
///
/// # Examples
///
/// ```no_run
/// use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4, UdpSocket};
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// assert_eq!(socket.local_addr().unwrap(),
/// SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 34254)));
/// ```
#[stable(feature = "rust1", since = "1.0.0")]
pub fn local_addr(&self) -> io::Result<SocketAddr> {
self.0.socket_addr()
}
/// 为底层套接字创建一个新的独立的拥有所有权的句柄。
///
/// 返回的 `UdpSocket` 是与此对象引用相同的套接字的引用。
/// 两个句柄都将读取和写入相同的端口,并且在一个套接字上设置的选项将传播到另一个套接字。
///
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// let socket_clone = socket.try_clone().expect("couldn't clone the socket");
/// ```
#[stable(feature = "rust1", since = "1.0.0")]
pub fn try_clone(&self) -> io::Result<UdpSocket> {
self.0.duplicate().map(UdpSocket)
}
/// 将读取超时设置为指定的超时。
///
/// 如果指定的值为 [`None`],则 [`read`] 调用将无限期阻塞。
/// 如果将零 [`Duration`] 传递给此方法,则返回 [`Err`]。
///
/// # 特定于平台的行为
///
/// 由于设置此选项而导致读取超时时,平台可能会返回不同的错误代码。
/// 例如,Unix 通常返回类型为 [`WouldBlock`] 的错误,但是 Windows 可能返回 [`TimedOut`]。
///
///
/// [`read`]: io::Read::read
/// [`WouldBlock`]: io::ErrorKind::WouldBlock
/// [`TimedOut`]: io::ErrorKind::TimedOut
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_read_timeout(None).expect("set_read_timeout call failed");
/// ```
///
/// 如果将零 [`Duration`] 传递给此方法,则返回 [`Err`]:
///
/// ```no_run
/// use std::io;
/// use std::net::UdpSocket;
/// use std::time::Duration;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").unwrap();
/// let result = socket.set_read_timeout(Some(Duration::new(0, 0)));
/// let err = result.unwrap_err();
/// assert_eq!(err.kind(), io::ErrorKind::InvalidInput)
/// ```
///
///
#[stable(feature = "socket_timeout", since = "1.4.0")]
pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
self.0.set_read_timeout(dur)
}
/// 将写超时设置为指定的超时。
///
/// 如果指定的值为 [`None`],则 [`write`] 调用将无限期阻塞。
/// 如果将零 [`Duration`] 传递给此方法,则返回 [`Err`]。
///
/// # 特定于平台的行为
///
/// 由于设置此选项而导致写超时时,平台可能会返回不同的错误代码。
/// 例如,Unix 通常返回类型为 [`WouldBlock`] 的错误,但是 Windows 可能返回 [`TimedOut`]。
///
///
/// [`write`]: io::Write::write
/// [`WouldBlock`]: io::ErrorKind::WouldBlock
/// [`TimedOut`]: io::ErrorKind::TimedOut
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_write_timeout(None).expect("set_write_timeout call failed");
/// ```
///
/// 如果将零 [`Duration`] 传递给此方法,则返回 [`Err`]:
///
/// ```no_run
/// use std::io;
/// use std::net::UdpSocket;
/// use std::time::Duration;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").unwrap();
/// let result = socket.set_write_timeout(Some(Duration::new(0, 0)));
/// let err = result.unwrap_err();
/// assert_eq!(err.kind(), io::ErrorKind::InvalidInput)
/// ```
///
///
#[stable(feature = "socket_timeout", since = "1.4.0")]
pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
self.0.set_write_timeout(dur)
}
/// 返回此套接字的读取超时。
///
/// 如果超时为 [`None`],则 [`read`] 调用将无限期阻塞。
///
/// [`read`]: io::Read::read
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_read_timeout(None).expect("set_read_timeout call failed");
/// assert_eq!(socket.read_timeout().unwrap(), None);
/// ```
#[stable(feature = "socket_timeout", since = "1.4.0")]
pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
self.0.read_timeout()
}
/// 返回此套接字的写入超时。
///
/// 如果超时为 [`None`],则 [`write`] 调用将无限期阻塞。
///
/// [`write`]: io::Write::write
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_write_timeout(None).expect("set_write_timeout call failed");
/// assert_eq!(socket.write_timeout().unwrap(), None);
/// ```
#[stable(feature = "socket_timeout", since = "1.4.0")]
pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
self.0.write_timeout()
}
/// 设置此套接字的 `SO_BROADCAST` 选项的值。
///
/// 启用后,允许此套接字将数据包发送到广播地址。
///
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_broadcast(false).expect("set_broadcast call failed");
/// ```
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn set_broadcast(&self, broadcast: bool) -> io::Result<()> {
self.0.set_broadcast(broadcast)
}
/// 获取此套接字的 `SO_BROADCAST` 选项的值。
///
/// 有关此选项的更多信息,请参见 [`UdpSocket::set_broadcast`]。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_broadcast(false).expect("set_broadcast call failed");
/// assert_eq!(socket.broadcast().unwrap(), false);
/// ```
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn broadcast(&self) -> io::Result<bool> {
self.0.broadcast()
}
/// 设置此套接字的 `IP_MULTICAST_LOOP` 选项的值。
///
/// 如果启用,则多播数据包将循环回到本地套接字。
/// 请注意,这可能对 IPv6 套接字没有任何影响。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_multicast_loop_v4(false).expect("set_multicast_loop_v4 call failed");
/// ```
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> io::Result<()> {
self.0.set_multicast_loop_v4(multicast_loop_v4)
}
/// 获取此套接字的 `IP_MULTICAST_LOOP` 选项的值。
///
/// 有关此选项的更多信息,请参见 [`UdpSocket::set_multicast_loop_v4`]。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_multicast_loop_v4(false).expect("set_multicast_loop_v4 call failed");
/// assert_eq!(socket.multicast_loop_v4().unwrap(), false);
/// ```
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn multicast_loop_v4(&self) -> io::Result<bool> {
self.0.multicast_loop_v4()
}
/// 设置此套接字的 `IP_MULTICAST_TTL` 选项的值。
///
/// 指示此套接字的传出多播数据包的生存时间值。
/// 默认值为 1,这意味着除非明确请求,否则多播数据包不会离开本地网络。
///
///
/// 请注意,这可能对 IPv6 套接字没有任何影响。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_multicast_ttl_v4(42).expect("set_multicast_ttl_v4 call failed");
/// ```
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> io::Result<()> {
self.0.set_multicast_ttl_v4(multicast_ttl_v4)
}
/// 获取此套接字的 `IP_MULTICAST_TTL` 选项的值。
///
/// 有关此选项的更多信息,请参见 [`UdpSocket::set_multicast_ttl_v4`]。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_multicast_ttl_v4(42).expect("set_multicast_ttl_v4 call failed");
/// assert_eq!(socket.multicast_ttl_v4().unwrap(), 42);
/// ```
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn multicast_ttl_v4(&self) -> io::Result<u32> {
self.0.multicast_ttl_v4()
}
/// 设置此套接字的 `IPV6_MULTICAST_LOOP` 选项的值。
///
/// 控制此套接字是否看到自己发送的多播数据包。
/// 请注意,这可能不会对 IPv4 套接字产生任何影响。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_multicast_loop_v6(false).expect("set_multicast_loop_v6 call failed");
/// ```
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> io::Result<()> {
self.0.set_multicast_loop_v6(multicast_loop_v6)
}
/// 获取此套接字的 `IPV6_MULTICAST_LOOP` 选项的值。
///
/// 有关此选项的更多信息,请参见 [`UdpSocket::set_multicast_loop_v6`]。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_multicast_loop_v6(false).expect("set_multicast_loop_v6 call failed");
/// assert_eq!(socket.multicast_loop_v6().unwrap(), false);
/// ```
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn multicast_loop_v6(&self) -> io::Result<bool> {
self.0.multicast_loop_v6()
}
/// 设置此套接字上 `IP_TTL` 选项的值。
///
/// 此值设置从该套接字发送的每个数据包中使用的生存时间字段。
///
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_ttl(42).expect("set_ttl call failed");
/// ```
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
self.0.set_ttl(ttl)
}
/// 获取此套接字的 `IP_TTL` 选项的值。
///
/// 有关此选项的更多信息,请参见 [`UdpSocket::set_ttl`]。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.set_ttl(42).expect("set_ttl call failed");
/// assert_eq!(socket.ttl().unwrap(), 42);
/// ```
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn ttl(&self) -> io::Result<u32> {
self.0.ttl()
}
/// 执行 `IP_ADD_MEMBERSHIP` 类型的操作。
///
/// 此函数为此套接字指定一个新的多播组。
/// 该地址必须是有效的多播地址,而 `interface` 是系统应加入多播组的本地接口的地址。
/// 如果等于 `INADDR_ANY`,则系统选择适当的接口。
///
///
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn join_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr) -> io::Result<()> {
self.0.join_multicast_v4(multiaddr, interface)
}
/// 执行 `IPV6_ADD_MEMBERSHIP` 类型的操作。
///
/// 此函数为此套接字指定一个新的多播组。
/// 该地址必须是有效的多播地址,并且 `interface` 是接口到 join/leave 的索引 (或 0 表示任何接口)。
///
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn join_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32) -> io::Result<()> {
self.0.join_multicast_v6(multiaddr, interface)
}
/// 执行 `IP_DROP_MEMBERSHIP` 类型的操作。
///
/// 有关此选项的更多信息,请参见 [`UdpSocket::join_multicast_v4`]。
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn leave_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr) -> io::Result<()> {
self.0.leave_multicast_v4(multiaddr, interface)
}
/// 执行 `IPV6_DROP_MEMBERSHIP` 类型的操作。
///
/// 有关此选项的更多信息,请参见 [`UdpSocket::join_multicast_v6`]。
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn leave_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32) -> io::Result<()> {
self.0.leave_multicast_v6(multiaddr, interface)
}
/// 获取此套接字上 `SO_ERROR` 选项的值。
///
/// 这将检索底层套接字中存储的错误,从而清除进程中的字段。
/// 这对于检查两次调用之间的错误很有用。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// match socket.take_error() {
/// Ok(Some(error)) => println!("UdpSocket error: {error:?}"),
/// Ok(None) => println!("No error"),
/// Err(error) => println!("UdpSocket.take_error failed: {error:?}"),
/// }
/// ```
///
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn take_error(&self) -> io::Result<Option<io::Error>> {
self.0.take_error()
}
/// 将此 UDP 套接字连接到远程地址,从而允许使用 `send` 和 `recv` 系统调用来发送数据,并且还应用过滤器以仅接收来自指定地址的数据。
///
/// 如果 `addr` 产生多个地址,则 `connect` 将尝试使用每个地址,直到底层 OS 函数没有返回错误为止。
/// 请注意,通常,成功的 `connect` 调用不会指定有远程服务器在端口上侦听,而是仅在第一次发送后才检测到此错误。
/// 如果操作系统为每个指定的地址返回错误,则返回从上次连接尝试 (最后一个地址) 返回的错误。
///
/// # Examples
///
/// 创建绑定到 `127.0.0.1:3400` 的 UDP 套接字并将该套接字连接到
/// `127.0.0.1:8080`:
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:3400").expect("couldn't bind to address");
/// socket.connect("127.0.0.1:8080").expect("connect function failed");
/// ```
///
/// 与 TCP 情况不同,将地址数组传递给 UDP 套接字的 `connect` 函数不是一件有用的事情:在没有应用程序发送数据的情况下,操作系统将无法确定是否有人在监听远程地址。
///
///
///
///
///
///
///
///
///
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn connect<A: ToSocketAddrs>(&self, addr: A) -> io::Result<()> {
super::each_addr(addr, |addr| self.0.connect(addr))
}
/// 将套接字上的数据发送到它所连接的远程地址。
///
/// [`UdpSocket::connect`] 将把这个套接字连接到一个远程地址。
/// 如果未连接套接字,则此方法将失败。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.connect("127.0.0.1:8080").expect("connect function failed");
/// socket.send(&[0, 1, 2]).expect("couldn't send message");
/// ```
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn send(&self, buf: &[u8]) -> io::Result<usize> {
self.0.send(buf)
}
/// 从套接字连接到的远程地址在套接字上接收单个数据报消息。
/// 成功时,返回读取的字节数。
///
/// 必须使用足够大的有效字节数组 `buf` 来调用函数,以容纳消息字节。
///
/// 如果消息太长而无法容纳在提供的缓冲区中,则多余的字节可能会被丢弃。
///
/// [`UdpSocket::connect`] 将把这个套接字连接到一个远程地址。
/// 如果未连接套接字,则此方法将失败。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.connect("127.0.0.1:8080").expect("connect function failed");
/// let mut buf = [0; 10];
/// match socket.recv(&mut buf) {
/// Ok(received) => println!("received {received} bytes {:?}", &buf[..received]),
/// Err(e) => println!("recv function failed: {e:?}"),
/// }
/// ```
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
self.0.recv(buf)
}
/// 从套接字所连接的远程地址接收套接字上的单个数据报,而不会从输入队列中删除消息。
/// 成功时,返回偷看的字节数。
///
/// 必须使用足够大的有效字节数组 `buf` 来调用函数,以容纳消息字节。
/// 如果消息太长而无法容纳在提供的缓冲区中,则多余的字节可能会被丢弃。
///
/// 连续调用返回相同的数据。这是通过将 `MSG_PEEK` 作为标志传递给底层的 `recv` 系统调用来实现的。
///
/// 不要使用此函数来实现繁忙等待,而应使用 `libc::poll` 来同步一个或多个套接字上的 IO 事件。
///
/// [`UdpSocket::connect`] 将把这个套接字连接到一个远程地址。如果未连接套接字,则此方法将失败。
///
/// # Errors
///
/// 如果未连接套接字,则此方法将失败。`connect` 方法会将此套接字连接到远程地址。
///
/// # Examples
///
/// ```no_run
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:34254").expect("couldn't bind to address");
/// socket.connect("127.0.0.1:8080").expect("connect function failed");
/// let mut buf = [0; 10];
/// match socket.peek(&mut buf) {
/// Ok(received) => println!("received {received} bytes"),
/// Err(e) => println!("peek function failed: {e:?}"),
/// }
/// ```
///
///
///
///
///
///
#[stable(feature = "peek", since = "1.18.0")]
pub fn peek(&self, buf: &mut [u8]) -> io::Result<usize> {
self.0.peek(buf)
}
/// 将此 UDP 套接字移入或移出非阻塞模式。
///
/// 这将导致 `recv`,`recv_from`,`send` 和 `send_to` 操作变为非阻塞,即立即从其调用中返回。
///
/// 如果 IO 操作成功,则返回 `Ok`,并且不需要进一步的操作。
/// 如果 IO 操作无法完成,需要重试,则返回类型为 [`io::ErrorKind::WouldBlock`] 的错误。
///
/// 在 Unix 平台上,调用此方法相当于调用 `fcntl` `FIONBIO`。
/// 在 Windows 上,调用此方法对应于调用 `ioctlsocket` `FIONBIO`。
///
/// # Examples
///
/// 创建绑定到 `127.0.0.1:7878` 的 UDP 套接字,并以非阻塞模式读取字节:
///
/// ```no_run
/// use std::io;
/// use std::net::UdpSocket;
///
/// let socket = UdpSocket::bind("127.0.0.1:7878").unwrap();
/// socket.set_nonblocking(true).unwrap();
///
/// # fn wait_for_fd() { unimplemented!() }
/// let mut buf = [0; 10];
/// let (num_bytes_read, _) = loop {
/// match socket.recv_from(&mut buf) {
/// Ok(n) => break n,
/// Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => {
/// // 等待网络套接字就绪,通常通过平台特定的 API (例如 epoll 或 IOCP) 实现
/////
/// wait_for_fd();
/// }
/// Err(e) => panic!("encountered IO error: {e}"),
/// }
/// };
/// println!("bytes: {:?}", &buf[..num_bytes_read]);
/// ```
///
///
///
///
#[stable(feature = "net2_mutators", since = "1.9.0")]
pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
self.0.set_nonblocking(nonblocking)
}
}
// 除了这里的 impl 之外,`UdpSocket` 还有 `AsFd`/`From<OwnedFd>`/`Into<OwnedFd>` 和 `AsRawFd`/`IntoRawFd`/`FromRawFd`、Unix 和 WASI 以及 Windows 上的 `AsSocket`/`From<OwnedSocket>`/`Into<OwnedSocket>` 和 `AsRawSocket`/`IntoRawSocket`/`FromRawSocket` 的 impl。
//
//
//
//
impl AsInner<net_imp::UdpSocket> for UdpSocket {
#[inline]
fn as_inner(&self) -> &net_imp::UdpSocket {
&self.0
}
}
impl FromInner<net_imp::UdpSocket> for UdpSocket {
fn from_inner(inner: net_imp::UdpSocket) -> UdpSocket {
UdpSocket(inner)
}
}
impl IntoInner<net_imp::UdpSocket> for UdpSocket {
fn into_inner(self) -> net_imp::UdpSocket {
self.0
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl fmt::Debug for UdpSocket {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.0.fmt(f)
}
}