Provides endpoint resolution functionality. More...

#include <basic_resolver.hpp>

Inheritance diagram for asio::ip::basic_resolver< InternetProtocol, ResolverService >:

Public Types
typedef InternetProtocol	protocol_type
	The protocol type. More...

typedef InternetProtocol::endpoint	endpoint_type
	The endpoint type. More...

typedef basic_resolver_query< InternetProtocol >	query
	The query type. More...

typedef basic_resolver_iterator< InternetProtocol >	iterator
	The iterator type. More...

Public Types inherited from asio::basic_io_object< ResolverService >
typedef ResolverService	service_type
	The type of the service that will be used to provide I/O operations. More...

typedef service_type::implementation_type	implementation_type
	The underlying implementation type of I/O object. More...

Public Member Functions
	basic_resolver (asio::io_service &io_service)
	Constructor. More...

void	cancel ()
	Cancel any asynchronous operations that are waiting on the resolver. More...

iterator	resolve (const query &q)
	Perform forward resolution of a query to a list of entries. More...

iterator	resolve (const query &q, asio::error_code &ec)
	Perform forward resolution of a query to a list of entries. More...

template<typename ResolveHandler >
	ASIO_INITFN_RESULT_TYPE (ResolveHandler, void(asio::error_code, iterator)) async_resolve(const query &q
	Asynchronously perform forward resolution of a query to a list of entries. More...

	ASIO_MOVE_ARG (ResolveHandler) handler)

iterator	resolve (const endpoint_type &e)
	Perform reverse resolution of an endpoint to a list of entries. More...

iterator	resolve (const endpoint_type &e, asio::error_code &ec)
	Perform reverse resolution of an endpoint to a list of entries. More...

template<typename ResolveHandler >
	ASIO_INITFN_RESULT_TYPE (ResolveHandler, void(asio::error_code, iterator)) async_resolve(const endpoint_type &e

	ASIO_MOVE_ARG (ResolveHandler) handler)

Public Member Functions inherited from asio::basic_io_object< ResolverService >
asio::io_service &	get_io_service ()
	Get the io_service associated with the object. More...

Additional Inherited Members
Protected Member Functions inherited from asio::basic_io_object< ResolverService >
	basic_io_object (asio::io_service &io_service)
	Construct a basic_io_object. More...

	~basic_io_object ()
	Protected destructor to prevent deletion through this type. More...

service_type &	get_service ()
	Get the service associated with the I/O object. More...

const service_type &	get_service () const
	Get the service associated with the I/O object. More...

implementation_type &	get_implementation ()
	Get the underlying implementation of the I/O object. More...

const implementation_type &	get_implementation () const
	Get the underlying implementation of the I/O object. More...

Protected Attributes inherited from asio::basic_io_object< ResolverService >
service_type &	service

implementation_type	implementation

Detailed Description

template<typename InternetProtocol, typename ResolverService = resolver_service<InternetProtocol>>
class asio::ip::basic_resolver< InternetProtocol, ResolverService >

Provides endpoint resolution functionality.

The basic_resolver class template provides the ability to resolve a query to a list of endpoints.

Thread Safety: Distinct objects: Safe.
Shared objects: Unsafe.

Definition at line 43 of file basic_resolver.hpp.

Member Typedef Documentation

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

typedef InternetProtocol::endpoint asio::ip::basic_resolver< InternetProtocol, ResolverService >::endpoint_type

The endpoint type.

Definition at line 51 of file basic_resolver.hpp.

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

typedef basic_resolver_iterator<InternetProtocol> asio::ip::basic_resolver< InternetProtocol, ResolverService >::iterator

The iterator type.

Definition at line 57 of file basic_resolver.hpp.

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

typedef InternetProtocol asio::ip::basic_resolver< InternetProtocol, ResolverService >::protocol_type

The protocol type.

Definition at line 48 of file basic_resolver.hpp.

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

typedef basic_resolver_query<InternetProtocol> asio::ip::basic_resolver< InternetProtocol, ResolverService >::query

The query type.

Definition at line 54 of file basic_resolver.hpp.

Constructor & Destructor Documentation

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

asio::ip::basic_resolver< InternetProtocol, ResolverService >::basic_resolver ( asio::io_service & io_service )

inlineexplicit

Constructor.

This constructor creates a basic_resolver.

Parameters

io_service The io_service object that the resolver will use to dispatch handlers for any asynchronous operations performed on the timer.

Definition at line 66 of file basic_resolver.hpp.

Member Function Documentation

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

template<typename ResolveHandler >

asio::ip::basic_resolver< InternetProtocol, ResolverService >::ASIO_INITFN_RESULT_TYPE	(	ResolveHandler	,
		void(asio::error_code, iterator)
	)		const

Asynchronously perform forward resolution of a query to a list of entries.

This function is used to asynchronously resolve a query into a list of endpoint entries.

Parameters

q A query object that determines what endpoints will be returned.

handler

The handler to be called when the resolve operation completes. Copies will be made of the handler as required. The function signature of the handler must be:

 void handler(
  const asio::error_code& error, // Result of operation.
  resolver::iterator iterator             // Forward-only iterator that can
                                          // be used to traverse the list
                                          // of endpoint entries.
); 

Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using asio::io_service::post().

Note: A default constructed iterator represents the end of the list.

A successful resolve operation is guaranteed to pass at least one entry to the handler.

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

template<typename ResolveHandler >

asio::ip::basic_resolver< InternetProtocol, ResolverService >::ASIO_INITFN_RESULT_TYPE	(	ResolveHandler	,
		void(asio::error_code, iterator)
	)		const

Asynchronously perform reverse resolution of an endpoint to a list of entries. This function is used to asynchronously resolve an endpoint into a list of endpoint entries.

Parameters

e An endpoint object that determines what endpoints will be returned.

handler

The handler to be called when the resolve operation completes. Copies will be made of the handler as required. The function signature of the handler must be:

 void handler(
  const asio::error_code& error, // Result of operation.
  resolver::iterator iterator             // Forward-only iterator that can
                                          // be used to traverse the list
                                          // of endpoint entries.
); 

Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using asio::io_service::post().

Note: A default constructed iterator represents the end of the list.

A successful resolve operation is guaranteed to pass at least one entry to the handler.

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

asio::ip::basic_resolver< InternetProtocol, ResolverService >::ASIO_MOVE_ARG ( ResolveHandler )

inline

Definition at line 158 of file basic_resolver.hpp.

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

asio::ip::basic_resolver< InternetProtocol, ResolverService >::ASIO_MOVE_ARG ( ResolveHandler )

inline

Definition at line 251 of file basic_resolver.hpp.

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

void asio::ip::basic_resolver< InternetProtocol, ResolverService >::cancel ( )

inline

Cancel any asynchronous operations that are waiting on the resolver.

This function forces the completion of any pending asynchronous operations on the host resolver. The handler for each cancelled operation will be invoked with the asio::error::operation_aborted error code.

Definition at line 77 of file basic_resolver.hpp.

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

iterator asio::ip::basic_resolver< InternetProtocol, ResolverService >::resolve ( const query & q )

inline

Perform forward resolution of a query to a list of entries.

This function is used to resolve a query into a list of endpoint entries.

Parameters

q	A query object that determines what endpoints will be returned.

Returns: A forward-only iterator that can be used to traverse the list of endpoint entries.

Exceptions

asio::system_error Thrown on failure.

Note: A default constructed iterator represents the end of the list.

A successful call to this function is guaranteed to return at least one entry.

Definition at line 98 of file basic_resolver.hpp.

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

iterator asio::ip::basic_resolver< InternetProtocol, ResolverService >::resolve	(	const query &	q,
		asio::error_code &	ec
	)

inline

Perform forward resolution of a query to a list of entries.

This function is used to resolve a query into a list of endpoint entries.

Parameters

q	A query object that determines what endpoints will be returned.
ec	Set to indicate what error occurred, if any.

Returns: A forward-only iterator that can be used to traverse the list of endpoint entries. Returns a default constructed iterator if an error occurs.

Note: A default constructed iterator represents the end of the list.

A successful call to this function is guaranteed to return at least one entry.

Definition at line 123 of file basic_resolver.hpp.

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

iterator asio::ip::basic_resolver< InternetProtocol, ResolverService >::resolve ( const endpoint_type & e )

inline

Perform reverse resolution of an endpoint to a list of entries.

This function is used to resolve an endpoint into a list of endpoint entries.

Parameters

e	An endpoint object that determines what endpoints will be returned.

Returns: A forward-only iterator that can be used to traverse the list of endpoint entries.

Exceptions

asio::system_error Thrown on failure.

Note: A default constructed iterator represents the end of the list.

A successful call to this function is guaranteed to return at least one entry.

Definition at line 187 of file basic_resolver.hpp.

template<typename InternetProtocol , typename ResolverService = resolver_service<InternetProtocol>>

iterator asio::ip::basic_resolver< InternetProtocol, ResolverService >::resolve	(	const endpoint_type &	e,
		asio::error_code &	ec
	)

inline

Perform reverse resolution of an endpoint to a list of entries.

This function is used to resolve an endpoint into a list of endpoint entries.

Parameters

e	An endpoint object that determines what endpoints will be returned.
ec	Set to indicate what error occurred, if any.

Returns: A forward-only iterator that can be used to traverse the list of endpoint entries. Returns a default constructed iterator if an error occurs.

Note: A default constructed iterator represents the end of the list.

A successful call to this function is guaranteed to return at least one entry.

Definition at line 214 of file basic_resolver.hpp.

The documentation for this class was generated from the following file:

/home/martin/ver/3DLab/code/asio-1.10.6/include/asio/ip/basic_resolver.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename InternetProtocol, typename ResolverService = resolver_service<InternetProtocol>> class asio::ip::basic_resolver< InternetProtocol, ResolverService >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename InternetProtocol, typename ResolverService = resolver_service<InternetProtocol>>
class asio::ip::basic_resolver< InternetProtocol, ResolverService >