| // Licensed to the Apache Software Foundation (ASF) under one |
| // or more contributor license agreements. See the NOTICE file |
| // distributed with this work for additional information |
| // regarding copyright ownership. The ASF licenses this file |
| // to you under the Apache License, Version 2.0 (the |
| // "License"); you may not use this file except in compliance |
| // with the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, |
| // software distributed under the License is distributed on an |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| // KIND, either express or implied. See the License for the |
| // specific language governing permissions and limitations |
| // under the License.. |
| |
| use sgx_trts::libc::c_int; |
| use core::fmt; |
| use crate::io::{self, Error, ErrorKind}; |
| use crate::net::{Ipv4Addr, Ipv6Addr, SocketAddr, ToSocketAddrs}; |
| use crate::sys_common::net as net_imp; |
| use crate::sys_common::{AsInner, FromInner, IntoInner}; |
| use crate::time::Duration; |
| |
| /// A UDP socket. |
| /// |
| /// After creating a `UdpSocket` by [`bind`]ing it to a socket address, data can be |
| /// [sent to] and [received from] any other socket address. |
| /// |
| /// Although UDP is a connectionless protocol, this implementation provides an interface |
| /// to set an address where data should be sent and received from. After setting a remote |
| /// address with [`connect`], data can be sent to and received from that address with |
| /// [`send`] and [`recv`]. |
| /// |
| /// As stated in the User Datagram Protocol's specification in [IETF RFC 768], UDP is |
| /// an unordered, unreliable protocol; refer to [`TcpListener`] and [`TcpStream`] for TCP |
| /// primitives. |
| /// |
| /// [`bind`]: #method.bind |
| /// [`connect`]: #method.connect |
| /// [IETF RFC 768]: https://tools.ietf.org/html/rfc768 |
| /// [`recv`]: #method.recv |
| /// [received from]: #method.recv_from |
| /// [`send`]: #method.send |
| /// [sent to]: #method.send_to |
| /// [`TcpListener`]: ../../std/net/struct.TcpListener.html |
| /// [`TcpStream`]: ../../std/net/struct.TcpStream.html |
| /// |
| pub struct UdpSocket(net_imp::UdpSocket); |
| |
| impl UdpSocket { |
| pub fn new(sockfd: c_int) -> io::Result<UdpSocket> { |
| net_imp::UdpSocket::new(sockfd).map(UdpSocket) |
| } |
| |
| pub fn new_v4() -> io::Result<UdpSocket> { |
| net_imp::UdpSocket::new_v4().map(UdpSocket) |
| } |
| |
| pub fn new_v6() -> io::Result<UdpSocket> { |
| net_imp::UdpSocket::new_v6().map(UdpSocket) |
| } |
| |
| pub fn raw(&self) -> c_int { |
| self.0.raw() |
| } |
| |
| pub fn into_raw(self) -> c_int { |
| self.0.into_raw() |
| } |
| |
| /// Creates a UDP socket from the given address. |
| /// |
| /// The address type can be any implementor of [`ToSocketAddrs`] trait. See |
| /// its documentation for concrete examples. |
| /// |
| /// If `addr` yields multiple addresses, `bind` will be attempted with |
| /// each of the addresses until one succeeds and returns the socket. If none |
| /// of the addresses succeed in creating a socket, the error returned from |
| /// the last attempt (the last address) is returned. |
| /// |
| /// [`ToSocketAddrs`]: ../../std/net/trait.ToSocketAddrs.html |
| /// |
| pub fn bind<A: ToSocketAddrs>(addr: A) -> io::Result<UdpSocket> { |
| super::each_addr(addr, net_imp::UdpSocket::bind).map(UdpSocket) |
| } |
| |
| /// Bound this UDP socket to a the specified address. |
| pub fn bind_socket<A: ToSocketAddrs>(&self, addr: A) -> io::Result<()> { |
| super::each_addr(addr, |addr| self.0.bind_socket(addr)) |
| } |
| |
| /// Receives a single datagram message on the socket. On success, returns the number |
| /// of bytes read and the origin. |
| /// |
| /// The function must be called with valid byte array `buf` of sufficient size to |
| /// hold the message bytes. If a message is too long to fit in the supplied buffer, |
| /// excess bytes may be discarded. |
| /// |
| pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { |
| self.0.recv_from(buf) |
| } |
| |
| /// Receives a single datagram message on the socket, without removing it from the |
| /// queue. On success, returns the number of bytes read and the origin. |
| /// |
| /// The function must be called with valid byte array `buf` of sufficient size to |
| /// hold the message bytes. If a message is too long to fit in the supplied buffer, |
| /// excess bytes may be discarded. |
| /// |
| /// Successive calls return the same data. This is accomplished by passing |
| /// `MSG_PEEK` as a flag to the underlying `recvfrom` system call. |
| /// |
| /// Do not use this function to implement busy waiting, instead use `libc::poll` to |
| /// synchronize IO events on one or more sockets. |
| /// |
| pub fn peek_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { |
| self.0.peek_from(buf) |
| } |
| |
| /// Sends data on the socket to the given address. On success, returns the |
| /// number of bytes written. |
| /// |
| /// Address type can be any implementor of [`ToSocketAddrs`] trait. See its |
| /// documentation for concrete examples. |
| /// |
| /// It is possible for `addr` to yield multiple addresses, but `send_to` |
| /// will only send data to the first address yielded by `addr`. |
| /// |
| /// This will return an error when the IP version of the local socket |
| /// does not match that returned from [`ToSocketAddrs`]. |
| /// |
| /// See issue #34202 for more details. |
| /// |
| /// [`ToSocketAddrs`]: ../../std/net/trait.ToSocketAddrs.html |
| /// |
| pub fn send_to<A: ToSocketAddrs>(&self, buf: &[u8], addr: A) -> io::Result<usize> { |
| match addr.to_socket_addrs()?.next() { |
| Some(addr) => self.0.send_to(buf, &addr), |
| None => Err(Error::new(ErrorKind::InvalidInput, "no addresses to send data to")), |
| } |
| } |
| |
| /// Returns the socket address of the remote peer this socket was connected to. |
| /// |
| pub fn peer_addr(&self) -> io::Result<SocketAddr> { |
| self.0.peer_addr() |
| } |
| |
| /// Returns the socket address that this socket was created from. |
| /// |
| pub fn local_addr(&self) -> io::Result<SocketAddr> { |
| self.0.socket_addr() |
| } |
| |
| /// Creates a new independently owned handle to the underlying socket. |
| /// |
| /// The returned `UdpSocket` is a reference to the same socket that this |
| /// object references. Both handles will read and write the same port, and |
| /// options set on one socket will be propagated to the other. |
| /// |
| pub fn try_clone(&self) -> io::Result<UdpSocket> { |
| self.0.duplicate().map(UdpSocket) |
| } |
| |
| /// Sets the read timeout to the timeout specified. |
| /// |
| /// If the value specified is [`None`], then [`read`] calls will block |
| /// indefinitely. An [`Err`] is returned if the zero [`Duration`] is |
| /// passed to this method. |
| /// |
| /// # Platform-specific behavior |
| /// |
| /// Platforms may return a different error code whenever a read times out as |
| /// a result of setting this option. For example Unix typically returns an |
| /// error of the kind [`WouldBlock`], but Windows may return [`TimedOut`]. |
| /// |
| /// [`None`]: ../../std/option/enum.Option.html#variant.None |
| /// [`Err`]: ../../std/result/enum.Result.html#variant.Err |
| /// [`read`]: ../../std/io/trait.Read.html#tymethod.read |
| /// [`Duration`]: ../../std/time/struct.Duration.html |
| /// [`WouldBlock`]: ../../std/io/enum.ErrorKind.html#variant.WouldBlock |
| /// [`TimedOut`]: ../../std/io/enum.ErrorKind.html#variant.TimedOut |
| /// |
| pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> { |
| self.0.set_read_timeout(dur) |
| } |
| |
| /// Sets the write timeout to the timeout specified. |
| /// |
| /// If the value specified is [`None`], then [`write`] calls will block |
| /// indefinitely. An [`Err`] is returned if the zero [`Duration`] is |
| /// passed to this method. |
| /// |
| /// # Platform-specific behavior |
| /// |
| /// Platforms may return a different error code whenever a write times out |
| /// as a result of setting this option. For example Unix typically returns |
| /// an error of the kind [`WouldBlock`], but Windows may return [`TimedOut`]. |
| /// |
| /// [`None`]: ../../std/option/enum.Option.html#variant.None |
| /// [`Err`]: ../../std/result/enum.Result.html#variant.Err |
| /// [`write`]: ../../std/io/trait.Write.html#tymethod.write |
| /// [`Duration`]: ../../std/time/struct.Duration.html |
| /// [`WouldBlock`]: ../../std/io/enum.ErrorKind.html#variant.WouldBlock |
| /// [`TimedOut`]: ../../std/io/enum.ErrorKind.html#variant.TimedOut |
| /// |
| pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> { |
| self.0.set_write_timeout(dur) |
| } |
| |
| /// Returns the read timeout of this socket. |
| /// |
| /// If the timeout is [`None`], then [`read`] calls will block indefinitely. |
| /// |
| /// [`None`]: ../../std/option/enum.Option.html#variant.None |
| /// [`read`]: ../../std/io/trait.Read.html#tymethod.read |
| /// |
| pub fn read_timeout(&self) -> io::Result<Option<Duration>> { |
| self.0.read_timeout() |
| } |
| |
| /// Returns the write timeout of this socket. |
| /// |
| /// If the timeout is [`None`], then [`write`] calls will block indefinitely. |
| /// |
| /// [`None`]: ../../std/option/enum.Option.html#variant.None |
| /// [`write`]: ../../std/io/trait.Write.html#tymethod.write |
| /// |
| pub fn write_timeout(&self) -> io::Result<Option<Duration>> { |
| self.0.write_timeout() |
| } |
| |
| /// Sets the value of the `SO_BROADCAST` option for this socket. |
| /// |
| /// When enabled, this socket is allowed to send packets to a broadcast |
| /// address. |
| /// |
| pub fn set_broadcast(&self, broadcast: bool) -> io::Result<()> { |
| self.0.set_broadcast(broadcast) |
| } |
| |
| /// Gets the value of the `SO_BROADCAST` option for this socket. |
| /// |
| /// For more information about this option, see |
| /// [`set_broadcast`][link]. |
| /// |
| /// [link]: #method.set_broadcast |
| /// |
| pub fn broadcast(&self) -> io::Result<bool> { |
| self.0.broadcast() |
| } |
| |
| /// Sets the value of the `IP_MULTICAST_LOOP` option for this socket. |
| /// |
| /// If enabled, multicast packets will be looped back to the local socket. |
| /// Note that this may not have any effect on IPv6 sockets. |
| /// |
| pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> io::Result<()> { |
| self.0.set_multicast_loop_v4(multicast_loop_v4) |
| } |
| |
| /// Gets the value of the `IP_MULTICAST_LOOP` option for this socket. |
| /// |
| /// For more information about this option, see |
| /// [`set_multicast_loop_v4`][link]. |
| /// |
| /// [link]: #method.set_multicast_loop_v4 |
| /// |
| pub fn multicast_loop_v4(&self) -> io::Result<bool> { |
| self.0.multicast_loop_v4() |
| } |
| |
| /// Sets the value of the `IP_MULTICAST_TTL` option for this socket. |
| /// |
| /// Indicates the time-to-live value of outgoing multicast packets for |
| /// this socket. The default value is 1 which means that multicast packets |
| /// don't leave the local network unless explicitly requested. |
| /// |
| /// Note that this may not have any effect on IPv6 sockets. |
| /// |
| pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> io::Result<()> { |
| self.0.set_multicast_ttl_v4(multicast_ttl_v4) |
| } |
| |
| /// Gets the value of the `IP_MULTICAST_TTL` option for this socket. |
| /// |
| /// For more information about this option, see |
| /// [`set_multicast_ttl_v4`][link]. |
| /// |
| /// [link]: #method.set_multicast_ttl_v4 |
| /// |
| pub fn multicast_ttl_v4(&self) -> io::Result<u32> { |
| self.0.multicast_ttl_v4() |
| } |
| |
| /// Sets the value of the `IPV6_MULTICAST_LOOP` option for this socket. |
| /// |
| /// Controls whether this socket sees the multicast packets it sends itself. |
| /// Note that this may not have any affect on IPv4 sockets. |
| /// |
| pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> io::Result<()> { |
| self.0.set_multicast_loop_v6(multicast_loop_v6) |
| } |
| |
| /// Gets the value of the `IPV6_MULTICAST_LOOP` option for this socket. |
| /// |
| /// For more information about this option, see |
| /// [`set_multicast_loop_v6`][link]. |
| /// |
| /// [link]: #method.set_multicast_loop_v6 |
| /// |
| pub fn multicast_loop_v6(&self) -> io::Result<bool> { |
| self.0.multicast_loop_v6() |
| } |
| |
| /// Sets the value for the `IP_TTL` option on this socket. |
| /// |
| /// This value sets the time-to-live field that is used in every packet sent |
| /// from this socket. |
| /// |
| pub fn set_ttl(&self, ttl: u32) -> io::Result<()> { |
| self.0.set_ttl(ttl) |
| } |
| |
| /// Gets the value of the `IP_TTL` option for this socket. |
| /// |
| /// For more information about this option, see [`set_ttl`][link]. |
| /// |
| /// [link]: #method.set_ttl |
| /// |
| pub fn ttl(&self) -> io::Result<u32> { |
| self.0.ttl() |
| } |
| |
| /// Executes an operation of the `IP_ADD_MEMBERSHIP` type. |
| /// |
| /// This function specifies a new multicast group for this socket to join. |
| /// The address must be a valid multicast address, and `interface` is the |
| /// address of the local interface with which the system should join the |
| /// multicast group. If it's equal to `INADDR_ANY` then an appropriate |
| /// interface is chosen by the system. |
| pub fn join_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr) -> io::Result<()> { |
| self.0.join_multicast_v4(multiaddr, interface) |
| } |
| |
| /// Executes an operation of the `IPV6_ADD_MEMBERSHIP` type. |
| /// |
| /// This function specifies a new multicast group for this socket to join. |
| /// The address must be a valid multicast address, and `interface` is the |
| /// index of the interface to join/leave (or 0 to indicate any interface). |
| pub fn join_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32) -> io::Result<()> { |
| self.0.join_multicast_v6(multiaddr, interface) |
| } |
| |
| /// Executes an operation of the `IP_DROP_MEMBERSHIP` type. |
| /// |
| /// For more information about this option, see |
| /// [`join_multicast_v4`][link]. |
| /// |
| /// [link]: #method.join_multicast_v4 |
| pub fn leave_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr) -> io::Result<()> { |
| self.0.leave_multicast_v4(multiaddr, interface) |
| } |
| |
| /// Executes an operation of the `IPV6_DROP_MEMBERSHIP` type. |
| /// |
| /// For more information about this option, see |
| /// [`join_multicast_v6`][link]. |
| /// |
| /// [link]: #method.join_multicast_v6 |
| pub fn leave_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32) -> io::Result<()> { |
| self.0.leave_multicast_v6(multiaddr, interface) |
| } |
| |
| /// Gets the value of the `SO_ERROR` option on this socket. |
| /// |
| /// This will retrieve the stored error in the underlying socket, clearing |
| /// the field in the process. This can be useful for checking errors between |
| /// calls. |
| /// |
| pub fn take_error(&self) -> io::Result<Option<io::Error>> { |
| self.0.take_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. |
| /// |
| /// If `addr` yields multiple addresses, `connect` will be attempted with |
| /// each of the addresses until the underlying OS function returns no |
| /// error. Note that usually, a successful `connect` call does not specify |
| /// that there is a remote server listening on the port, rather, such an |
| /// error would only be detected after the first send. If the OS returns an |
| /// error for each of the specified addresses, the error returned from the |
| /// last connection attempt (the last address) is returned. |
| /// |
| pub fn connect<A: ToSocketAddrs>(&self, addr: A) -> io::Result<()> { |
| super::each_addr(addr, |addr| self.0.connect(addr)) |
| } |
| |
| /// 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. |
| /// |
| /// [`connect`]: #method.connect |
| /// |
| pub fn send(&self, buf: &[u8]) -> io::Result<usize> { |
| self.0.send(buf) |
| } |
| |
| /// Receives a single datagram message on the socket from the remote address to |
| /// which it is connected. On success, returns the number of bytes read. |
| /// |
| /// The function must be called with valid byte array `buf` of sufficient size to |
| /// hold the message bytes. If a message is too long to fit in the supplied buffer, |
| /// excess bytes may be discarded. |
| /// |
| /// The [`connect`] method will connect this socket to a remote address. This |
| /// method will fail if the socket is not connected. |
| /// |
| /// [`connect`]: #method.connect |
| /// |
| pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> { |
| self.0.recv(buf) |
| } |
| |
| /// Receives single datagram on the socket from the remote address to which it is |
| /// connected, without removing the message from input queue. On success, returns |
| /// the number of bytes peeked. |
| /// |
| /// The function must be called with valid byte array `buf` of sufficient size to |
| /// hold the message bytes. If a message is too long to fit in the supplied buffer, |
| /// excess bytes may be discarded. |
| /// |
| /// Successive calls return the same data. This is accomplished by passing |
| /// `MSG_PEEK` as a flag to the underlying `recv` system call. |
| /// |
| /// Do not use this function to implement busy waiting, instead use `libc::poll` to |
| /// synchronize IO events on one or more sockets. |
| /// |
| /// The [`connect`] method will connect this socket to a remote address. This |
| /// method will fail if the socket is not connected. |
| /// |
| /// [`connect`]: #method.connect |
| /// |
| /// # Errors |
| /// |
| /// This method will fail if the socket is not connected. The `connect` method |
| /// will connect this socket to a remote address. |
| /// |
| pub fn peek(&self, buf: &mut [u8]) -> io::Result<usize> { |
| self.0.peek(buf) |
| } |
| |
| /// Moves this UDP socket into or out of nonblocking mode. |
| /// |
| /// This will result in `recv`, `recv_from`, `send`, and `send_to` |
| /// operations becoming nonblocking, i.e., immediately returning from their |
| /// calls. If the IO operation is successful, `Ok` is returned and no |
| /// further action is required. If the IO operation could not be completed |
| /// and needs to be retried, an error with kind |
| /// [`io::ErrorKind::WouldBlock`] is returned. |
| /// |
| /// On Unix platforms, calling this method corresponds to calling `fcntl` |
| /// `FIONBIO`. On Windows calling this method corresponds to calling |
| /// `ioctlsocket` `FIONBIO`. |
| /// |
| pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> { |
| self.0.set_nonblocking(nonblocking) |
| } |
| } |
| |
| impl AsInner<net_imp::UdpSocket> for UdpSocket { |
| fn as_inner(&self) -> &net_imp::UdpSocket { |
| &self.0 |
| } |
| } |
| |
| impl FromInner<net_imp::UdpSocket> for UdpSocket { |
| fn from_inner(inner: net_imp::UdpSocket) -> UdpSocket { |
| UdpSocket(inner) |
| } |
| } |
| |
| impl IntoInner<net_imp::UdpSocket> for UdpSocket { |
| fn into_inner(self) -> net_imp::UdpSocket { |
| self.0 |
| } |
| } |
| |
| impl fmt::Debug for UdpSocket { |
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |
| self.0.fmt(f) |
| } |
| } |