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
use std::io::{self, ErrorKind, IoSlice, IoSliceMut};
use std::mem;
use std::net::Shutdown;
use std::os::unix::io::{RawFd, FromRawFd, AsRawFd, IntoRawFd};
use std::path::Path;
use std::time::Duration;
use libc::{SOCK_SEQPACKET, MSG_EOR, MSG_PEEK, c_void, close, send};
#[cfg(feature="mio")]
use mio::{event::Evented, unix::EventedFd, Poll, Token as Token_06, Ready, PollOpt};
#[cfg(feature="mio_07")]
use mio_07::{event::Source, unix::SourceFd, Registry, Token as Token_07, Interest};
use crate::addr::*;
use crate::helpers::*;
use crate::ancillary::*;
use crate::credentials::*;
/// Implements traits apropriate for any file-descriptor-wrapping type.
macro_rules! impl_rawfd_traits {($type:tt) => {
impl FromRawFd for $type {
unsafe fn from_raw_fd(fd: RawFd) -> Self {
$type { fd }
}
}
impl AsRawFd for $type {
fn as_raw_fd(&self) -> RawFd {
self.fd
}
}
impl IntoRawFd for $type {
fn into_raw_fd(self) -> RawFd {
let fd = self.fd;
mem::forget(self);
fd
}
}
impl Drop for $type {
fn drop(&mut self) {
let _ = unsafe { close(self.fd) };
}
}
}}
/// Implements `mio::Evented` and `mio::Source` for a fd-wrapping type.
macro_rules! impl_mio_if_enabled {($type:tt) => {
#[cfg(feature="mio")]
impl Evented for $type {
fn register(&self, poll: &Poll, token: Token_06, interest: Ready, opts: PollOpt)
-> Result<(), io::Error> {
EventedFd(&self.fd).register(poll, token, interest, opts)
}
fn reregister(&self, poll: &Poll, token: Token_06, interest: Ready, opts: PollOpt)
-> Result<(), io::Error> {
EventedFd(&self.fd).reregister(poll, token, interest, opts)
}
fn deregister(&self, poll: &Poll) -> Result<(), io::Error> {
EventedFd(&self.fd).deregister(poll)
}
}
#[cfg(feature="mio_07")]
impl Source for $type {
fn register(&mut self, registry: &Registry, token: Token_07, interest: Interest)
-> Result<(), io::Error> {
SourceFd(&self.fd).register(registry, token, interest)
}
fn reregister(&mut self, registry: &Registry, token: Token_07, interest: Interest)
-> Result<(), io::Error> {
SourceFd(&self.fd).reregister(registry, token, interest)
}
fn deregister(&mut self, registry: &Registry) -> Result<(), io::Error> {
SourceFd(&self.fd).deregister(registry)
}
}
#[cfg(feature="mio_07")]
impl<'a> Source for &'a $type {
fn register(&mut self, registry: &Registry, token: Token_07, interest: Interest)
-> Result<(), io::Error> {
SourceFd(&self.fd).register(registry, token, interest)
}
fn reregister(&mut self, registry: &Registry, token: Token_07, interest: Interest)
-> Result<(), io::Error> {
SourceFd(&self.fd).reregister(registry, token, interest)
}
fn deregister(&mut self, registry: &Registry) -> Result<(), io::Error> {
SourceFd(&self.fd).deregister(registry)
}
}
}}
/// An unix domain sequential packet connection.
///
/// Sequential-packet connections have an interface similar to streams,
/// but behave more like connected datagram sockets.
///
/// They have guaranteed in-order and reliable delivery,
/// which unix datagrams technically doesn't.
///
/// # Operating system support
///
/// Sequential-packet sockets are supported by Linux, FreeBSD, NetBSD
/// and Illumos, but not by for example macOS or OpenBSD.
///
/// # Zero-length packets
///
/// ... are best avoided:
/// On Linux and FreeBSD zero-length packets can be sent and received,
/// but there is no way to distinguish receiving one from reaching
/// end of connection unless the packet has an ancillary payload.
/// Also beware of trying to receive with a zero-length buffer,
/// as that will on FreeBSD (and probably other BSDs with seqpacket sockets)
/// always succeed even if there is no packet waiting.
///
/// Illumos and Solaris doesn't support receiving zero-length packets at all:
/// writes succeed but recv() will block.
///
/// # Examples
///
/// What is sent separately is received separately:
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// let (a, b) = uds::UnixSeqpacketConn::pair().expect("Cannot create seqpacket pair");
///
/// a.send(b"first").unwrap();
/// a.send(b"second").unwrap();
///
/// let mut buffer_big_enough_for_both = [0; 20];
/// let (len, _truncated) = b.recv(&mut buffer_big_enough_for_both).unwrap();
/// assert_eq!(&buffer_big_enough_for_both[..len], b"first");
/// let (len, _truncated) = b.recv(&mut buffer_big_enough_for_both).unwrap();
/// assert_eq!(&buffer_big_enough_for_both[..len], b"second");
/// ```
///
/// Connect to a listener on a socket file and write to it:
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// use uds::{UnixSeqpacketListener, UnixSeqpacketConn};
///
/// # let _ = std::fs::remove_file("seqpacket.socket"); // pre-emptively delete just in case
/// let listener = UnixSeqpacketListener::bind("seqpacket.socket")
/// .expect("create seqpacket listener");
/// let conn = UnixSeqpacketConn::connect("seqpacket.socket")
/// .expect("connect to seqpacket listener");
///
/// let message = "Hello, listener";
/// let sent = conn.send(message.as_bytes()).unwrap();
/// assert_eq!(sent, message.len());
///
/// std::fs::remove_file("seqpacket.socket").unwrap(); // clean up after ourselves
/// ```
///
/// Connect to a listener on an abstract address:
///
#[cfg_attr(any(target_os="linux", target_os="android"), doc="```")]
#[cfg_attr(not(any(target_os="linux", target_os="android")), doc="```no_run")]
/// use uds::{UnixSeqpacketListener, UnixSeqpacketConn, UnixSocketAddr};
///
/// let addr = UnixSocketAddr::new("@seqpacket example").unwrap();
/// let listener = UnixSeqpacketListener::bind_unix_addr(&addr)
/// .expect("create abstract seqpacket listener");
/// let _client = UnixSeqpacketConn::connect_unix_addr(&addr)
/// .expect("connect to abstract seqpacket listener");
/// let (_server, _addr) = listener.accept_unix_addr().unwrap();
/// ```
#[derive(Debug)]
#[repr(transparent)]
pub struct UnixSeqpacketConn {
fd: RawFd,
}
impl_rawfd_traits!{UnixSeqpacketConn}
impl UnixSeqpacketConn {
/// Connects to an unix seqpacket server listening at `path`.
///
/// This is a wrapper around [`connect_unix_addr()`](#method.connect_unix_addr)
/// for convenience and compatibility with std.
pub fn connect<P: AsRef<Path>>(path: P) -> Result<Self, io::Error> {
let addr = UnixSocketAddr::from_path(&path)?;
Self::connect_unix_addr(&addr)
}
/// Connects to an unix seqpacket server listening at `addr`.
pub fn connect_unix_addr(addr: &UnixSocketAddr) -> Result<Self, io::Error> {
let socket = Socket::new(SOCK_SEQPACKET, false)?;
set_unix_addr(socket.as_raw_fd(), SetAddr::PEER, addr)?;
Ok(UnixSeqpacketConn { fd: socket.into_raw_fd() })
}
/// Binds to an address before connecting to a listening seqpacet socket.
pub fn connect_from_to_unix_addr(from: &UnixSocketAddr, to: &UnixSocketAddr)
-> Result<Self, io::Error> {
let socket = Socket::new(SOCK_SEQPACKET, false)?;
set_unix_addr(socket.as_raw_fd(), SetAddr::LOCAL, from)?;
set_unix_addr(socket.as_raw_fd(), SetAddr::PEER, to)?;
Ok(UnixSeqpacketConn { fd: socket.into_raw_fd() })
}
/// Creates a pair of unix-domain seqpacket conneections connected to each other.
///
/// # Examples
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// let (a, b) = uds::UnixSeqpacketConn::pair().unwrap();
/// assert!(a.local_unix_addr().unwrap().is_unnamed());
/// assert!(b.local_unix_addr().unwrap().is_unnamed());
///
/// a.send(b"hello").unwrap();
/// b.recv(&mut[0; 20]).unwrap();
/// ```
pub fn pair() -> Result<(Self, Self), io::Error> {
let (a, b) = Socket::pair(SOCK_SEQPACKET, false)?;
let a = UnixSeqpacketConn { fd: a.into_raw_fd() };
let b = UnixSeqpacketConn { fd: b.into_raw_fd() };
Ok((a, b))
}
/// Returns the address of this side of the connection.
pub fn local_unix_addr(&self) -> Result<UnixSocketAddr, io::Error> {
get_unix_addr(self.fd, GetAddr::LOCAL)
}
/// Returns the address of the other side of the connection.
pub fn peer_unix_addr(&self) -> Result<UnixSocketAddr, io::Error> {
get_unix_addr(self.fd, GetAddr::PEER)
}
/// Returns information about the process of the peer when the connection was established.
///
/// See documentation of the returned type for details.
pub fn initial_peer_credentials(&self) -> Result<ConnCredentials, io::Error> {
peer_credentials(self.fd)
}
/// Returns the SELinux security context of the process that created the other
/// end of this connection.
///
/// Will return an error on other operating systems than Linux or Android,
/// and also if running inside kubernetes.
/// On success the number of bytes used is returned. (like `Read`)
///
/// The default security context is `unconfined`, without any trailing NUL.
/// A buffor of 50 bytes is probably always big enough.
pub fn initial_peer_selinux_context(&self, buf: &mut[u8]) -> Result<usize, io::Error> {
selinux_context(self.as_raw_fd(), buf)
}
/// Sends a packet to the peer.
pub fn send(&self, packet: &[u8]) -> Result<usize, io::Error> {
let ptr = packet.as_ptr() as *const c_void;
let flags = MSG_NOSIGNAL | MSG_EOR;
let sent = cvt_r!(unsafe { send(self.fd, ptr, packet.len(), flags) })?;
Ok(sent as usize)
}
/// Receives a packet from the peer.
///
/// The returned `bool` indicates whether the packet was truncated due to
/// the buffer beeing too small.
pub fn recv(&self, buffer: &mut[u8]) -> Result<(usize, bool), io::Error> {
let mut buffers = [IoSliceMut::new(buffer)];
let (bytes, ancillary) = recv_ancillary(self.fd, None, 0, &mut buffers, &mut[])?;
Ok((bytes, ancillary.message_truncated()))
}
/// Sends a packet assembled from multiple byte slices.
pub fn send_vectored(&self, slices: &[IoSlice])
-> Result<usize, io::Error> {
// Can't use writev() because we need to pass flags,
// and the flags accepted by pwritev2() aren't the one we need to pass.
send_ancillary(self.as_raw_fd(), None, MSG_EOR, slices, &[], None)
}
/// Reads a packet into multiple buffers.
///
/// The returned `bool` indicates whether the packet was truncated due to
/// too short buffers.
pub fn recv_vectored(&self, buffers: &mut[IoSliceMut])
-> Result<(usize, bool), io::Error> {
recv_ancillary(self.fd, None, 0, buffers, &mut[])
.map(|(bytes, ancillary)| (bytes, ancillary.message_truncated()) )
}
/// Sends a packet with associated file descriptors.
pub fn send_fds(&self, bytes: &[u8], fds: &[RawFd])
-> Result<usize, io::Error> {
send_ancillary(self.fd, None, MSG_EOR, &[IoSlice::new(bytes)], fds, None)
}
/// Receives a packet and associated file descriptors.
pub fn recv_fds(&self, byte_buffer: &mut[u8], fd_buffer: &mut[RawFd])
-> Result<(usize, bool, usize), io::Error> {
recv_fds(self.fd, None, &mut[IoSliceMut::new(byte_buffer)], fd_buffer)
}
/// Receives a packet without removing it from the incoming queue.
///
/// The returned `bool` indicates whether the packet was truncated due to
/// the buffer being too small.
///
/// # Examples
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// let (a, b) = uds::UnixSeqpacketConn::pair().unwrap();
/// a.send(b"hello").unwrap();
/// let mut buf = [0u8; 10];
/// assert_eq!(b.peek(&mut buf[..1]).unwrap(), (1, true));
/// assert_eq!(&buf[..2], &[b'h', 0]);
/// assert_eq!(b.peek(&mut buf).unwrap(), (5, false));
/// assert_eq!(&buf[..5], b"hello");
/// assert_eq!(b.recv(&mut buf).unwrap(), (5, false));
/// assert_eq!(&buf[..5], b"hello");
/// ```
pub fn peek(&self, buffer: &mut[u8]) -> Result<(usize, bool), io::Error> {
let mut buffers = [IoSliceMut::new(buffer)];
recv_ancillary(self.fd, None, MSG_PEEK, &mut buffers, &mut[])
.map(|(bytes, ancillary)| (bytes, ancillary.message_truncated()) )
}
/// Receives a packet without removing it from the incoming queue.
///
/// The returned `bool` indicates whether the packet was truncated due to
/// the combined buffers being too small.
pub fn peek_vectored(&self, buffers: &mut[IoSliceMut])
-> Result<(usize, bool), io::Error> {
recv_ancillary(self.fd, None, MSG_PEEK, buffers, &mut[])
.map(|(bytes, ancillary)| (bytes, ancillary.message_truncated()) )
}
/// Returns the value of the `SO_ERROR` option.
///
/// This might only provide errors generated from nonblocking `connect()`s,
/// which this library doesn't support. It is therefore unlikely to be
/// useful, but is provided for parity with stream counterpart in std.
///
/// # Examples
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// let (a, b) = uds::UnixSeqpacketConn::pair().unwrap();
/// drop(b);
///
/// assert!(a.send(b"anyone there?").is_err());
/// assert!(a.take_error().unwrap().is_none());
/// ```
pub fn take_error(&self) -> Result<Option<io::Error>, io::Error> {
take_error(self.fd)
}
/// Creates a new file descriptor also pointing to this side of this connection.
///
/// # Examples
///
/// Both new and old can send and receive, and share queues:
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// let (a1, b) = uds::nonblocking::UnixSeqpacketConn::pair().unwrap();
/// let a2 = a1.try_clone().unwrap();
///
/// a1.send(b"first").unwrap();
/// a2.send(b"second").unwrap();
///
/// let mut buf = [0u8; 20];
/// let (len, _truncated) = b.recv(&mut buf).unwrap();
/// assert_eq!(&buf[..len], b"first");
/// b.send(b"hello first").unwrap();
/// let (len, _truncated) = b.recv(&mut buf).unwrap();
/// assert_eq!(&buf[..len], b"second");
/// b.send(b"hello second").unwrap();
///
/// let (len, _truncated) = a2.recv(&mut buf).unwrap();
/// assert_eq!(&buf[..len], b"hello first");
/// let (len, _truncated) = a1.recv(&mut buf).unwrap();
/// assert_eq!(&buf[..len], b"hello second");
/// ```
///
/// Clone can still be used after the first one has been closed:
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// let (a, b1) = uds::nonblocking::UnixSeqpacketConn::pair().unwrap();
/// a.send(b"hello").unwrap();
///
/// let b2 = b1.try_clone().unwrap();
/// drop(b1);
/// assert_eq!(b2.recv(&mut[0; 10]).unwrap().0, "hello".len());
/// ```
pub fn try_clone(&self) -> Result<Self, io::Error> {
let cloned = Socket::try_clone_from(self.fd)?;
Ok(UnixSeqpacketConn { fd: cloned.into_raw_fd() })
}
/// Sets the read timeout to the duration specified.
///
/// If the value specified is `None`, then `recv()` and its variants will
/// block indefinitely.
/// An error is returned if the duration is zero.
///
/// The duration is rounded to microsecond precission.
/// Currently it's rounded down except if that would make it all zero.
///
/// # Operating System Support
///
/// On Illumos (and pressumably also Solaris) timeouts appears not to work
/// for unix domain sockets.
///
/// # Examples
///
#[cfg_attr(not(any(target_vendor="apple", target_os="illumos", target_os="solaris")), doc="```")]
#[cfg_attr(any(target_vendor="apple", target_os="illumos", target_os="solaris"), doc="```no_run")]
/// use std::io::ErrorKind;
/// use std::time::Duration;
/// use uds::UnixSeqpacketConn;
///
/// let (a, b) = UnixSeqpacketConn::pair().unwrap();
/// a.set_read_timeout(Some(Duration::new(0, 2_000_000))).unwrap();
/// let error = a.recv(&mut[0; 1024]).unwrap_err();
/// assert_eq!(error.kind(), ErrorKind::WouldBlock);
/// ```
pub fn set_read_timeout(&self, timeout: Option<Duration>)
-> Result<(), io::Error> {
set_timeout(self.fd, TimeoutDirection::READ, timeout)
}
/// Returns the read timeout of this socket.
///
/// `None` is returned if there is no timeout.
///
/// Note that subsecond parts might have been be rounded by the OS
/// (in addition to the rounding to microsecond in `set_read_timeout()`).
///
/// # Examples
///
#[cfg_attr(not(any(target_vendor="apple", target_os="illumos", target_os="solaris")), doc="```")]
#[cfg_attr(any(target_vendor="apple", target_os="illumos", target_os="solaris"), doc="```no_run")]
/// use uds::UnixSeqpacketConn;
/// use std::time::Duration;
///
/// let timeout = Some(Duration::new(2, 0));
/// let conn = UnixSeqpacketConn::pair().unwrap().0;
/// conn.set_read_timeout(timeout).unwrap();
/// assert_eq!(conn.read_timeout().unwrap(), timeout);
/// ```
pub fn read_timeout(&self) -> Result<Option<Duration>, io::Error> {
get_timeout(self.fd, TimeoutDirection::READ)
}
/// Sets the write timeout to the duration specified.
///
/// If the value specified is `None`, then `send()` and its variants will
/// block indefinitely.
/// An error is returned if the duration is zero.
///
/// # Operating System Support
///
/// On Illumos (and pressumably also Solaris) timeouts appears not to work
/// for unix domain sockets.
///
/// # Examples
///
#[cfg_attr(not(any(target_vendor="apple", target_os="illumos", target_os="solaris")), doc="```")]
#[cfg_attr(any(target_vendor="apple", target_os="illumos", target_os="solaris"), doc="```no_run")]
/// # use std::io::ErrorKind;
/// # use std::time::Duration;
/// # use uds::UnixSeqpacketConn;
/// #
/// let (conn, _other) = UnixSeqpacketConn::pair().unwrap();
/// conn.set_write_timeout(Some(Duration::new(0, 500 * 1000))).unwrap();
/// loop {
/// if let Err(e) = conn.send(&[0; 1000]) {
/// assert_eq!(e.kind(), ErrorKind::WouldBlock, "{}", e);
/// break
/// }
/// }
/// ```
pub fn set_write_timeout(&self, timeout: Option<Duration>)
-> Result<(), io::Error> {
set_timeout(self.fd, TimeoutDirection::WRITE, timeout)
}
/// Returns the write timeout of this socket.
///
/// `None` is returned if there is no timeout.
///
/// # Examples
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// let conn = uds::UnixSeqpacketConn::pair().unwrap().0;
/// assert!(conn.write_timeout().unwrap().is_none());
/// ```
pub fn write_timeout(&self) -> Result<Option<Duration>, io::Error> {
get_timeout(self.fd, TimeoutDirection::WRITE)
}
/// Enables or disables nonblocking mode.
///
/// Consider using the nonblocking variant of this type instead.
/// This method mainly exists for feature parity with std's `UnixStream`.
///
/// # Examples
///
/// Trying to receive when there are no packets waiting:
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// # use std::io::ErrorKind;
/// # use uds::UnixSeqpacketConn;
/// let (a, b) = UnixSeqpacketConn::pair().expect("create seqpacket pair");
/// a.set_nonblocking(true).unwrap();
/// assert_eq!(a.recv(&mut[0; 20]).unwrap_err().kind(), ErrorKind::WouldBlock);
/// ```
///
/// Trying to send when the OS buffer for the connection is full:
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// # use std::io::ErrorKind;
/// # use uds::UnixSeqpacketConn;
/// let (a, b) = UnixSeqpacketConn::pair().expect("create seqpacket pair");
/// a.set_nonblocking(true).unwrap();
/// loop {
/// if let Err(error) = a.send(&[b'#'; 1000]) {
/// assert_eq!(error.kind(), ErrorKind::WouldBlock);
/// break;
/// }
/// }
/// ```
pub fn set_nonblocking(&self, nonblocking: bool) -> Result<(), io::Error> {
set_nonblocking(self.fd, nonblocking)
}
/// Shuts down the read, write, or both halves of this connection.
pub fn shutdown(&self, how: Shutdown) -> io::Result<()> {
let how = match how {
Shutdown::Read => libc::SHUT_RD,
Shutdown::Write => libc::SHUT_WR,
Shutdown::Both => libc::SHUT_RDWR,
};
unsafe { cvt!(libc::shutdown(self.as_raw_fd(), how)) }?;
Ok(())
}
}
/// An unix domain listener for sequential packet connections.
///
/// See [`UnixSeqpacketConn`](struct.UnixSeqpacketConn.html) for a description
/// of this type of connection.
///
/// # Examples
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// # let _ = std::fs::remove_file("seqpacket_listener.socket");
/// let listener = uds::UnixSeqpacketListener::bind("seqpacket_listener.socket")
/// .expect("Create seqpacket listener");
/// let _client = uds::UnixSeqpacketConn::connect("seqpacket_listener.socket").unwrap();
/// let (conn, _addr) = listener.accept_unix_addr().unwrap();
/// conn.send(b"Welcome").unwrap();
/// # std::fs::remove_file("seqpacket_listener.socket").unwrap();
/// ```
#[derive(Debug)]
#[repr(transparent)]
pub struct UnixSeqpacketListener {
fd: RawFd
}
impl_rawfd_traits!{UnixSeqpacketListener}
impl UnixSeqpacketListener {
/// Creates a socket that listens for seqpacket connections on the specified socket file.
pub fn bind<P: AsRef<Path>>(path: P) -> Result<Self, io::Error> {
let addr = UnixSocketAddr::from_path(path.as_ref())?;
Self::bind_unix_addr(&addr)
}
/// Creates a socket that listens for seqpacket connections on the specified address.
pub fn bind_unix_addr(addr: &UnixSocketAddr) -> Result<Self, io::Error> {
let socket = Socket::new(SOCK_SEQPACKET, false)?;
set_unix_addr(socket.as_raw_fd(), SetAddr::LOCAL, addr)?;
socket.start_listening()?;
Ok(UnixSeqpacketListener { fd: socket.into_raw_fd() })
}
/// Returns the address the socket is listening on.
pub fn local_unix_addr(&self) -> Result<UnixSocketAddr, io::Error> {
get_unix_addr(self.fd, GetAddr::LOCAL)
}
/// Accepts a new incoming connection to this listener.
pub fn accept_unix_addr(&self)
-> Result<(UnixSeqpacketConn, UnixSocketAddr), io::Error> {
let (socket, addr) = Socket::accept_from(self.fd, false)?;
let conn = UnixSeqpacketConn { fd: socket.into_raw_fd() };
Ok((conn, addr))
}
/// Returns the value of the `SO_ERROR` option.
///
/// This might never produce any errors for listeners. It is therefore
/// unlikely to be useful, but is provided for parity with
/// `std::unix::net::UnixListener`.
pub fn take_error(&self) -> Result<Option<io::Error>, io::Error> {
take_error(self.fd)
}
/// Creates a new file descriptor listening for the same connections.
pub fn try_clone(&self) -> Result<Self, io::Error> {
let cloned = Socket::try_clone_from(self.fd)?;
Ok(UnixSeqpacketListener { fd: cloned.into_raw_fd() })
}
/// Sets a maximum duration to wait in a single `accept()` on this socket.
///
/// `None` disables a previously set timeout.
/// An error is returned if the duration is zero.
///
/// # Operating System Support
///
/// Only Linux appers to apply timeouts to `accept()`.
/// On macOS, FreeBSD and NetBSD, timeouts are silently ignored.
/// On Illumos setting timeouts for all unix domain sockets silently fails.
///
/// On OSes where timeouts are known to not work, this function will
/// return an error even if setting the timeout didn't fail.
///
/// # Examples
///
#[cfg_attr(any(target_os="linux", target_os="android"), doc="```")]
#[cfg_attr(not(any(target_os="linux", target_os="android")), doc="```no_run")]
/// # use uds::{UnixSeqpacketListener, UnixSocketAddr};
/// # use std::io::ErrorKind;
/// # use std::time::Duration;
/// #
/// # let addr = UnixSocketAddr::new("@set_timeout").unwrap();
/// let listener = UnixSeqpacketListener::bind_unix_addr(&addr).unwrap();
/// listener.set_timeout(Some(Duration::new(0, 200_000_000))).unwrap();
/// let err = listener.accept_unix_addr().unwrap_err();
/// assert_eq!(err.kind(), ErrorKind::WouldBlock);
/// ```
pub fn set_timeout(&self, timeout: Option<Duration>)
-> Result<(), io::Error> {
match set_timeout(self.fd, TimeoutDirection::READ, timeout) {
#[cfg(any(
target_vendor="apple", target_os="freebsd",
target_os="netbsd",
target_os="illumos", target_os="solaris",
))]
Ok(()) if timeout.is_some() => Err(io::Error::new(
ErrorKind::InvalidInput,
"listener timeouts are not supported on this OS"
)),
result => result
}
}
/// Returns the timeout for `accept()` on this socket.
///
/// `None` is returned if there is no timeout.
///
/// Even if a timeout has is set, it is ignored by `accept()` on
/// most operating systems except Linux.
///
/// # Examples
///
#[cfg_attr(any(target_os="linux", target_os="android"), doc="```")]
#[cfg_attr(not(any(target_os="linux", target_os="android")), doc="```no_run")]
/// # use uds::{UnixSeqpacketListener, UnixSocketAddr};
/// # use std::time::Duration;
/// #
/// # let addr = UnixSocketAddr::new("@timeout").unwrap();
/// let listener = UnixSeqpacketListener::bind_unix_addr(&addr).unwrap();
/// assert_eq!(listener.timeout().unwrap(), None);
/// let timeout = Some(Duration::new(2, 0));
/// listener.set_timeout(timeout).unwrap();
/// assert_eq!(listener.timeout().unwrap(), timeout);
/// ```
pub fn timeout(&self) -> Result<Option<Duration>, io::Error> {
get_timeout(self.fd, TimeoutDirection::READ)
}
/// Enables or disables nonblocking-ness of [`accept_unix_addr()`](#method.accept_unix addr).
///
/// The returned connnections will still be in blocking mode regardsless.
///
/// Consider using the nonblocking variant of this type instead;
/// this method mostly exists for feature parity with std's `UnixListener`.
///
/// # Examples
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// # use std::io::ErrorKind;
/// # use uds::{UnixSocketAddr, UnixSeqpacketListener};
/// #
/// # let addr = UnixSocketAddr::from_path("nonblocking_seqpacket_listener.socket").unwrap();
/// # let _ = std::fs::remove_file("nonblocking_seqpacket_listener.socket");
/// let listener = UnixSeqpacketListener::bind_unix_addr(&addr).expect("create listener");
/// listener.set_nonblocking(true).expect("enable noblocking mode");
/// assert_eq!(listener.accept_unix_addr().unwrap_err().kind(), ErrorKind::WouldBlock);
/// # std::fs::remove_file("nonblocking_seqpacket_listener.socket").expect("delete socket file");
/// ```
pub fn set_nonblocking(&self, nonblocking: bool) -> Result<(), io::Error> {
set_nonblocking(self.fd, nonblocking)
}
}
/// A non-blocking unix domain sequential-packet connection.
///
/// Differs from [`uds::UnixSeqpacketConn`](../struct.UnixSeqpacketConn.html)
/// in that all operations that send or receive data will return an `Error` of
/// kind `ErrorKind::WouldBlock` instead of blocking.
/// This is done by creating the socket as non-blocking, and not by passing
/// `MSG_DONTWAIT`. If creating this type from a raw file descriptor, ensure
/// the fd is set to nonblocking before using it through this type.
///
/// This type can be used with mio if one of the mio features are enabled:
///
/// For mio version 0.6:
///
/// ```toml
/// uds = { version = "x.y", features=["mio"] }
/// ```
///
/// For mio version 0.7:
///
/// ```toml
/// uds = { version = "x.y", features=["mio_07"] }
/// ```
///
/// # Examples
///
/// Sending or receiving when it would block a normal socket:
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// use uds::nonblocking::UnixSeqpacketConn;
/// use std::io::ErrorKind;
///
/// let (a, b) = UnixSeqpacketConn::pair().expect("create nonblocking seqpacket pair");
///
/// // trying to receive when there are no packets waiting
/// assert_eq!(a.recv(&mut[0]).unwrap_err().kind(), ErrorKind::WouldBlock);
///
/// // trying to send when the OS buffer for the connection is full
/// loop {
/// if let Err(error) = a.send(&[0u8; 1000]) {
/// assert_eq!(error.kind(), ErrorKind::WouldBlock);
/// break;
/// }
/// }
/// ```
///
/// Registering with mio (v0.6):
///
#[cfg_attr(all(feature="mio", not(target_vendor="apple")), doc="```")]
#[cfg_attr(all(feature="mio", target_vendor="apple"), doc="```no_run")]
#[cfg_attr(not(feature="mio"), doc="```no_compile")]
/// use uds::nonblocking::UnixSeqpacketConn;
/// use mio::{Poll, Token, Ready, PollOpt, Events};
/// use std::io::ErrorKind;
///
/// let (a, b) = UnixSeqpacketConn::pair()
/// .expect("create nonblocking seqpacket pair");
///
/// let poll = Poll::new().expect("create mio poll");
/// let mut events = Events::with_capacity(10);
/// poll.register(&a, Token(1), Ready::all(), PollOpt::edge())
/// .expect("register unix seqpacket connection with mio");
///
/// b.send(b"this is it").expect("send seqpacket");
///
/// poll.poll(&mut events, None).expect("receive mio notifications");
/// let current_events = events.iter().collect::<Vec<_>>();
/// assert!(current_events.len() > 0);
/// assert_eq!(current_events[0].token(), Token(1));
/// assert_eq!(a.recv(&mut [0; 8]).expect("receive packet"), (8, true/*truncated*/));
/// ```
#[derive(Debug)]
#[repr(transparent)]
pub struct NonblockingUnixSeqpacketConn {
fd: RawFd,
}
impl_rawfd_traits!{NonblockingUnixSeqpacketConn}
impl_mio_if_enabled!{NonblockingUnixSeqpacketConn}
// can't Deref<Target=UnixSeqpacketConn> because that would include try_clone()
// and later set_(read|write)_timeout()
impl NonblockingUnixSeqpacketConn {
/// Connects to an unix seqpacket server listening at `path`.
///
/// This is a wrapper around [`connect_unix_addr()`](#method.connect_unix_addr)
/// for convenience and compatibility with std.
pub fn connect<P: AsRef<Path>>(path: P) -> Result<Self, io::Error> {
let addr = UnixSocketAddr::from_path(&path)?;
Self::connect_unix_addr(&addr)
}
/// Connects to an unix seqpacket server listening at `addr`.
pub fn connect_unix_addr(addr: &UnixSocketAddr) -> Result<Self, io::Error> {
let socket = Socket::new(SOCK_SEQPACKET, true)?;
set_unix_addr(socket.as_raw_fd(), SetAddr::PEER, addr)?;
Ok(NonblockingUnixSeqpacketConn { fd: socket.into_raw_fd() })
}
/// Binds to an address before connecting to a listening seqpacket socket.
pub fn connect_from_to_unix_addr(from: &UnixSocketAddr, to: &UnixSocketAddr)
-> Result<Self, io::Error> {
let socket = Socket::new(SOCK_SEQPACKET, true)?;
set_unix_addr(socket.as_raw_fd(), SetAddr::LOCAL, from)?;
set_unix_addr(socket.as_raw_fd(), SetAddr::PEER, to)?;
Ok(NonblockingUnixSeqpacketConn { fd: socket.into_raw_fd() })
}
/// Creates a pair of nonblocking unix-domain seqpacket conneections connected to each other.
///
/// # Examples
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// let (a, b) = uds::nonblocking::UnixSeqpacketConn::pair().unwrap();
/// assert!(a.local_unix_addr().unwrap().is_unnamed());
/// assert!(b.local_unix_addr().unwrap().is_unnamed());
/// assert_eq!(b.recv(&mut[0; 20]).unwrap_err().kind(), std::io::ErrorKind::WouldBlock);
/// a.send(b"hello").unwrap();
/// assert_eq!(b.recv(&mut[0; 20]).unwrap(), (5, false));
/// ```
pub fn pair() -> Result<(Self, Self), io::Error> {
let (a, b) = Socket::pair(SOCK_SEQPACKET, true)?;
let a = NonblockingUnixSeqpacketConn { fd: a.into_raw_fd() };
let b = NonblockingUnixSeqpacketConn { fd: b.into_raw_fd() };
Ok((a, b))
}
/// Returns the address of this side of the connection.
pub fn local_unix_addr(&self) -> Result<UnixSocketAddr, io::Error> {
get_unix_addr(self.fd, GetAddr::LOCAL)
}
/// Returns the address of the other side of the connection.
pub fn peer_unix_addr(&self) -> Result<UnixSocketAddr, io::Error> {
get_unix_addr(self.fd, GetAddr::PEER)
}
/// Returns information about the process of the peer when the connection was established.
///
/// See documentation of the returned type for details.
pub fn initial_peer_credentials(&self) -> Result<ConnCredentials, io::Error> {
peer_credentials(self.fd)
}
/// Returns the SELinux security context of the process that created the other
/// end of this connection.
///
/// Will return an error on other operating systems than Linux or Android,
/// and also if running inside kubernetes.
/// On success the number of bytes used is returned. (like `Read`)
///
/// The default security context is `unconfined`, without any trailing NUL.
/// A buffor of 50 bytes is probably always big enough.
pub fn initial_peer_selinux_context(&self, buf: &mut[u8]) -> Result<usize, io::Error> {
selinux_context(self.as_raw_fd(), buf)
}
/// Sends a packet to the peer.
pub fn send(&self, packet: &[u8]) -> Result<usize, io::Error> {
let ptr = packet.as_ptr() as *const c_void;
let flags = MSG_NOSIGNAL | MSG_EOR;
let sent = cvt_r!(unsafe { send(self.fd, ptr, packet.len(), flags) })?;
Ok(sent as usize)
}
/// Receives a packet from the peer.
///
/// The returned `bool` indicates whether the packet was truncated due to
/// too short buffer.
pub fn recv(&self, buffer: &mut[u8]) -> Result<(usize, bool), io::Error> {
let mut buffers = [IoSliceMut::new(buffer)];
let (bytes, ancillary) = recv_ancillary(self.fd, None, 0, &mut buffers, &mut[])?;
Ok((bytes, ancillary.message_truncated()))
}
/// Sends a packet assembled from multiple byte slices.
pub fn send_vectored(&self, slices: &[IoSlice])
-> Result<usize, io::Error> {
// Can't use writev() because we need to pass flags,
// and the flags accepted by pwritev2() aren't the one we need to pass.
send_ancillary(self.as_raw_fd(), None, MSG_EOR, slices, &[], None)
}
/// Reads a packet into multiple buffers.
///
/// The returned `bool` indicates whether the packet was truncated due to
/// too short buffers.
pub fn recv_vectored(&self, buffers: &mut[IoSliceMut])
-> Result<(usize, bool), io::Error> {
recv_ancillary(self.fd, None, 0, buffers, &mut[])
.map(|(bytes, ancillary)| (bytes, ancillary.message_truncated()) )
}
/// Sends a packet with associated file descriptors.
pub fn send_fds(&self, bytes: &[u8], fds: &[RawFd])
-> Result<usize, io::Error> {
send_ancillary(self.fd, None, MSG_EOR, &[IoSlice::new(bytes)], fds, None)
}
/// Receives a packet and associated file descriptors.
pub fn recv_fds(&self, byte_buffer: &mut[u8], fd_buffer: &mut[RawFd])
-> Result<(usize, bool, usize), io::Error> {
recv_fds(self.fd, None, &mut[IoSliceMut::new(byte_buffer)], fd_buffer)
}
/// Receives a packet without removing it from the incoming queue.
///
/// The returned `bool` indicates whether the packet was truncated due to
/// the buffer being too small.
///
/// # Examples
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// # use std::io::ErrorKind::*;
/// let (a, b) = uds::nonblocking::UnixSeqpacketConn::pair().unwrap();
/// let mut buf = [0u8; 10];
/// assert_eq!(b.peek(&mut buf).unwrap_err().kind(), WouldBlock);
/// a.send(b"hello").unwrap();
/// assert_eq!(b.peek(&mut buf).unwrap(), (5, false));
/// assert_eq!(&buf[..5], b"hello");
/// assert_eq!(b.recv(&mut buf).unwrap(), (5, false));
/// assert_eq!(&buf[..5], b"hello");
/// assert_eq!(b.peek(&mut buf).unwrap_err().kind(), WouldBlock);
/// ```
pub fn peek(&self, buffer: &mut[u8]) -> Result<(usize, bool), io::Error> {
let mut buffers = [IoSliceMut::new(buffer)];
recv_ancillary(self.fd, None, MSG_PEEK, &mut buffers, &mut[])
.map(|(bytes, ancillary)| (bytes, ancillary.message_truncated()) )
}
/// Receives a packet without removing it from the incoming queue.
///
/// The returned `bool` indicates whether the packet was truncated due to
/// the combined buffers being too small.
pub fn peek_vectored(&self, buffers: &mut[IoSliceMut])
-> Result<(usize, bool), io::Error> {
recv_ancillary(self.fd, None, MSG_PEEK, buffers, &mut[])
.map(|(bytes, ancillary)| (bytes, ancillary.message_truncated()) )
}
/// Returns the value of the `SO_ERROR` option.
///
/// This might only provide errors generated from nonblocking `connect()`s,
/// which this library doesn't support. It is therefore unlikely to be
/// useful, but is provided for parity with `mio`s `UnixStream`.
///
/// # Examples
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// let (a, _b) = uds::nonblocking::UnixSeqpacketConn::pair().unwrap();
///
/// assert!(a.recv(&mut[0u8; 1024]).is_err());
/// assert!(a.take_error().unwrap().is_none());
/// ```
pub fn take_error(&self) -> Result<Option<io::Error>, io::Error> {
take_error(self.fd)
}
/// Creates a new file descriptor also pointing to this side of this connection.
///
/// # Examples
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// # use uds::nonblocking::UnixSeqpacketConn;
/// # use std::io::ErrorKind;
/// #
/// let (a1, b) = UnixSeqpacketConn::pair().unwrap();
/// b.send(b"first come first serve").unwrap();
/// let a2 = a1.try_clone().unwrap();
/// a2.recv(&mut[0u8; 10]).unwrap();
/// assert_eq!(a1.recv(&mut[0u8; 10]).unwrap_err().kind(), ErrorKind::WouldBlock);
///
/// b.send(b"more").unwrap();
/// a1.recv(&mut[0u8; 10]).unwrap();
/// assert_eq!(a2.recv(&mut[0u8; 10]).unwrap_err().kind(), ErrorKind::WouldBlock);
/// ```
pub fn try_clone(&self) -> Result<Self, io::Error> {
let cloned = Socket::try_clone_from(self.fd)?;
// nonblockingness is shared and therefore inherited
Ok(NonblockingUnixSeqpacketConn { fd: cloned.into_raw_fd() })
}
/// Shuts down the read, write, or both halves of this connection.
pub fn shutdown(&self, how: Shutdown) -> io::Result<()> {
let how = match how {
Shutdown::Read => libc::SHUT_RD,
Shutdown::Write => libc::SHUT_WR,
Shutdown::Both => libc::SHUT_RDWR,
};
unsafe { cvt!(libc::shutdown(self.as_raw_fd(), how)) }?;
Ok(())
}
}
/// A non-blocking unix domain listener for sequential-packet connections.
///
/// Differs from [`UnixSeqpacketListener`](../struct.UnixSeqpacketListener.html)
/// in that [`accept()`](struct.NonblockingUnixSeqpacketListener.html#method.accept)
/// returns non-blocking [connection sockets](struct.NonblockingUnixSeqpacketConn.html)
/// and doesn't block if no client `connect()`ions are pending.
///
/// This type can be used with mio if the `mio` feature is enabled:
///
/// ```toml
/// uds = { version = "x.y", features=["mio"] }
/// ```
///
/// # Examples
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// use uds::nonblocking::{UnixSeqpacketListener, UnixSeqpacketConn};
/// use std::io::ErrorKind;
///
/// # let _ = std::fs::remove_file("nonblocking_seqpacket_listener.socket");
/// let listener = UnixSeqpacketListener::bind("nonblocking_seqpacket_listener.socket")
/// .expect("Cannot create nonblocking seqpacket listener");
///
/// // doesn't block if no connections are waiting:
/// assert_eq!(listener.accept_unix_addr().unwrap_err().kind(), ErrorKind::WouldBlock);
///
/// // returned connections are nonblocking:
/// let _client = UnixSeqpacketConn::connect("nonblocking_seqpacket_listener.socket").unwrap();
/// let (conn, _addr) = listener.accept_unix_addr().unwrap();
/// assert_eq!(conn.recv(&mut[0u8; 20]).unwrap_err().kind(), ErrorKind::WouldBlock);
/// #
/// # std::fs::remove_file("nonblocking_seqpacket_listener.socket").unwrap();
/// ```
///
/// Registering with mio (v0.7):
///
#[cfg_attr(all(feature="mio_07", not(target_vendor="apple")), doc="```")]
#[cfg_attr(all(feature="mio_07", target_vendor="apple"), doc="```no_run")]
#[cfg_attr(not(feature="mio_07"), doc="```no_compile")]
/// use uds::nonblocking::{UnixSeqpacketListener, UnixSeqpacketConn};
/// use mio_07::{Poll, Events, Token, Interest};
/// use std::io::ErrorKind;
///
/// # let _ = std::fs::remove_file("seqpacket.sock");
/// let listener = UnixSeqpacketListener::bind("seqpacket.sock")
/// .expect("create nonblocking seqpacket listener");
///
/// let mut poll = Poll::new().expect("create mio poll");
/// let mut events = Events::with_capacity(10);
/// poll.registry()
/// .register(&mut &listener, Token(0), Interest::READABLE)
/// .expect("register unix seqpacket listener with mio");
///
/// let _conn = UnixSeqpacketConn::connect("seqpacket.sock")
/// .expect("create nonblocking seqpacket socket and connect to listener");
///
/// poll.poll(&mut events, None).expect("receive mio notifications");
/// let current_events = events.iter().collect::<Vec<_>>();
/// assert!(current_events.len() > 0);
/// assert_eq!(current_events[0].token(), Token(0));
/// let (_, _addr) = listener.accept_unix_addr().expect("accept connection");
/// ```
#[derive(Debug)]
#[repr(transparent)]
pub struct NonblockingUnixSeqpacketListener {
fd: RawFd
}
impl_rawfd_traits!{NonblockingUnixSeqpacketListener}
impl_mio_if_enabled!{NonblockingUnixSeqpacketListener}
impl NonblockingUnixSeqpacketListener {
/// Creates a socket that listens for seqpacket connections on the specified socket file.
pub fn bind<P: AsRef<Path>>(path: P) -> Result<Self, io::Error> {
let addr = UnixSocketAddr::from_path(&path)?;
Self::bind_unix_addr(&addr)
}
/// Creates a socket that listens for seqpacket connections on the specified address.
pub fn bind_unix_addr(addr: &UnixSocketAddr) -> Result<Self, io::Error> {
let socket = Socket::new(SOCK_SEQPACKET, true)?;
set_unix_addr(socket.as_raw_fd(), SetAddr::LOCAL, addr)?;
socket.start_listening()?;
Ok(NonblockingUnixSeqpacketListener { fd: socket.into_raw_fd() })
}
/// Returns the address this listener was bound to.
pub fn local_unix_addr(&self) -> Result<UnixSocketAddr, io::Error> {
get_unix_addr(self.fd, GetAddr::LOCAL)
}
/// Accepts a non-blocking connection, non-blockingly.
///
/// # Examples
///
/// Doesn't block if no connections are waiting:
///
#[cfg_attr(not(target_vendor="apple"), doc="```")]
#[cfg_attr(target_vendor="apple", doc="```no_run")]
/// # use uds::nonblocking::UnixSeqpacketListener;
/// # use std::io::ErrorKind;
/// #
/// let _ = std::fs::remove_file("nonblocking_seqpacket_listener.socket");
/// let listener = UnixSeqpacketListener::bind("nonblocking_seqpacket_listener.socket")
/// .expect("Cannot create nonblocking seqpacket listener");
/// assert_eq!(listener.accept_unix_addr().unwrap_err().kind(), ErrorKind::WouldBlock);
/// std::fs::remove_file("nonblocking_seqpacket_listener.socket").unwrap();
/// ```
pub fn accept_unix_addr(&self)
-> Result<(NonblockingUnixSeqpacketConn, UnixSocketAddr), io::Error> {
let (socket, addr) = Socket::accept_from(self.fd, true)?;
let conn = NonblockingUnixSeqpacketConn { fd: socket.into_raw_fd() };
Ok((conn, addr))
}
/// Returns the value of the `SO_ERROR` option.
///
/// This might never produce any errors for listeners. It is therefore
/// unlikely to be useful, but is provided for parity with `mio`s
/// `UnixListener`.
///
/// # Examples
///
#[cfg_attr(any(target_os="linux", target_os="android"), doc="```")]
#[cfg_attr(not(any(target_os="linux", target_os="android")), doc="```no_run")]
/// let listener = uds::nonblocking::UnixSeqpacketListener::bind_unix_addr(
/// &uds::UnixSocketAddr::new("@nonblocking_take_error").unwrap()
/// ).unwrap();
///
/// assert!(listener.accept_unix_addr().is_err());
/// assert!(listener.take_error().unwrap().is_none());
/// ```
pub fn take_error(&self) -> Result<Option<io::Error>, io::Error> {
take_error(self.fd)
}
/// Creates a new file descriptor listening for the same connections.
pub fn try_clone(&self) -> Result<Self, io::Error> {
let cloned = Socket::try_clone_from(self.fd)?;
// nonblockingness is shared and therefore inherited
Ok(NonblockingUnixSeqpacketListener { fd: cloned.into_raw_fd() })
}
}