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 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
#![allow(bad_style, dead_code)]
use std::io;
use std::mem;
use std::net::{TcpStream, TcpListener, UdpSocket, Ipv4Addr, Ipv6Addr};
use std::net::ToSocketAddrs;
use {TcpBuilder, UdpBuilder, FromInner};
use sys;
use sys::c;
use socket;
cfg_if! {
if #[cfg(any(target_os = "dragonfly",
target_os = "freebsd",
target_os = "haiku",
target_os = "ios",
target_os = "macos",
target_os = "netbsd",
target_os = "openbsd",
target_os = "solaris",
target_os = "illumos",
target_env = "uclibc"))] {
use libc::IPV6_JOIN_GROUP as IPV6_ADD_MEMBERSHIP;
use libc::IPV6_LEAVE_GROUP as IPV6_DROP_MEMBERSHIP;
} else {
// ...
}
}
use std::time::Duration;
#[cfg(any(unix, target_os = "wasi"))] use libc::*;
#[cfg(any(unix))] use std::os::unix::prelude::*;
#[cfg(target_os = "wasi")] use std::os::wasi::prelude::*;
#[cfg(unix)] pub type Socket = c_int;
#[cfg(target_os = "wasi")] pub type Socket = std::os::wasi::io::RawFd;
#[cfg(windows)] pub type Socket = SOCKET;
#[cfg(windows)] use std::os::windows::prelude::*;
#[cfg(any(windows, target_os = "wasi"))] use sys::c::*;
#[cfg(windows)] const SIO_KEEPALIVE_VALS: DWORD = 0x98000004;
#[cfg(windows)]
#[repr(C)]
struct tcp_keepalive {
onoff: c_ulong,
keepalivetime: c_ulong,
keepaliveinterval: c_ulong,
}
#[cfg(any(unix, target_os = "wasi"))] fn v(opt: c_int) -> c_int { opt }
#[cfg(windows)] fn v(opt: IPPROTO) -> c_int { opt as c_int }
#[cfg(target_os = "wasi")]
pub fn set_opt<T: Copy>(_sock: Socket, _opt: c_int, _val: c_int,
_payload: T) -> io::Result<()> {
Ok(())
}
#[cfg(not(target_os = "wasi"))]
pub fn set_opt<T: Copy>(sock: Socket, opt: c_int, val: c_int,
payload: T) -> io::Result<()> {
unsafe {
let payload = &payload as *const T as *const c_void;
try!(::cvt(setsockopt(sock, opt, val, payload as *const _,
mem::size_of::<T>() as socklen_t)));
}
Ok(())
}
#[cfg(target_os = "wasi")]
pub fn get_opt<T: Copy>(_sock: Socket, _opt: c_int, _val: c_int) -> io::Result<T> {
unimplemented!()
}
#[cfg(not(target_os = "wasi"))]
pub fn get_opt<T: Copy>(sock: Socket, opt: c_int, val: c_int) -> io::Result<T> {
unsafe {
let mut slot: T = mem::zeroed();
let mut len = mem::size_of::<T>() as socklen_t;
try!(::cvt(getsockopt(sock, opt, val,
&mut slot as *mut _ as *mut _,
&mut len)));
assert_eq!(len as usize, mem::size_of::<T>());
Ok(slot)
}
}
/// Extension methods for the standard [`TcpStream` type][link] in `std::net`.
///
/// [link]: https://doc.rust-lang.org/std/net/struct.TcpStream.html
pub trait TcpStreamExt {
/// Sets the value of the `TCP_NODELAY` option on this socket.
///
/// If set, this option disables the Nagle algorithm. This means that
/// segments are always sent as soon as possible, even if there is only a
/// small amount of data. When not set, data is buffered until there is a
/// sufficient amount to send out, thereby avoiding the frequent sending of
/// small packets.
fn set_nodelay(&self, nodelay: bool) -> io::Result<()>;
/// Gets the value of the `TCP_NODELAY` option on this socket.
///
/// For more information about this option, see [`set_nodelay`][link].
///
/// [link]: #tymethod.set_nodelay
fn nodelay(&self) -> io::Result<bool>;
/// Sets the value of the `SO_RCVBUF` option on this socket.
///
/// Changes the size of the operating system's receive buffer associated with the socket.
fn set_recv_buffer_size(&self, size: usize) -> io::Result<()>;
/// Gets the value of the `SO_RCVBUF` option on this socket.
///
/// For more information about this option, see [`set_recv_buffer_size`][link].
///
/// [link]: #tymethod.set_recv_buffer_size
fn recv_buffer_size(&self) -> io::Result<usize>;
/// Sets the value of the `SO_SNDBUF` option on this socket.
///
/// Changes the size of the operating system's send buffer associated with the socket.
fn set_send_buffer_size(&self, size: usize) -> io::Result<()>;
/// Gets the value of the `SO_SNDBUF` option on this socket.
///
/// For more information about this option, see [`set_send_buffer`][link].
///
/// [link]: #tymethod.set_send_buffer
fn send_buffer_size(&self) -> io::Result<usize>;
/// Sets whether keepalive messages are enabled to be sent on this socket.
///
/// On Unix, this option will set the `SO_KEEPALIVE` as well as the
/// `TCP_KEEPALIVE` or `TCP_KEEPIDLE` option (depending on your platform).
/// On Windows, this will set the `SIO_KEEPALIVE_VALS` option.
///
/// If `None` is specified then keepalive messages are disabled, otherwise
/// the number of milliseconds specified will be the time to remain idle
/// before sending a TCP keepalive probe.
///
/// Some platforms specify this value in seconds, so sub-second millisecond
/// specifications may be omitted.
fn set_keepalive_ms(&self, keepalive: Option<u32>) -> io::Result<()>;
/// Returns whether keepalive messages are enabled on this socket, and if so
/// the amount of milliseconds between them.
///
/// For more information about this option, see [`set_keepalive_ms`][link].
///
/// [link]: #tymethod.set_keepalive_ms
fn keepalive_ms(&self) -> io::Result<Option<u32>>;
/// Sets whether keepalive messages are enabled to be sent on this socket.
///
/// On Unix, this option will set the `SO_KEEPALIVE` as well as the
/// `TCP_KEEPALIVE` or `TCP_KEEPIDLE` option (depending on your platform).
/// On Windows, this will set the `SIO_KEEPALIVE_VALS` option.
///
/// If `None` is specified then keepalive messages are disabled, otherwise
/// the duration specified will be the time to remain idle before sending a
/// TCP keepalive probe.
///
/// Some platforms specify this value in seconds, so sub-second
/// specifications may be omitted.
fn set_keepalive(&self, keepalive: Option<Duration>) -> io::Result<()>;
/// Returns whether keepalive messages are enabled on this socket, and if so
/// the duration of time between them.
///
/// For more information about this option, see [`set_keepalive`][link].
///
/// [link]: #tymethod.set_keepalive
fn keepalive(&self) -> io::Result<Option<Duration>>;
/// Sets the `SO_RCVTIMEO` option for this socket.
///
/// This option specifies the timeout, in milliseconds, of how long calls to
/// this socket's `read` function will wait before returning a timeout. A
/// value of `None` means that no read timeout should be specified and
/// otherwise `Some` indicates the number of milliseconds for the timeout.
fn set_read_timeout_ms(&self, val: Option<u32>) -> io::Result<()>;
/// Sets the `SO_RCVTIMEO` option for this socket.
///
/// This option specifies the timeout of how long calls to this socket's
/// `read` function will wait before returning a timeout. A value of `None`
/// means that no read timeout should be specified and otherwise `Some`
/// indicates the number of duration of the timeout.
fn set_read_timeout(&self, val: Option<Duration>) -> io::Result<()>;
/// Gets the value of the `SO_RCVTIMEO` option for this socket.
///
/// For more information about this option, see [`set_read_timeout_ms`][link].
///
/// [link]: #tymethod.set_read_timeout_ms
fn read_timeout_ms(&self) -> io::Result<Option<u32>>;
/// Gets the value of the `SO_RCVTIMEO` option for this socket.
///
/// For more information about this option, see [`set_read_timeout`][link].
///
/// [link]: #tymethod.set_read_timeout
fn read_timeout(&self) -> io::Result<Option<Duration>>;
/// Sets the `SO_SNDTIMEO` option for this socket.
///
/// This option specifies the timeout, in milliseconds, of how long calls to
/// this socket's `write` function will wait before returning a timeout. A
/// value of `None` means that no read timeout should be specified and
/// otherwise `Some` indicates the number of milliseconds for the timeout.
fn set_write_timeout_ms(&self, val: Option<u32>) -> io::Result<()>;
/// Sets the `SO_SNDTIMEO` option for this socket.
///
/// This option specifies the timeout of how long calls to this socket's
/// `write` function will wait before returning a timeout. A value of `None`
/// means that no read timeout should be specified and otherwise `Some`
/// indicates the duration of the timeout.
fn set_write_timeout(&self, val: Option<Duration>) -> io::Result<()>;
/// Gets the value of the `SO_SNDTIMEO` option for this socket.
///
/// For more information about this option, see [`set_write_timeout_ms`][link].
///
/// [link]: #tymethod.set_write_timeout_ms
fn write_timeout_ms(&self) -> io::Result<Option<u32>>;
/// Gets the value of the `SO_SNDTIMEO` option for this socket.
///
/// For more information about this option, see [`set_write_timeout`][link].
///
/// [link]: #tymethod.set_write_timeout
fn write_timeout(&self) -> io::Result<Option<Duration>>;
/// 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 set_ttl(&self, ttl: u32) -> io::Result<()>;
/// Gets the value of the `IP_TTL` option for this socket.
///
/// For more information about this option, see [`set_ttl`][link].
///
/// [link]: #tymethod.set_ttl
fn ttl(&self) -> io::Result<u32>;
/// 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.
fn set_only_v6(&self, only_v6: bool) -> io::Result<()>;
/// Gets the value of the `IPV6_V6ONLY` option for this socket.
///
/// For more information about this option, see [`set_only_v6`][link].
///
/// [link]: #tymethod.set_only_v6
fn only_v6(&self) -> io::Result<bool>;
/// Executes a `connect` operation on this socket, establishing a connection
/// to the host specified by `addr`.
///
/// Note that this normally does not need to be called on a `TcpStream`,
/// it's typically automatically done as part of a normal
/// `TcpStream::connect` function call or `TcpBuilder::connect` method call.
///
/// This should only be necessary if an unconnected socket was extracted
/// from a `TcpBuilder` and then needs to be connected.
fn connect<T: ToSocketAddrs>(&self, addr: T) -> io::Result<()>;
/// 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.
fn take_error(&self) -> io::Result<Option<io::Error>>;
/// Moves this TCP stream into or out of nonblocking mode.
///
/// On Unix this corresponds to calling fcntl, and on Windows this
/// corresponds to calling ioctlsocket.
fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()>;
/// Sets the linger duration of this socket by setting the SO_LINGER option
fn set_linger(&self, dur: Option<Duration>) -> io::Result<()>;
/// reads the linger duration for this socket by getting the SO_LINGER option
fn linger(&self) -> io::Result<Option<Duration>>;
}
/// Extension methods for the standard [`TcpListener` type][link] in `std::net`.
///
/// [link]: https://doc.rust-lang.org/std/net/struct.TcpListener.html
pub trait TcpListenerExt {
/// Sets the value for the `IP_TTL` option on this socket.
///
/// This is the same as [`TcpStreamExt::set_ttl`][other].
///
/// [other]: trait.TcpStreamExt.html#tymethod.set_ttl
fn set_ttl(&self, ttl: u32) -> io::Result<()>;
/// Gets the value of the `IP_TTL` option for this socket.
///
/// For more information about this option, see
/// [`TcpStreamExt::set_ttl`][link].
///
/// [link]: trait.TcpStreamExt.html#tymethod.set_ttl
fn ttl(&self) -> io::Result<u32>;
/// Sets the value for the `IPV6_V6ONLY` option on this socket.
///
/// For more information about this option, see
/// [`TcpStreamExt::set_only_v6`][link].
///
/// [link]: trait.TcpStreamExt.html#tymethod.set_only_v6
fn set_only_v6(&self, only_v6: bool) -> io::Result<()>;
/// Gets the value of the `IPV6_V6ONLY` option for this socket.
///
/// For more information about this option, see
/// [`TcpStreamExt::set_only_v6`][link].
///
/// [link]: trait.TcpStreamExt.html#tymethod.set_only_v6
fn only_v6(&self) -> io::Result<bool>;
/// 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.
fn take_error(&self) -> io::Result<Option<io::Error>>;
/// Moves this TCP listener into or out of nonblocking mode.
///
/// For more information about this option, see
/// [`TcpStreamExt::set_nonblocking`][link].
///
/// [link]: trait.TcpStreamExt.html#tymethod.set_nonblocking
fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()>;
/// Sets the linger duration of this socket by setting the SO_LINGER option
fn set_linger(&self, dur: Option<Duration>) -> io::Result<()>;
/// reads the linger duration for this socket by getting the SO_LINGER option
fn linger(&self) -> io::Result<Option<Duration>>;
}
/// Extension methods for the standard [`UdpSocket` type][link] in `std::net`.
///
/// [link]: https://doc.rust-lang.org/std/net/struct.UdpSocket.html
pub trait UdpSocketExt {
/// Sets the value of the `SO_RCVBUF` option on this socket.
///
/// Changes the size of the operating system's receive buffer associated with the socket.
fn set_recv_buffer_size(&self, size: usize) -> io::Result<()>;
/// Gets the value of the `SO_RCVBUF` option on this socket.
///
/// For more information about this option, see [`set_recv_buffer_size`][link].
///
/// [link]: #tymethod.set_recv_buffer_size
fn recv_buffer_size(&self) -> io::Result<usize>;
/// Sets the value of the `SO_SNDBUF` option on this socket.
///
/// Changes the size of the operating system's send buffer associated with the socket.
fn set_send_buffer_size(&self, size: usize) -> io::Result<()>;
/// Gets the value of the `SO_SNDBUF` option on this socket.
///
/// For more information about this option, see [`set_send_buffer`][link].
///
/// [link]: #tymethod.set_send_buffer
fn send_buffer_size(&self) -> io::Result<usize>;
/// 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 set_broadcast(&self, broadcast: bool) -> io::Result<()>;
/// Gets the value of the `SO_BROADCAST` option for this socket.
///
/// For more information about this option, see
/// [`set_broadcast`][link].
///
/// [link]: #tymethod.set_broadcast
fn broadcast(&self) -> io::Result<bool>;
/// 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 set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> io::Result<()>;
/// 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]: #tymethod.set_multicast_loop_v4
fn multicast_loop_v4(&self) -> io::Result<bool>;
/// 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 set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> io::Result<()>;
/// 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]: #tymethod.set_multicast_ttl_v4
fn multicast_ttl_v4(&self) -> io::Result<u32>;
/// Sets the value of the `IPV6_MULTICAST_HOPS` option for this socket
fn set_multicast_hops_v6(&self, hops: u32) -> io::Result<()>;
/// Gets the value of the `IPV6_MULTICAST_HOPS` option for this socket
fn multicast_hops_v6(&self) -> io::Result<u32>;
/// 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 set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> io::Result<()>;
/// 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]: #tymethod.set_multicast_loop_v6
fn multicast_loop_v6(&self) -> io::Result<bool>;
/// Sets the value of the `IP_MULTICAST_IF` option for this socket.
///
/// Specifies the interface to use for routing multicast packets.
fn set_multicast_if_v4(&self, interface: &Ipv4Addr) -> io::Result<()>;
/// Gets the value of the `IP_MULTICAST_IF` option for this socket.
///
/// Returns the interface to use for routing multicast packets.
fn multicast_if_v4(&self) -> io::Result<Ipv4Addr>;
/// Sets the value of the `IPV6_MULTICAST_IF` option for this socket.
///
/// Specifies the interface to use for routing multicast packets.
fn set_multicast_if_v6(&self, interface: u32) -> io::Result<()>;
/// Gets the value of the `IPV6_MULTICAST_IF` option for this socket.
///
/// Returns the interface to use for routing multicast packets.
fn multicast_if_v6(&self) -> io::Result<u32>;
/// Sets the value for the `IP_TTL` option on this socket.
///
/// This is the same as [`TcpStreamExt::set_ttl`][other].
///
/// [other]: trait.TcpStreamExt.html#tymethod.set_ttl
fn set_ttl(&self, ttl: u32) -> io::Result<()>;
/// Gets the value of the `IP_TTL` option for this socket.
///
/// For more information about this option, see
/// [`TcpStreamExt::set_ttl`][link].
///
/// [link]: trait.TcpStreamExt.html#tymethod.set_ttl
fn ttl(&self) -> io::Result<u32>;
/// Sets the value for the `IPV6_UNICAST_HOPS` option on this socket.
///
/// Specifies the hop limit for ipv6 unicast packets
fn set_unicast_hops_v6(&self, ttl: u32) -> io::Result<()>;
/// Gets the value of the `IPV6_UNICAST_HOPS` option for this socket.
///
/// Specifies the hop limit for ipv6 unicast packets
fn unicast_hops_v6(&self) -> io::Result<u32>;
/// Sets the value for the `IPV6_V6ONLY` option on this socket.
///
/// For more information about this option, see
/// [`TcpStreamExt::set_only_v6`][link].
///
/// [link]: trait.TcpStreamExt.html#tymethod.set_only_v6
fn set_only_v6(&self, only_v6: bool) -> io::Result<()>;
/// Gets the value of the `IPV6_V6ONLY` option for this socket.
///
/// For more information about this option, see
/// [`TcpStreamExt::set_only_v6`][link].
///
/// [link]: trait.TcpStreamExt.html#tymethod.set_only_v6
fn only_v6(&self) -> io::Result<bool>;
/// 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_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr)
-> io::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 join_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32)
-> io::Result<()>;
/// Executes an operation of the `IP_DROP_MEMBERSHIP` type.
///
/// For more information about this option, see
/// [`join_multicast_v4`][link].
///
/// [link]: #tymethod.join_multicast_v4
fn leave_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr)
-> io::Result<()>;
/// Executes an operation of the `IPV6_DROP_MEMBERSHIP` type.
///
/// For more information about this option, see
/// [`join_multicast_v6`][link].
///
/// [link]: #tymethod.join_multicast_v6
fn leave_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32)
-> io::Result<()>;
/// Sets the `SO_RCVTIMEO` option for this socket.
///
/// This option specifies the timeout, in milliseconds, of how long calls to
/// this socket's `read` function will wait before returning a timeout. A
/// value of `None` means that no read timeout should be specified and
/// otherwise `Some` indicates the number of milliseconds for the timeout.
fn set_read_timeout_ms(&self, val: Option<u32>) -> io::Result<()>;
/// Sets the `SO_RCVTIMEO` option for this socket.
///
/// This option specifies the timeout of how long calls to this socket's
/// `read` function will wait before returning a timeout. A value of `None`
/// means that no read timeout should be specified and otherwise `Some`
/// indicates the number of duration of the timeout.
fn set_read_timeout(&self, val: Option<Duration>) -> io::Result<()>;
/// Gets the value of the `SO_RCVTIMEO` option for this socket.
///
/// For more information about this option, see [`set_read_timeout_ms`][link].
///
/// [link]: #tymethod.set_read_timeout_ms
fn read_timeout_ms(&self) -> io::Result<Option<u32>>;
/// Gets the value of the `SO_RCVTIMEO` option for this socket.
///
/// For more information about this option, see [`set_read_timeout`][link].
///
/// [link]: #tymethod.set_read_timeout
fn read_timeout(&self) -> io::Result<Option<Duration>>;
/// Sets the `SO_SNDTIMEO` option for this socket.
///
/// This option specifies the timeout, in milliseconds, of how long calls to
/// this socket's `write` function will wait before returning a timeout. A
/// value of `None` means that no read timeout should be specified and
/// otherwise `Some` indicates the number of milliseconds for the timeout.
fn set_write_timeout_ms(&self, val: Option<u32>) -> io::Result<()>;
/// Sets the `SO_SNDTIMEO` option for this socket.
///
/// This option specifies the timeout of how long calls to this socket's
/// `write` function will wait before returning a timeout. A value of `None`
/// means that no read timeout should be specified and otherwise `Some`
/// indicates the duration of the timeout.
fn set_write_timeout(&self, val: Option<Duration>) -> io::Result<()>;
/// Gets the value of the `SO_SNDTIMEO` option for this socket.
///
/// For more information about this option, see [`set_write_timeout_ms`][link].
///
/// [link]: #tymethod.set_write_timeout_ms
fn write_timeout_ms(&self) -> io::Result<Option<u32>>;
/// Gets the value of the `SO_SNDTIMEO` option for this socket.
///
/// For more information about this option, see [`set_write_timeout`][link].
///
/// [link]: #tymethod.set_write_timeout
fn write_timeout(&self) -> io::Result<Option<Duration>>;
/// 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.
fn take_error(&self) -> io::Result<Option<io::Error>>;
/// Connects this UDP socket to a remote address, allowing the `send` and
/// `recv` syscalls to be used to send data and also applies filters to only
/// receive data from the specified address.
fn connect<A: ToSocketAddrs>(&self, addr: A) -> io::Result<()>;
/// Sends data on the socket to the remote address to which it is connected.
///
/// The `connect` method will connect this socket to a remote address. This
/// method will fail if the socket is not connected.
fn send(&self, buf: &[u8]) -> io::Result<usize>;
/// Receives data on the socket from the remote address to which it is
/// connected.
///
/// The `connect` method will connect this socket to a remote address. This
/// method will fail if the socket is not connected.
fn recv(&self, buf: &mut [u8]) -> io::Result<usize>;
/// Moves this UDP socket into or out of nonblocking mode.
///
/// For more information about this option, see
/// [`TcpStreamExt::set_nonblocking`][link].
///
/// [link]: trait.TcpStreamExt.html#tymethod.set_nonblocking
fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()>;
}
#[doc(hidden)]
pub trait AsSock {
fn as_sock(&self) -> Socket;
}
#[cfg(any(unix, target_os = "wasi"))]
impl<T: AsRawFd> AsSock for T {
fn as_sock(&self) -> Socket { self.as_raw_fd() }
}
#[cfg(windows)]
impl<T: AsRawSocket> AsSock for T {
fn as_sock(&self) -> Socket { self.as_raw_socket() as Socket }
}
cfg_if! {
if #[cfg(any(target_os = "macos", target_os = "ios", target_os = "nto"))] {
use libc::TCP_KEEPALIVE as KEEPALIVE_OPTION;
} else if #[cfg(any(target_os = "haiku", target_os = "netbsd", target_os = "openbsd"))] {
use libc::SO_KEEPALIVE as KEEPALIVE_OPTION;
} else if #[cfg(unix)] {
use libc::TCP_KEEPIDLE as KEEPALIVE_OPTION;
} else {
// ...
}
}
impl TcpStreamExt for TcpStream {
fn set_recv_buffer_size(&self, size: usize) -> io::Result<()> {
// TODO: casting usize to a c_int should be a checked cast
set_opt(self.as_sock(), SOL_SOCKET, SO_RCVBUF, size as c_int)
}
fn recv_buffer_size(&self) -> io::Result<usize> {
get_opt(self.as_sock(), SOL_SOCKET, SO_RCVBUF).map(int2usize)
}
fn set_send_buffer_size(&self, size: usize) -> io::Result<()> {
set_opt(self.as_sock(), SOL_SOCKET, SO_SNDBUF, size as c_int)
}
fn send_buffer_size(&self) -> io::Result<usize> {
get_opt(self.as_sock(), SOL_SOCKET, SO_SNDBUF).map(int2usize)
}
fn set_nodelay(&self, nodelay: bool) -> io::Result<()> {
set_opt(self.as_sock(), v(IPPROTO_TCP), TCP_NODELAY,
nodelay as c_int)
}
fn nodelay(&self) -> io::Result<bool> {
get_opt(self.as_sock(), v(IPPROTO_TCP), TCP_NODELAY)
.map(int2bool)
}
fn set_keepalive(&self, keepalive: Option<Duration>) -> io::Result<()> {
self.set_keepalive_ms(keepalive.map(dur2ms))
}
fn keepalive(&self) -> io::Result<Option<Duration>> {
self.keepalive_ms().map(|o| o.map(ms2dur))
}
#[cfg(unix)]
fn set_keepalive_ms(&self, keepalive: Option<u32>) -> io::Result<()> {
try!(set_opt(self.as_sock(), SOL_SOCKET, SO_KEEPALIVE,
keepalive.is_some() as c_int));
if let Some(dur) = keepalive {
try!(set_opt(self.as_sock(), v(IPPROTO_TCP), KEEPALIVE_OPTION,
(dur / 1000) as c_int));
}
Ok(())
}
#[cfg(unix)]
fn keepalive_ms(&self) -> io::Result<Option<u32>> {
let keepalive = try!(get_opt::<c_int>(self.as_sock(), SOL_SOCKET,
SO_KEEPALIVE));
if keepalive == 0 {
return Ok(None)
}
let secs = try!(get_opt::<c_int>(self.as_sock(), v(IPPROTO_TCP),
KEEPALIVE_OPTION));
Ok(Some((secs as u32) * 1000))
}
#[cfg(target_os = "wasi")]
fn set_keepalive_ms(&self, _keepalive: Option<u32>) -> io::Result<()> {
unimplemented!()
}
#[cfg(target_os = "wasi")]
fn keepalive_ms(&self) -> io::Result<Option<u32>> {
unimplemented!()
}
#[cfg(windows)]
fn set_keepalive_ms(&self, keepalive: Option<u32>) -> io::Result<()> {
let ms = keepalive.unwrap_or(INFINITE);
let ka = tcp_keepalive {
onoff: keepalive.is_some() as c_ulong,
keepalivetime: ms as c_ulong,
keepaliveinterval: ms as c_ulong,
};
unsafe {
::cvt_win(WSAIoctl(self.as_sock(),
SIO_KEEPALIVE_VALS,
&ka as *const _ as *mut _,
mem::size_of_val(&ka) as DWORD,
0 as *mut _,
0,
0 as *mut _,
0 as *mut _,
None)).map(|_| ())
}
}
#[cfg(windows)]
fn keepalive_ms(&self) -> io::Result<Option<u32>> {
let mut ka = tcp_keepalive {
onoff: 0,
keepalivetime: 0,
keepaliveinterval: 0,
};
unsafe {
try!(::cvt_win(WSAIoctl(self.as_sock(),
SIO_KEEPALIVE_VALS,
0 as *mut _,
0,
&mut ka as *mut _ as *mut _,
mem::size_of_val(&ka) as DWORD,
0 as *mut _,
0 as *mut _,
None)));
}
Ok({
if ka.onoff == 0 {
None
} else {
timeout2ms(ka.keepaliveinterval as DWORD)
}
})
}
fn set_read_timeout_ms(&self, dur: Option<u32>) -> io::Result<()> {
set_opt(self.as_sock(), SOL_SOCKET, SO_RCVTIMEO,
ms2timeout(dur))
}
fn read_timeout_ms(&self) -> io::Result<Option<u32>> {
get_opt(self.as_sock(), SOL_SOCKET, SO_RCVTIMEO)
.map(timeout2ms)
}
fn set_write_timeout_ms(&self, dur: Option<u32>) -> io::Result<()> {
set_opt(self.as_sock(), SOL_SOCKET, SO_SNDTIMEO,
ms2timeout(dur))
}
fn write_timeout_ms(&self) -> io::Result<Option<u32>> {
get_opt(self.as_sock(), SOL_SOCKET, SO_SNDTIMEO)
.map(timeout2ms)
}
fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
self.set_read_timeout_ms(dur.map(dur2ms))
}
fn read_timeout(&self) -> io::Result<Option<Duration>> {
self.read_timeout_ms().map(|o| o.map(ms2dur))
}
fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
self.set_write_timeout_ms(dur.map(dur2ms))
}
fn write_timeout(&self) -> io::Result<Option<Duration>> {
self.write_timeout_ms().map(|o| o.map(ms2dur))
}
fn set_ttl(&self, ttl: u32) -> io::Result<()> {
set_opt(self.as_sock(), IPPROTO_IP, IP_TTL, ttl as c_int)
}
fn ttl(&self) -> io::Result<u32> {
get_opt::<c_int>(self.as_sock(), IPPROTO_IP, IP_TTL)
.map(|b| b as u32)
}
fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
set_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_V6ONLY, only_v6 as c_int)
}
fn only_v6(&self) -> io::Result<bool> {
get_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_V6ONLY).map(int2bool)
}
fn connect<T: ToSocketAddrs>(&self, addr: T) -> io::Result<()> {
do_connect(self.as_sock(), addr)
}
fn take_error(&self) -> io::Result<Option<io::Error>> {
get_opt(self.as_sock(), SOL_SOCKET, SO_ERROR).map(int2err)
}
fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
set_nonblocking(self.as_sock(), nonblocking)
}
fn set_linger(&self, dur: Option<Duration>) -> io::Result<()> {
set_opt(self.as_sock(), SOL_SOCKET, SO_LINGER, dur2linger(dur))
}
fn linger(&self) -> io::Result<Option<Duration>> {
get_opt(self.as_sock(), SOL_SOCKET, SO_LINGER).map(linger2dur)
}
}
#[cfg(any(unix, target_os = "wasi"))]
fn ms2timeout(dur: Option<u32>) -> timeval {
// TODO: be more rigorous
match dur {
Some(d) => timeval {
tv_sec: (d / 1000) as time_t,
tv_usec: (d % 1000) as suseconds_t,
},
None => timeval { tv_sec: 0, tv_usec: 0 },
}
}
#[cfg(any(unix, target_os = "wasi"))]
fn timeout2ms(dur: timeval) -> Option<u32> {
if dur.tv_sec == 0 && dur.tv_usec == 0 {
None
} else {
Some(dur.tv_sec as u32 * 1000 + dur.tv_usec as u32 / 1000)
}
}
#[cfg(windows)]
fn ms2timeout(dur: Option<u32>) -> DWORD {
dur.unwrap_or(0)
}
#[cfg(windows)]
fn timeout2ms(dur: DWORD) -> Option<u32> {
if dur == 0 {
None
} else {
Some(dur)
}
}
fn linger2dur(linger_opt: linger) -> Option<Duration> {
if linger_opt.l_onoff == 0 {
None
}
else {
Some(Duration::from_secs(linger_opt.l_linger as u64))
}
}
#[cfg(windows)]
fn dur2linger(dur: Option<Duration>) -> linger {
match dur {
Some(d) => {
linger {
l_onoff: 1,
l_linger: d.as_secs() as u16,
}
},
None => linger { l_onoff: 0, l_linger: 0 },
}
}
#[cfg(any(unix, target_os = "wasi"))]
fn dur2linger(dur: Option<Duration>) -> linger {
match dur {
Some(d) => {
linger {
l_onoff: 1,
l_linger: d.as_secs() as c_int,
}
},
None => linger { l_onoff: 0, l_linger: 0 },
}
}
fn ms2dur(ms: u32) -> Duration {
Duration::new((ms as u64) / 1000, (ms as u32) % 1000 * 1_000_000)
}
fn dur2ms(dur: Duration) -> u32 {
(dur.as_secs() as u32 * 1000) + (dur.subsec_nanos() / 1_000_000)
}
pub fn int2bool(n: c_int) -> bool {
if n == 0 {false} else {true}
}
pub fn int2usize(n: c_int) -> usize {
// TODO: casting c_int to a usize should be a checked cast
n as usize
}
pub fn int2err(n: c_int) -> Option<io::Error> {
if n == 0 {
None
} else {
Some(io::Error::from_raw_os_error(n as i32))
}
}
impl UdpSocketExt for UdpSocket {
fn set_recv_buffer_size(&self, size: usize) -> io::Result<()> {
set_opt(self.as_sock(), SOL_SOCKET, SO_RCVBUF, size as c_int)
}
fn recv_buffer_size(&self) -> io::Result<usize> {
get_opt(self.as_sock(), SOL_SOCKET, SO_RCVBUF).map(int2usize)
}
fn set_send_buffer_size(&self, size: usize) -> io::Result<()> {
set_opt(self.as_sock(), SOL_SOCKET, SO_SNDBUF, size as c_int)
}
fn send_buffer_size(&self) -> io::Result<usize> {
get_opt(self.as_sock(), SOL_SOCKET, SO_SNDBUF).map(int2usize)
}
fn set_broadcast(&self, broadcast: bool) -> io::Result<()> {
set_opt(self.as_sock(), SOL_SOCKET, SO_BROADCAST,
broadcast as c_int)
}
fn broadcast(&self) -> io::Result<bool> {
get_opt(self.as_sock(), SOL_SOCKET, SO_BROADCAST)
.map(int2bool)
}
fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> io::Result<()> {
set_opt(self.as_sock(), IPPROTO_IP, IP_MULTICAST_LOOP,
multicast_loop_v4 as c_int)
}
fn multicast_loop_v4(&self) -> io::Result<bool> {
get_opt(self.as_sock(), IPPROTO_IP, IP_MULTICAST_LOOP)
.map(int2bool)
}
fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> io::Result<()> {
set_opt(self.as_sock(), IPPROTO_IP, IP_MULTICAST_TTL,
multicast_ttl_v4 as c_int)
}
fn multicast_ttl_v4(&self) -> io::Result<u32> {
get_opt::<c_int>(self.as_sock(), IPPROTO_IP, IP_MULTICAST_TTL)
.map(|b| b as u32)
}
fn set_multicast_hops_v6(&self, _hops: u32) -> io::Result<()> {
set_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_MULTICAST_HOPS,
_hops as c_int)
}
fn multicast_hops_v6(&self) -> io::Result<u32> {
get_opt::<c_int>(self.as_sock(), v(IPPROTO_IPV6), IPV6_MULTICAST_HOPS)
.map(|b| b as u32)
}
fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> io::Result<()> {
set_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_MULTICAST_LOOP,
multicast_loop_v6 as c_int)
}
fn multicast_loop_v6(&self) -> io::Result<bool> {
get_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_MULTICAST_LOOP)
.map(int2bool)
}
fn set_multicast_if_v4(&self, _interface: &Ipv4Addr) -> io::Result<()> {
set_opt(self.as_sock(), IPPROTO_IP, IP_MULTICAST_IF, ip2in_addr(_interface))
}
fn multicast_if_v4(&self) -> io::Result<Ipv4Addr> {
get_opt(self.as_sock(), IPPROTO_IP, IP_MULTICAST_IF).map(in_addr2ip)
}
fn set_multicast_if_v6(&self, _interface: u32) -> io::Result<()> {
set_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_MULTICAST_IF, to_ipv6mr_interface(_interface))
}
fn multicast_if_v6(&self) -> io::Result<u32> {
get_opt::<c_int>(self.as_sock(), v(IPPROTO_IPV6), IPV6_MULTICAST_IF).map(|b| b as u32)
}
fn set_ttl(&self, ttl: u32) -> io::Result<()> {
set_opt(self.as_sock(), IPPROTO_IP, IP_TTL, ttl as c_int)
}
fn ttl(&self) -> io::Result<u32> {
get_opt::<c_int>(self.as_sock(), IPPROTO_IP, IP_TTL)
.map(|b| b as u32)
}
fn set_unicast_hops_v6(&self, _ttl: u32) -> io::Result<()> {
set_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_UNICAST_HOPS, _ttl as c_int)
}
fn unicast_hops_v6(&self) -> io::Result<u32> {
get_opt::<c_int>(self.as_sock(), IPPROTO_IP, IPV6_UNICAST_HOPS)
.map(|b| b as u32)
}
fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
set_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_V6ONLY, only_v6 as c_int)
}
fn only_v6(&self) -> io::Result<bool> {
get_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_V6ONLY).map(int2bool)
}
fn join_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr)
-> io::Result<()> {
let mreq = ip_mreq {
imr_multiaddr: ip2in_addr(multiaddr),
imr_interface: ip2in_addr(interface),
};
set_opt(self.as_sock(), IPPROTO_IP, IP_ADD_MEMBERSHIP, mreq)
}
#[cfg(not(target_os = "nto"))]
fn join_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32)
-> io::Result<()> {
let mreq = ipv6_mreq {
ipv6mr_multiaddr: ip2in6_addr(multiaddr),
ipv6mr_interface: to_ipv6mr_interface(interface),
};
set_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_ADD_MEMBERSHIP,
mreq)
}
#[cfg(target_os = "nto")]
fn join_multicast_v6(&self, _: &Ipv6Addr, _: u32)
-> io::Result<()> {
Err(io::Error::new(io::ErrorKind::Unsupported, "not supported by platform"))
}
fn leave_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr)
-> io::Result<()> {
let mreq = ip_mreq {
imr_multiaddr: ip2in_addr(multiaddr),
imr_interface: ip2in_addr(interface),
};
set_opt(self.as_sock(), IPPROTO_IP, IP_DROP_MEMBERSHIP, mreq)
}
#[cfg(not(target_os = "nto"))]
fn leave_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32)
-> io::Result<()> {
let mreq = ipv6_mreq {
ipv6mr_multiaddr: ip2in6_addr(multiaddr),
ipv6mr_interface: to_ipv6mr_interface(interface),
};
set_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_DROP_MEMBERSHIP,
mreq)
}
#[cfg(target_os = "nto")]
fn leave_multicast_v6(&self, _: &Ipv6Addr, _: u32)
-> io::Result<()> {
Err(io::Error::new(io::ErrorKind::Unsupported, "not supported by platform"))
}
fn set_read_timeout_ms(&self, dur: Option<u32>) -> io::Result<()> {
set_opt(self.as_sock(), SOL_SOCKET, SO_RCVTIMEO,
ms2timeout(dur))
}
fn read_timeout_ms(&self) -> io::Result<Option<u32>> {
get_opt(self.as_sock(), SOL_SOCKET, SO_RCVTIMEO)
.map(timeout2ms)
}
fn set_write_timeout_ms(&self, dur: Option<u32>) -> io::Result<()> {
set_opt(self.as_sock(), SOL_SOCKET, SO_SNDTIMEO,
ms2timeout(dur))
}
fn write_timeout_ms(&self) -> io::Result<Option<u32>> {
get_opt(self.as_sock(), SOL_SOCKET, SO_SNDTIMEO)
.map(timeout2ms)
}
fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
self.set_read_timeout_ms(dur.map(dur2ms))
}
fn read_timeout(&self) -> io::Result<Option<Duration>> {
self.read_timeout_ms().map(|o| o.map(ms2dur))
}
fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
self.set_write_timeout_ms(dur.map(dur2ms))
}
fn write_timeout(&self) -> io::Result<Option<Duration>> {
self.write_timeout_ms().map(|o| o.map(ms2dur))
}
fn take_error(&self) -> io::Result<Option<io::Error>> {
get_opt(self.as_sock(), SOL_SOCKET, SO_ERROR).map(int2err)
}
fn connect<A: ToSocketAddrs>(&self, addr: A) -> io::Result<()> {
do_connect(self.as_sock(), addr)
}
#[cfg(unix)]
fn send(&self, buf: &[u8]) -> io::Result<usize> {
unsafe {
::cvt(send(self.as_sock() as c_int, buf.as_ptr() as *const _, buf.len(), 0)).map(|n| n as usize)
}
}
#[cfg(target_os = "wasi")]
fn send(&self, buf: &[u8]) -> io::Result<usize> {
let _so_datalen: *mut sys::c::size_t = &mut 0;
unsafe {
let _errno = libc::__wasi_sock_send(
self.as_sock() as libc::__wasi_fd_t,
buf.as_ptr() as *const _,
buf.len(),
0,
_so_datalen,
);
// TODO: handle errno
Ok((*_so_datalen) as usize)
}
}
#[cfg(windows)]
fn send(&self, buf: &[u8]) -> io::Result<usize> {
let len = ::std::cmp::min(buf.len(), c_int::max_value() as usize);
let buf = &buf[..len];
unsafe {
::cvt(send(self.as_sock(), buf.as_ptr() as *const _, len as c_int, 0))
.map(|n| n as usize)
}
}
#[cfg(unix)]
fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
unsafe {
::cvt(recv(self.as_sock(), buf.as_mut_ptr() as *mut _, buf.len(), 0))
.map(|n| n as usize)
}
}
#[cfg(target_os = "wasi")]
fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
let _ro_datalen: *mut sys::c::size_t = &mut 0;
let _ro_flags: *mut sys::c::__wasi_roflags_t = &mut 0;
unsafe {
let _errno = __wasi_sock_recv(
self.as_sock(),
buf.as_mut_ptr() as *mut _,
buf.len(),
0,
_ro_datalen,
_ro_flags,
);
// TODO: handle errno
Ok((*_ro_datalen) as usize)
}
}
#[cfg(windows)]
fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
let len = ::std::cmp::min(buf.len(), c_int::max_value() as usize);
let buf = &mut buf[..len];
unsafe {
::cvt(recv(self.as_sock(), buf.as_mut_ptr() as *mut _, buf.len() as c_int, 0))
.map(|n| n as usize)
}
}
fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
set_nonblocking(self.as_sock(), nonblocking)
}
}
fn do_connect<A: ToSocketAddrs>(sock: Socket, addr: A) -> io::Result<()> {
let err = io::Error::new(io::ErrorKind::Other,
"no socket addresses resolved");
let addrs = try!(addr.to_socket_addrs());
let sys = sys::Socket::from_inner(sock);
let sock = socket::Socket::from_inner(sys);
let ret = addrs.fold(Err(err), |prev, addr| {
prev.or_else(|_| sock.connect(&addr))
});
mem::forget(sock);
return ret
}
#[cfg(unix)]
fn set_nonblocking(sock: Socket, nonblocking: bool) -> io::Result<()> {
let mut nonblocking = nonblocking as c_ulong;
::cvt(unsafe {
ioctl(sock, FIONBIO, &mut nonblocking)
}).map(|_| ())
}
#[cfg(target_os = "wasi")]
fn set_nonblocking(_sock: Socket, _nonblocking: bool) -> io::Result<()> {
Ok(())
}
#[cfg(windows)]
fn set_nonblocking(sock: Socket, nonblocking: bool) -> io::Result<()> {
let mut nonblocking = nonblocking as c_ulong;
::cvt(unsafe {
ioctlsocket(sock, FIONBIO as c_int, &mut nonblocking)
}).map(|_| ())
}
#[cfg(any(unix, target_os = "wasi"))]
fn ip2in_addr(ip: &Ipv4Addr) -> in_addr {
let oct = ip.octets();
in_addr {
s_addr: ::hton(((oct[0] as u32) << 24) |
((oct[1] as u32) << 16) |
((oct[2] as u32) << 8) |
((oct[3] as u32) << 0)),
}
}
#[cfg(windows)]
fn ip2in_addr(ip: &Ipv4Addr) -> in_addr {
let oct = ip.octets();
unsafe {
let mut S_un: in_addr_S_un = mem::zeroed();
*S_un.S_addr_mut() = ::hton(((oct[0] as u32) << 24) |
((oct[1] as u32) << 16) |
((oct[2] as u32) << 8) |
((oct[3] as u32) << 0));
in_addr {
S_un: S_un,
}
}
}
fn in_addr2ip(ip: &in_addr) -> Ipv4Addr {
let h_addr = c::in_addr_to_u32(ip);
let a: u8 = (h_addr >> 24) as u8;
let b: u8 = (h_addr >> 16) as u8;
let c: u8 = (h_addr >> 8) as u8;
let d: u8 = (h_addr >> 0) as u8;
Ipv4Addr::new(a,b,c,d)
}
#[cfg(target_os = "android")]
fn to_ipv6mr_interface(value: u32) -> c_int {
value as c_int
}
#[cfg(not(target_os = "android"))]
fn to_ipv6mr_interface(value: u32) -> c_uint {
value as c_uint
}
fn ip2in6_addr(ip: &Ipv6Addr) -> in6_addr {
let mut ret: in6_addr = unsafe { mem::zeroed() };
let seg = ip.segments();
let bytes = [
(seg[0] >> 8) as u8,
(seg[0] >> 0) as u8,
(seg[1] >> 8) as u8,
(seg[1] >> 0) as u8,
(seg[2] >> 8) as u8,
(seg[2] >> 0) as u8,
(seg[3] >> 8) as u8,
(seg[3] >> 0) as u8,
(seg[4] >> 8) as u8,
(seg[4] >> 0) as u8,
(seg[5] >> 8) as u8,
(seg[5] >> 0) as u8,
(seg[6] >> 8) as u8,
(seg[6] >> 0) as u8,
(seg[7] >> 8) as u8,
(seg[7] >> 0) as u8,
];
#[cfg(windows)] unsafe { *ret.u.Byte_mut() = bytes; }
#[cfg(not(windows))] { ret.s6_addr = bytes; }
return ret
}
impl TcpListenerExt for TcpListener {
fn set_ttl(&self, ttl: u32) -> io::Result<()> {
set_opt(self.as_sock(), IPPROTO_IP, IP_TTL, ttl as c_int)
}
fn ttl(&self) -> io::Result<u32> {
get_opt::<c_int>(self.as_sock(), IPPROTO_IP, IP_TTL)
.map(|b| b as u32)
}
fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
set_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_V6ONLY, only_v6 as c_int)
}
fn only_v6(&self) -> io::Result<bool> {
get_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_V6ONLY).map(int2bool)
}
fn take_error(&self) -> io::Result<Option<io::Error>> {
get_opt(self.as_sock(), SOL_SOCKET, SO_ERROR).map(int2err)
}
fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
set_nonblocking(self.as_sock(), nonblocking)
}
fn set_linger(&self, dur: Option<Duration>) -> io::Result<()> {
set_opt(self.as_sock(), SOL_SOCKET, SO_LINGER, dur2linger(dur))
}
fn linger(&self) -> io::Result<Option<Duration>> {
get_opt(self.as_sock(), SOL_SOCKET, SO_LINGER).map(linger2dur)
}
}
impl TcpBuilder {
/// Sets the value for the `IP_TTL` option on this socket.
///
/// This is the same as [`TcpStreamExt::set_ttl`][other].
///
/// [other]: trait.TcpStreamExt.html#tymethod.set_ttl
pub fn ttl(&self, ttl: u32) -> io::Result<&Self> {
set_opt(self.as_sock(), IPPROTO_IP, IP_TTL, ttl as c_int)
.map(|()| self)
}
/// Sets the value for the `IPV6_V6ONLY` option on this socket.
///
/// This is the same as [`TcpStreamExt::set_only_v6`][other].
///
/// [other]: trait.TcpStreamExt.html#tymethod.set_only_v6
pub fn only_v6(&self, only_v6: bool) -> io::Result<&Self> {
set_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_V6ONLY, only_v6 as c_int)
.map(|()| self)
}
/// Set value for the `SO_REUSEADDR` option on this socket.
///
/// This indicates that further calls to `bind` may allow reuse of local
/// addresses. For IPv4 sockets this means that a socket may bind even when
/// there's a socket already listening on this port.
pub fn reuse_address(&self, reuse: bool) -> io::Result<&Self> {
set_opt(self.as_sock(), SOL_SOCKET, SO_REUSEADDR,
reuse as c_int).map(|()| self)
}
/// Check the `SO_REUSEADDR` option on this socket.
pub fn get_reuse_address(&self) -> io::Result<bool> {
get_opt(self.as_sock(), SOL_SOCKET, SO_REUSEADDR).map(int2bool)
}
/// 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>> {
get_opt(self.as_sock(), SOL_SOCKET, SO_ERROR).map(int2err)
}
/// Sets the linger option for this socket
fn set_linger(&self, dur: Option<Duration>) -> io::Result<()> {
set_opt(self.as_sock(), SOL_SOCKET, SO_LINGER, dur2linger(dur))
}
/// Gets the linger option for this socket
fn linger(&self) -> io::Result<Option<Duration>> {
get_opt(self.as_sock(), SOL_SOCKET, SO_LINGER).map(linger2dur)
}
}
impl UdpBuilder {
/// Sets the value for the `IP_TTL` option on this socket.
///
/// This is the same as [`TcpStreamExt::set_ttl`][other].
///
/// [other]: trait.TcpStreamExt.html#tymethod.set_ttl
pub fn ttl(&self, ttl: u32) -> io::Result<&Self> {
set_opt(self.as_sock(), IPPROTO_IP, IP_TTL, ttl as c_int)
.map(|()| self)
}
/// Sets the value for the `IPV6_V6ONLY` option on this socket.
///
/// This is the same as [`TcpStream::only_v6`][other].
///
/// [other]: struct.TcpBuilder.html#method.only_v6
pub fn only_v6(&self, only_v6: bool) -> io::Result<&Self> {
set_opt(self.as_sock(), v(IPPROTO_IPV6), IPV6_V6ONLY, only_v6 as c_int)
.map(|()| self)
}
/// Set value for the `SO_REUSEADDR` option on this socket.
///
/// This is the same as [`TcpBuilder::reuse_address`][other].
///
/// [other]: struct.TcpBuilder.html#method.reuse_address
pub fn reuse_address(&self, reuse: bool) -> io::Result<&Self> {
set_opt(self.as_sock(), SOL_SOCKET, SO_REUSEADDR,
reuse as c_int).map(|()| self)
}
/// Check the `SO_REUSEADDR` option on this socket.
pub fn get_reuse_address(&self) -> io::Result<bool> {
get_opt(self.as_sock(), SOL_SOCKET, SO_REUSEADDR).map(int2bool)
}
/// 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>> {
get_opt(self.as_sock(), SOL_SOCKET, SO_ERROR).map(int2err)
}
}