EIC code displayed by LXR master/​include/​boost/​asio/​ip/​basic_resolver_iterator.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/basic_resolver_iterator.hpp
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 //
 // Copyright (c) 2003-2023 Christopher M. Kohlhoff (chris at kohlhoff 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_BASIC_RESOLVER_ITERATOR_HPP
 #define BOOST_ASIO_IP_BASIC_RESOLVER_ITERATOR_HPP
 
 #if defined(_MSC_VER) && (_MSC_VER >= 1200)
 # pragma once
 #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
 
 #include <boost/asio/detail/config.hpp>
 #include <cstddef>
 #include <cstring>
 #include <iterator>
 #include <string>
 #include <vector>
 #include <boost/asio/detail/memory.hpp>
 #include <boost/asio/detail/socket_ops.hpp>
 #include <boost/asio/detail/socket_types.hpp>
 #include <boost/asio/ip/basic_resolver_entry.hpp>
 
 #if defined(BOOST_ASIO_WINDOWS_RUNTIME)
 # include <boost/asio/detail/winrt_utils.hpp>
 #endif // defined(BOOST_ASIO_WINDOWS_RUNTIME)
 
 #include <boost/asio/detail/push_options.hpp>
 
 namespace boost {
 namespace asio {
 namespace ip {
 
 /// An iterator over the entries produced by a resolver.
 /**
  * The boost::asio::ip::basic_resolver_iterator class template is used to define
  * iterators over the results returned by a resolver.
  *
  * The iterator's value_type, obtained when the iterator is dereferenced, is:
  * @code const basic_resolver_entry<InternetProtocol> @endcode
  *
  * @par Thread Safety
  * @e Distinct @e objects: Safe.@n
  * @e Shared @e objects: Unsafe.
  */
 template <typename InternetProtocol>
 class basic_resolver_iterator
 {
 public:
   /// The type used for the distance between two iterators.
   typedef std::ptrdiff_t difference_type;
 
   /// The type of the value pointed to by the iterator.
   typedef basic_resolver_entry<InternetProtocol> value_type;
 
   /// The type of the result of applying operator->() to the iterator.
   typedef const basic_resolver_entry<InternetProtocol>* pointer;
 
   /// The type of the result of applying operator*() to the iterator.
   typedef const basic_resolver_entry<InternetProtocol>& reference;
 
   /// The iterator category.
   typedef std::forward_iterator_tag iterator_category;
 
   /// Default constructor creates an end iterator.
   basic_resolver_iterator()
     : index_(0)
   {
   }
 
   /// Copy constructor.
   basic_resolver_iterator(const basic_resolver_iterator& other)
     : values_(other.values_),
       index_(other.index_)
   {
   }
 
   /// Move constructor.
   basic_resolver_iterator(basic_resolver_iterator&& other)
     : values_(static_cast<values_ptr_type&&>(other.values_)),
       index_(other.index_)
   {
     other.index_ = 0;
   }
 
   /// Assignment operator.
   basic_resolver_iterator& operator=(const basic_resolver_iterator& other)
   {
     values_ = other.values_;
     index_ = other.index_;
     return *this;
   }
 
   /// Move-assignment operator.
   basic_resolver_iterator& operator=(basic_resolver_iterator&& other)
   {
     if (this != &other)
     {
       values_ = static_cast<values_ptr_type&&>(other.values_);
       index_ = other.index_;
       other.index_ = 0;
     }
 
     return *this;
   }
 
   /// Dereference an iterator.
   const basic_resolver_entry<InternetProtocol>& operator*() const
   {
     return dereference();
   }
 
   /// Dereference an iterator.
   const basic_resolver_entry<InternetProtocol>* operator->() const
   {
     return &dereference();
   }
 
   /// Increment operator (prefix).
   basic_resolver_iterator& operator++()
   {
     increment();
     return *this;
   }
 
   /// Increment operator (postfix).
   basic_resolver_iterator operator++(int)
   {
     basic_resolver_iterator tmp(*this);
     ++*this;
     return tmp;
   }
 
   /// Test two iterators for equality.
   friend bool operator==(const basic_resolver_iterator& a,
       const basic_resolver_iterator& b)
   {
     return a.equal(b);
   }
 
   /// Test two iterators for inequality.
   friend bool operator!=(const basic_resolver_iterator& a,
       const basic_resolver_iterator& b)
   {
     return !a.equal(b);
   }
 
 protected:
   void increment()
   {
     if (++index_ == values_->size())
     {
       // Reset state to match a default constructed end iterator.
       values_.reset();
       index_ = 0;
     }
   }
 
   bool equal(const basic_resolver_iterator& other) const
   {
     if (!values_ && !other.values_)
       return true;
     if (values_ != other.values_)
       return false;
     return index_ == other.index_;
   }
 
   const basic_resolver_entry<InternetProtocol>& dereference() const
   {
     return (*values_)[index_];
   }
 
   typedef std::vector<basic_resolver_entry<InternetProtocol>> values_type;
   typedef boost::asio::detail::shared_ptr<values_type> values_ptr_type;
   values_ptr_type values_;
   std::size_t index_;
 };
 
 } // namespace ip
 } // namespace asio
 } // namespace boost
 
 #include <boost/asio/detail/pop_options.hpp>
 
 #endif // BOOST_ASIO_IP_BASIC_RESOLVER_ITERATOR_HPP

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