use crate::fd::OwnedFd; use crate::net::{SocketAddr, SocketAddrAny, SocketAddrV4, SocketAddrV6}; use crate::{backend, io}; use backend::fd::{AsFd, BorrowedFd}; pub use crate::net::{AddressFamily, Protocol, Shutdown, SocketFlags, SocketType}; #[cfg(unix)] pub use backend::net::addr::SocketAddrUnix; /// `socket(domain, type_, protocol)`—Creates a socket. /// /// POSIX guarantees that `socket` will use the lowest unused file descriptor, /// however it is not safe in general to rely on this, as file descriptors may /// be unexpectedly allocated on other threads or in libraries. /// /// To pass extra flags such as [`SocketFlags::CLOEXEC`] or /// [`SocketFlags::NONBLOCK`], use [`socket_with`]. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#socket /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html /// [Linux]: https://man7.org/linux/man-pages/man2/socket.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/socket.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-socket /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2 /// [NetBSD]: https://man.netbsd.org/socket.2 /// [OpenBSD]: https://man.openbsd.org/socket.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=socket§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/socket /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Creating-a-Socket.html #[inline] pub fn socket( domain: AddressFamily, type_: SocketType, protocol: Option, ) -> io::Result { backend::net::syscalls::socket(domain, type_, protocol) } /// `socket_with(domain, type_ | flags, protocol)`—Creates a socket, with /// flags. /// /// POSIX guarantees that `socket` will use the lowest unused file descriptor, /// however it is not safe in general to rely on this, as file descriptors may /// be unexpectedly allocated on other threads or in libraries. /// /// `socket_with` is the same as [`socket`] but adds an additional flags /// operand. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#socket /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html /// [Linux]: https://man7.org/linux/man-pages/man2/socket.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/socket.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-socket /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=socket&sektion=2 /// [NetBSD]: https://man.netbsd.org/socket.2 /// [OpenBSD]: https://man.openbsd.org/socket.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=socket§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/socket /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Creating-a-Socket.html #[doc(alias("socket"))] #[inline] pub fn socket_with( domain: AddressFamily, type_: SocketType, flags: SocketFlags, protocol: Option, ) -> io::Result { backend::net::syscalls::socket_with(domain, type_, flags, protocol) } /// `bind(sockfd, addr)`—Binds a socket to an IP address. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#bind /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html /// [Linux]: https://man7.org/linux/man-pages/man2/bind.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/bind.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-bind /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2 /// [NetBSD]: https://man.netbsd.org/bind.2 /// [OpenBSD]: https://man.openbsd.org/bind.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=bind§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/bind /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Setting-Address.html pub fn bind(sockfd: Fd, addr: &SocketAddr) -> io::Result<()> { _bind(sockfd.as_fd(), addr) } fn _bind(sockfd: BorrowedFd<'_>, addr: &SocketAddr) -> io::Result<()> { match addr { SocketAddr::V4(v4) => backend::net::syscalls::bind_v4(sockfd, v4), SocketAddr::V6(v6) => backend::net::syscalls::bind_v6(sockfd, v6), } } /// `bind(sockfd, addr)`—Binds a socket to an address. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#bind /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html /// [Linux]: https://man7.org/linux/man-pages/man2/bind.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/bind.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-bind /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2 /// [NetBSD]: https://man.netbsd.org/bind.2 /// [OpenBSD]: https://man.openbsd.org/bind.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=bind§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/bind /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Setting-Address.html #[doc(alias = "bind")] pub fn bind_any(sockfd: Fd, addr: &SocketAddrAny) -> io::Result<()> { _bind_any(sockfd.as_fd(), addr) } fn _bind_any(sockfd: BorrowedFd<'_>, addr: &SocketAddrAny) -> io::Result<()> { match addr { SocketAddrAny::V4(v4) => backend::net::syscalls::bind_v4(sockfd, v4), SocketAddrAny::V6(v6) => backend::net::syscalls::bind_v6(sockfd, v6), #[cfg(unix)] SocketAddrAny::Unix(unix) => backend::net::syscalls::bind_unix(sockfd, unix), } } /// `bind(sockfd, addr, sizeof(struct sockaddr_in))`—Binds a socket to an /// IPv4 address. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#bind /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html /// [Linux]: https://man7.org/linux/man-pages/man2/bind.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/bind.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-bind /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2 /// [NetBSD]: https://man.netbsd.org/bind.2 /// [OpenBSD]: https://man.openbsd.org/bind.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=bind§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/bind /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Setting-Address.html #[inline] #[doc(alias = "bind")] pub fn bind_v4(sockfd: Fd, addr: &SocketAddrV4) -> io::Result<()> { backend::net::syscalls::bind_v4(sockfd.as_fd(), addr) } /// `bind(sockfd, addr, sizeof(struct sockaddr_in6))`—Binds a socket to an /// IPv6 address. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#bind /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html /// [Linux]: https://man7.org/linux/man-pages/man2/bind.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/bind.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-bind /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2 /// [NetBSD]: https://man.netbsd.org/bind.2 /// [OpenBSD]: https://man.openbsd.org/bind.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=bind§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/bind /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Setting-Address.html #[inline] #[doc(alias = "bind")] pub fn bind_v6(sockfd: Fd, addr: &SocketAddrV6) -> io::Result<()> { backend::net::syscalls::bind_v6(sockfd.as_fd(), addr) } /// `bind(sockfd, addr, sizeof(struct sockaddr_un))`—Binds a socket to a /// Unix-domain address. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#bind /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html /// [Linux]: https://man7.org/linux/man-pages/man2/bind.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/bind.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-bind /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=bind&sektion=2 /// [NetBSD]: https://man.netbsd.org/bind.2 /// [OpenBSD]: https://man.openbsd.org/bind.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=bind§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/bind /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Setting-Address.html #[cfg(unix)] #[inline] #[doc(alias = "bind")] pub fn bind_unix(sockfd: Fd, addr: &SocketAddrUnix) -> io::Result<()> { backend::net::syscalls::bind_unix(sockfd.as_fd(), addr) } /// `connect(sockfd, addr)`—Initiates a connection to an IP address. /// /// On Windows, a non-blocking socket returns [`Errno::WOULDBLOCK`] if the /// connection cannot be completed immediately, rather than /// `Errno::INPROGRESS`. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#connect /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html /// [Linux]: https://man7.org/linux/man-pages/man2/connect.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/connect.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=connect&sektion=2 /// [NetBSD]: https://man.netbsd.org/connect.2 /// [OpenBSD]: https://man.openbsd.org/connect.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=connect§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/connect /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Connecting.html /// [`Errno::WOULDBLOCK`]: io::Errno::WOULDBLOCK pub fn connect(sockfd: Fd, addr: &SocketAddr) -> io::Result<()> { _connect(sockfd.as_fd(), addr) } fn _connect(sockfd: BorrowedFd<'_>, addr: &SocketAddr) -> io::Result<()> { match addr { SocketAddr::V4(v4) => backend::net::syscalls::connect_v4(sockfd, v4), SocketAddr::V6(v6) => backend::net::syscalls::connect_v6(sockfd, v6), } } /// `connect(sockfd, addr)`—Initiates a connection. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#connect /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html /// [Linux]: https://man7.org/linux/man-pages/man2/connect.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/connect.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=connect&sektion=2 /// [NetBSD]: https://man.netbsd.org/connect.2 /// [OpenBSD]: https://man.openbsd.org/connect.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=connect§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/connect /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Connecting.html #[doc(alias = "connect")] pub fn connect_any(sockfd: Fd, addr: &SocketAddrAny) -> io::Result<()> { _connect_any(sockfd.as_fd(), addr) } fn _connect_any(sockfd: BorrowedFd<'_>, addr: &SocketAddrAny) -> io::Result<()> { match addr { SocketAddrAny::V4(v4) => backend::net::syscalls::connect_v4(sockfd, v4), SocketAddrAny::V6(v6) => backend::net::syscalls::connect_v6(sockfd, v6), #[cfg(unix)] SocketAddrAny::Unix(unix) => backend::net::syscalls::connect_unix(sockfd, unix), } } /// `connect(sockfd, addr, sizeof(struct sockaddr_in))`—Initiates a /// connection to an IPv4 address. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#connect /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html /// [Linux]: https://man7.org/linux/man-pages/man2/connect.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/connect.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=connect&sektion=2 /// [NetBSD]: https://man.netbsd.org/connect.2 /// [OpenBSD]: https://man.openbsd.org/connect.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=connect§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/connect /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Connecting.html #[inline] #[doc(alias = "connect")] pub fn connect_v4(sockfd: Fd, addr: &SocketAddrV4) -> io::Result<()> { backend::net::syscalls::connect_v4(sockfd.as_fd(), addr) } /// `connect(sockfd, addr, sizeof(struct sockaddr_in6))`—Initiates a /// connection to an IPv6 address. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#connect /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html /// [Linux]: https://man7.org/linux/man-pages/man2/connect.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/connect.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=connect&sektion=2 /// [NetBSD]: https://man.netbsd.org/connect.2 /// [OpenBSD]: https://man.openbsd.org/connect.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=connect§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/connect /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Connecting.html #[inline] #[doc(alias = "connect")] pub fn connect_v6(sockfd: Fd, addr: &SocketAddrV6) -> io::Result<()> { backend::net::syscalls::connect_v6(sockfd.as_fd(), addr) } /// `connect(sockfd, addr, sizeof(struct sockaddr_un))`—Initiates a /// connection to a Unix-domain address. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#connect /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html /// [Linux]: https://man7.org/linux/man-pages/man2/connect.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/connect.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=connect&sektion=2 /// [NetBSD]: https://man.netbsd.org/connect.2 /// [OpenBSD]: https://man.openbsd.org/connect.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=connect§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/connect /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Connecting.html #[cfg(unix)] #[inline] #[doc(alias = "connect")] pub fn connect_unix(sockfd: Fd, addr: &SocketAddrUnix) -> io::Result<()> { backend::net::syscalls::connect_unix(sockfd.as_fd(), addr) } /// `connect(sockfd, {.sa_family = AF_UNSPEC}, sizeof(struct sockaddr))` /// — Dissolve the socket's association. /// /// On UDP sockets, BSD platforms report [`Errno::AFNOSUPPORT`] or /// [`Errno::INVAL`] even if the disconnect was successful. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#connect /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html /// [Linux]: https://man7.org/linux/man-pages/man2/connect.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/connect.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-connect /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=connect&sektion=2 /// [NetBSD]: https://man.netbsd.org/connect.2 /// [OpenBSD]: https://man.openbsd.org/connect.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=connect§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/connect /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Connecting.html /// [`Errno::AFNOSUPPORT`]: io::Errno::AFNOSUPPORT /// [`Errno::INVAL`]: io::Errno::INVAL #[inline] #[doc(alias = "connect")] pub fn connect_unspec(sockfd: Fd) -> io::Result<()> { backend::net::syscalls::connect_unspec(sockfd.as_fd()) } /// `listen(fd, backlog)`—Enables listening for incoming connections. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#listen /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/listen.html /// [Linux]: https://man7.org/linux/man-pages/man2/listen.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/listen.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-listen /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=listen&sektion=2 /// [NetBSD]: https://man.netbsd.org/listen.2 /// [OpenBSD]: https://man.openbsd.org/listen.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=listen§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/listen /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Listening.html #[inline] pub fn listen(sockfd: Fd, backlog: i32) -> io::Result<()> { backend::net::syscalls::listen(sockfd.as_fd(), backlog) } /// `accept(fd, NULL, NULL)`—Accepts an incoming connection. /// /// Use [`acceptfrom`] to retrieve the peer address. /// /// POSIX guarantees that `accept` will use the lowest unused file descriptor, /// however it is not safe in general to rely on this, as file descriptors may /// be unexpectedly allocated on other threads or in libraries. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#acceptthank-you-for-calling-port-3490. /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/accept.html /// [Linux]: https://man7.org/linux/man-pages/man2/accept.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/accept.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-accept /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=accept&sektion=2 /// [NetBSD]: https://man.netbsd.org/accept.2 /// [OpenBSD]: https://man.openbsd.org/accept.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=accept§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/accept /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Accepting-Connections.html #[inline] pub fn accept(sockfd: Fd) -> io::Result { backend::net::syscalls::accept(sockfd.as_fd()) } /// `accept4(fd, NULL, NULL, flags)`—Accepts an incoming connection, with /// flags. /// /// Use [`acceptfrom_with`] to retrieve the peer address. /// /// Even though POSIX guarantees that this will use the lowest unused file /// descriptor, it is not safe in general to rely on this, as file descriptors /// may be unexpectedly allocated on other threads or in libraries. /// /// `accept_with` is the same as [`accept`] but adds an additional flags /// operand. /// /// # References /// - [Linux] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// /// [Linux]: https://man7.org/linux/man-pages/man2/accept4.2.html /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=accept4&sektion=2 /// [NetBSD]: https://man.netbsd.org/accept4.2 /// [OpenBSD]: https://man.openbsd.org/accept4.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=accept4§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/accept4 #[inline] #[doc(alias = "accept4")] pub fn accept_with(sockfd: Fd, flags: SocketFlags) -> io::Result { backend::net::syscalls::accept_with(sockfd.as_fd(), flags) } /// `accept(fd, &addr, &len)`—Accepts an incoming connection and returns the /// peer address. /// /// Use [`accept`] if the peer address isn't needed. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#acceptthank-you-for-calling-port-3490. /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/accept.html /// [Linux]: https://man7.org/linux/man-pages/man2/accept.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/accept.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-accept /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=accept&sektion=2 /// [NetBSD]: https://man.netbsd.org/accept.2 /// [OpenBSD]: https://man.openbsd.org/accept.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=accept§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/accept /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Accepting-Connections.html #[inline] #[doc(alias = "accept")] pub fn acceptfrom(sockfd: Fd) -> io::Result<(OwnedFd, Option)> { backend::net::syscalls::acceptfrom(sockfd.as_fd()) } /// `accept4(fd, &addr, &len, flags)`—Accepts an incoming connection and /// returns the peer address, with flags. /// /// Use [`accept_with`] if the peer address isn't needed. /// /// `acceptfrom_with` is the same as [`acceptfrom`] but adds an additional /// flags operand. /// /// # References /// - [Linux] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// /// [Linux]: https://man7.org/linux/man-pages/man2/accept4.2.html /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=accept4&sektion=2 /// [NetBSD]: https://man.netbsd.org/accept4.2 /// [OpenBSD]: https://man.openbsd.org/accept4.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=accept4§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/accept4 #[inline] #[doc(alias = "accept4")] pub fn acceptfrom_with( sockfd: Fd, flags: SocketFlags, ) -> io::Result<(OwnedFd, Option)> { backend::net::syscalls::acceptfrom_with(sockfd.as_fd(), flags) } /// `shutdown(fd, how)`—Closes the read and/or write sides of a stream. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#close-and-shutdownget-outta-my-face /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/shutdown.html /// [Linux]: https://man7.org/linux/man-pages/man2/shutdown.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/shutdown.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-shutdown /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=shutdown&sektion=2 /// [NetBSD]: https://man.netbsd.org/shutdown.2 /// [OpenBSD]: https://man.openbsd.org/shutdown.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=shutdown§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/shutdown /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Closing-a-Socket.html #[inline] pub fn shutdown(sockfd: Fd, how: Shutdown) -> io::Result<()> { backend::net::syscalls::shutdown(sockfd.as_fd(), how) } /// `getsockname(fd, addr, len)`—Returns the address a socket is bound to. /// /// # References /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html /// [Linux]: https://man7.org/linux/man-pages/man2/getsockname.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/getsockname.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-getsockname /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=getsockname&sektion=2 /// [NetBSD]: https://man.netbsd.org/getsockname.2 /// [OpenBSD]: https://man.openbsd.org/getsockname.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=getsockname§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/getsockname /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Reading-Address.html #[inline] pub fn getsockname(sockfd: Fd) -> io::Result { backend::net::syscalls::getsockname(sockfd.as_fd()) } /// `getpeername(fd, addr, len)`—Returns the address a socket is connected /// to. /// /// # References /// - [Beej's Guide to Network Programming] /// - [POSIX] /// - [Linux] /// - [Apple] /// - [Winsock] /// - [FreeBSD] /// - [NetBSD] /// - [OpenBSD] /// - [DragonFly BSD] /// - [illumos] /// - [glibc] /// /// [Beej's Guide to Network Programming]: https://beej.us/guide/bgnet/html/split/system-calls-or-bust.html#getpeernamewho-are-you /// [POSIX]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html /// [Linux]: https://man7.org/linux/man-pages/man2/getpeername.2.html /// [Apple]: https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/getpeername.2.html /// [Winsock]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-getpeername /// [FreeBSD]: https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2 /// [NetBSD]: https://man.netbsd.org/getpeername.2 /// [OpenBSD]: https://man.openbsd.org/getpeername.2 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=getpeername§ion=2 /// [illumos]: https://illumos.org/man/3SOCKET/getpeername /// [glibc]: https://www.gnu.org/software/libc/manual/html_node/Who-is-Connected.html #[inline] pub fn getpeername(sockfd: Fd) -> io::Result> { backend::net::syscalls::getpeername(sockfd.as_fd()) }