All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends
asio::ip::basic_resolver_iterator< InternetProtocol > Class Template Reference

An iterator over the entries produced by a resolver. More...

#include <basic_resolver_iterator.hpp>

List of all members.

Public Member Functions

 basic_resolver_iterator ()
 Default constructor creates an end iterator.

Static Public Member Functions

static basic_resolver_iterator create (asio::detail::addrinfo_type *address_info, const std::string &host_name, const std::string &service_name)
 Create an iterator from an addrinfo list returned by getaddrinfo.
static basic_resolver_iterator create (const typename InternetProtocol::endpoint &endpoint, const std::string &host_name, const std::string &service_name)
 Create an iterator from an endpoint, host name and service name.

Private Types

typedef values_type::const_iterator values_iter_type
typedef std::vector
< basic_resolver_entry
< InternetProtocol > > 
values_type

Private Member Functions

const basic_resolver_entry
< InternetProtocol > & 
dereference () const
bool equal (const basic_resolver_iterator &other) const
void increment ()

Private Attributes

boost::optional< values_iter_typeiter_
boost::shared_ptr< values_typevalues_

Friends

class boost::iterator_core_access

Detailed Description

template<typename InternetProtocol>
class asio::ip::basic_resolver_iterator< InternetProtocol >

An iterator over the entries produced by a resolver.

The 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:

 const basic_resolver_entry<InternetProtocol> 
Thread Safety
Distinct objects: Safe.
Shared objects: Unsafe.

Definition at line 49 of file basic_resolver_iterator.hpp.


Member Typedef Documentation

template<typename InternetProtocol >
typedef values_type::const_iterator asio::ip::basic_resolver_iterator< InternetProtocol >::values_iter_type [private]

Definition at line 144 of file basic_resolver_iterator.hpp.

template<typename InternetProtocol >
typedef std::vector<basic_resolver_entry<InternetProtocol> > asio::ip::basic_resolver_iterator< InternetProtocol >::values_type [private]

Definition at line 143 of file basic_resolver_iterator.hpp.


Constructor & Destructor Documentation

template<typename InternetProtocol >
asio::ip::basic_resolver_iterator< InternetProtocol >::basic_resolver_iterator ( ) [inline]

Default constructor creates an end iterator.

Definition at line 57 of file basic_resolver_iterator.hpp.


Member Function Documentation

template<typename InternetProtocol >
static basic_resolver_iterator asio::ip::basic_resolver_iterator< InternetProtocol >::create ( asio::detail::addrinfo_type address_info,
const std::string &  host_name,
const std::string &  service_name 
) [inline, static]

Create an iterator from an addrinfo list returned by getaddrinfo.

Definition at line 62 of file basic_resolver_iterator.hpp.

template<typename InternetProtocol >
static basic_resolver_iterator asio::ip::basic_resolver_iterator< InternetProtocol >::create ( const typename InternetProtocol::endpoint &  endpoint,
const std::string &  host_name,
const std::string &  service_name 
) [inline, static]

Create an iterator from an endpoint, host name and service name.

Definition at line 102 of file basic_resolver_iterator.hpp.

template<typename InternetProtocol >
const basic_resolver_entry<InternetProtocol>& asio::ip::basic_resolver_iterator< InternetProtocol >::dereference ( ) const [inline, private]

Definition at line 138 of file basic_resolver_iterator.hpp.

template<typename InternetProtocol >
bool asio::ip::basic_resolver_iterator< InternetProtocol >::equal ( const basic_resolver_iterator< InternetProtocol > &  other) const [inline, private]

Definition at line 129 of file basic_resolver_iterator.hpp.

template<typename InternetProtocol >
void asio::ip::basic_resolver_iterator< InternetProtocol >::increment ( ) [inline, private]

Definition at line 118 of file basic_resolver_iterator.hpp.


Friends And Related Function Documentation

template<typename InternetProtocol >
friend class boost::iterator_core_access [friend]

Definition at line 116 of file basic_resolver_iterator.hpp.


Member Data Documentation

template<typename InternetProtocol >
boost::optional<values_iter_type> asio::ip::basic_resolver_iterator< InternetProtocol >::iter_ [private]

Definition at line 146 of file basic_resolver_iterator.hpp.

template<typename InternetProtocol >
boost::shared_ptr<values_type> asio::ip::basic_resolver_iterator< InternetProtocol >::values_ [private]

Definition at line 145 of file basic_resolver_iterator.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


Castor
Author(s): Carpe Noctem
autogenerated on Fri Nov 8 2013 11:05:41