EIC code displayed by LXR master/​include/​boost/​asio/​ip/​network_v4.hpp	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 09:29:00

 //
 // ip/network_v4.hpp
 // ~~~~~~~~~~~~~~~~~
 //
 // Copyright (c) 2003-2023 Christopher M. Kohlhoff (chris at kohlhoff dot com)
 // Copyright (c) 2014 Oliver Kowalke (oliver dot kowalke at gmail dot com)
 //
 // Distributed under the Boost Software License, Version 1.0. (See accompanying
 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 //
 
 #ifndef BOOST_ASIO_IP_NETWORK_V4_HPP
 #define BOOST_ASIO_IP_NETWORK_V4_HPP
 
 #if defined(_MSC_VER) && (_MSC_VER >= 1200)
 # pragma once
 #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
 
 #include <boost/asio/detail/config.hpp>
 #include <string>
 #include <boost/asio/detail/string_view.hpp>
 #include <boost/system/error_code.hpp>
 #include <boost/asio/ip/address_v4_range.hpp>
 
 #include <boost/asio/detail/push_options.hpp>
 
 namespace boost {
 namespace asio {
 namespace ip {
 
 /// Represents an IPv4 network.
 /**
  * The boost::asio::ip::network_v4 class provides the ability to use and
  * manipulate IP version 4 networks.
  *
  * @par Thread Safety
  * @e Distinct @e objects: Safe.@n
  * @e Shared @e objects: Unsafe.
  */
 class network_v4
 {
 public:
   /// Default constructor.
   network_v4() noexcept
     : address_(),
       prefix_length_(0)
   {
   }
 
   /// Construct a network based on the specified address and prefix length.
   BOOST_ASIO_DECL network_v4(const address_v4& addr,
       unsigned short prefix_len);
 
   /// Construct network based on the specified address and netmask.
   BOOST_ASIO_DECL network_v4(const address_v4& addr,
       const address_v4& mask);
 
   /// Copy constructor.
   network_v4(const network_v4& other) noexcept
     : address_(other.address_),
       prefix_length_(other.prefix_length_)
   {
   }
 
   /// Move constructor.
   network_v4(network_v4&& other) noexcept
     : address_(static_cast<address_v4&&>(other.address_)),
       prefix_length_(other.prefix_length_)
   {
   }
 
   /// Assign from another network.
   network_v4& operator=(const network_v4& other) noexcept
   {
     address_ = other.address_;
     prefix_length_ = other.prefix_length_;
     return *this;
   }
 
   /// Move-assign from another network.
   network_v4& operator=(network_v4&& other) noexcept
   {
     address_ = static_cast<address_v4&&>(other.address_);
     prefix_length_ = other.prefix_length_;
     return *this;
   }
 
   /// Obtain the address object specified when the network object was created.
   address_v4 address() const noexcept
   {
     return address_;
   }
 
   /// Obtain the prefix length that was specified when the network object was
   /// created.
   unsigned short prefix_length() const noexcept
   {
     return prefix_length_;
   }
 
   /// Obtain the netmask that was specified when the network object was created.
   BOOST_ASIO_DECL address_v4 netmask() const noexcept;
 
   /// Obtain an address object that represents the network address.
   address_v4 network() const noexcept
   {
     return address_v4(address_.to_uint() & netmask().to_uint());
   }
 
   /// Obtain an address object that represents the network's broadcast address.
   address_v4 broadcast() const noexcept
   {
     return address_v4(network().to_uint() | (netmask().to_uint() ^ 0xFFFFFFFF));
   }
 
   /// Obtain an address range corresponding to the hosts in the network.
   BOOST_ASIO_DECL address_v4_range hosts() const noexcept;
 
   /// Obtain the true network address, omitting any host bits.
   network_v4 canonical() const noexcept
   {
     return network_v4(network(), prefix_length());
   }
 
   /// Test if network is a valid host address.
   bool is_host() const noexcept
   {
     return prefix_length_ == 32;
   }
 
   /// Test if a network is a real subnet of another network.
   BOOST_ASIO_DECL bool is_subnet_of(const network_v4& other) const;
 
   /// Get the network as an address in dotted decimal format.
   BOOST_ASIO_DECL std::string to_string() const;
 
   /// Get the network as an address in dotted decimal format.
   BOOST_ASIO_DECL std::string to_string(boost::system::error_code& ec) const;
 
   /// Compare two networks for equality.
   friend bool operator==(const network_v4& a, const network_v4& b)
   {
     return a.address_ == b.address_ && a.prefix_length_ == b.prefix_length_;
   }
 
   /// Compare two networks for inequality.
   friend bool operator!=(const network_v4& a, const network_v4& b)
   {
     return !(a == b);
   }
 
 private:
   address_v4 address_;
   unsigned short prefix_length_;
 };
 
 /// Create an IPv4 network from an address and prefix length.
 /**
  * @relates address_v4
  */
 inline network_v4 make_network_v4(
     const address_v4& addr, unsigned short prefix_len)
 {
   return network_v4(addr, prefix_len);
 }
 
 /// Create an IPv4 network from an address and netmask.
 /**
  * @relates address_v4
  */
 inline network_v4 make_network_v4(
     const address_v4& addr, const address_v4& mask)
 {
   return network_v4(addr, mask);
 }
 
 /// Create an IPv4 network from a string containing IP address and prefix
 /// length.
 /**
  * @relates network_v4
  */
 BOOST_ASIO_DECL network_v4 make_network_v4(const char* str);
 
 /// Create an IPv4 network from a string containing IP address and prefix
 /// length.
 /**
  * @relates network_v4
  */
 BOOST_ASIO_DECL network_v4 make_network_v4(
     const char* str, boost::system::error_code& ec);
 
 /// Create an IPv4 network from a string containing IP address and prefix
 /// length.
 /**
  * @relates network_v4
  */
 BOOST_ASIO_DECL network_v4 make_network_v4(const std::string& str);
 
 /// Create an IPv4 network from a string containing IP address and prefix
 /// length.
 /**
  * @relates network_v4
  */
 BOOST_ASIO_DECL network_v4 make_network_v4(
     const std::string& str, boost::system::error_code& ec);
 
 #if defined(BOOST_ASIO_HAS_STRING_VIEW) \
   || defined(GENERATING_DOCUMENTATION)
 
 /// Create an IPv4 network from a string containing IP address and prefix
 /// length.
 /**
  * @relates network_v4
  */
 BOOST_ASIO_DECL network_v4 make_network_v4(string_view str);
 
 /// Create an IPv4 network from a string containing IP address and prefix
 /// length.
 /**
  * @relates network_v4
  */
 BOOST_ASIO_DECL network_v4 make_network_v4(
     string_view str, boost::system::error_code& ec);
 
 #endif // defined(BOOST_ASIO_HAS_STRING_VIEW)
        //  || defined(GENERATING_DOCUMENTATION)
 
 #if !defined(BOOST_ASIO_NO_IOSTREAM)
 
 /// Output a network as a string.
 /**
  * Used to output a human-readable string for a specified network.
  *
  * @param os The output stream to which the string will be written.
  *
  * @param net The network to be written.
  *
  * @return The output stream.
  *
  * @relates boost::asio::ip::address_v4
  */
 template <typename Elem, typename Traits>
 std::basic_ostream<Elem, Traits>& operator<<(
     std::basic_ostream<Elem, Traits>& os, const network_v4& net);
 
 #endif // !defined(BOOST_ASIO_NO_IOSTREAM)
 
 } // namespace ip
 } // namespace asio
 } // namespace boost
 
 #include <boost/asio/detail/pop_options.hpp>
 
 #include <boost/asio/ip/impl/network_v4.hpp>
 #if defined(BOOST_ASIO_HEADER_ONLY)
 # include <boost/asio/ip/impl/network_v4.ipp>
 #endif // defined(BOOST_ASIO_HEADER_ONLY)
 
 #endif // BOOST_ASIO_IP_NETWORK_V4_HPP

This page was automatically generated by the 2.3.7 LXR engine. The LXR team