Reference | Class Hierarchy | Class Index | Member Index |
Inheritance diagram for asio::basic_resolver< Protocol, Service >:
The basic_resolver class template provides the ability to resolve a query to a list of endpoints.
Public Types | |
typedef Protocol | protocol_type |
The protocol type. | |
typedef Protocol::endpoint | endpoint_type |
The endpoint type. | |
typedef Protocol::resolver_query | query |
The query type. | |
typedef Protocol::resolver_iterator | iterator |
The iterator type. | |
typedef asio::error | error_type |
The type used for reporting errors. | |
typedef Service | service_type |
The type of the service that will be used to provide I/O operations. | |
typedef service_type::implementation_type | implementation_type |
The underlying implementation type of I/O object. | |
Public Member Functions | |
basic_resolver (asio::io_service &io_service) | |
Constructor. | |
void | cancel () |
Cancel any asynchronous operations that are waiting on the resolver. | |
iterator | resolve (const query &q) |
Resolve a query to a list of entries. | |
template<typename Error_Handler> | |
iterator | resolve (const query &q, Error_Handler error_handler) |
Resolve a query to a list of entries. | |
template<typename Handler> | |
void | async_resolve (const query &q, Handler handler) |
Asynchronously resolve a query to a list of entries. | |
iterator | resolve (const endpoint_type &e) |
Resolve an endpoint to a list of entries. | |
template<typename Error_Handler> | |
iterator | resolve (const endpoint_type &e, Error_Handler error_handler) |
Resolve an endpoint to a list of entries. | |
template<typename Handler> | |
void | async_resolve (const endpoint_type &e, Handler handler) |
Asynchronously resolve an endpoint to a list of entries. | |
asio::io_service & | io_service () |
Get the io_service associated with the object. |
typedef Protocol asio::basic_resolver< Protocol, Service >::protocol_type |
The protocol type.
typedef Protocol::endpoint asio::basic_resolver< Protocol, Service >::endpoint_type |
The endpoint type.
typedef Protocol::resolver_query asio::basic_resolver< Protocol, Service >::query |
The query type.
typedef Protocol::resolver_iterator asio::basic_resolver< Protocol, Service >::iterator |
The iterator type.
typedef asio::error asio::basic_resolver< Protocol, Service >::error_type |
The type used for reporting errors.
typedef Service asio::basic_io_object< Service >::service_type [inherited] |
The type of the service that will be used to provide I/O operations.
typedef service_type::implementation_type asio::basic_io_object< Service >::implementation_type [inherited] |
The underlying implementation type of I/O object.
asio::basic_resolver< Protocol, Service >::basic_resolver | ( | asio::io_service & | io_service | ) | [explicit] |
Constructor.
This constructor creates a basic_resolver.
io_service | The io_service object that the resolver will use to dispatch handlers for any asynchronous operations performed on the timer. |
void asio::basic_resolver< Protocol, Service >::cancel | ( | ) |
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.
iterator asio::basic_resolver< Protocol, Service >::resolve | ( | const query & | q | ) |
Resolve a query to a list of entries.
This function is used to resolve a query into a list of endpoint entries.
q | A query object that determines what endpoints will be returned. |
asio::error | Thrown on failure. |
A successful call to this function is guaranteed to return at least one entry.
iterator asio::basic_resolver< Protocol, Service >::resolve | ( | const query & | q, | |
Error_Handler | error_handler | |||
) |
Resolve a query to a list of entries.
This function is used to resolve a query into a list of endpoint entries.
q | A query object that determines what endpoints will be returned. |
error_handler | A handler to be called when the operation completes, to indicate whether or not an error has occurred. Copies will be made of the handler as required. The function signature of the handler must be: void error_handler( const asio::error& error // Result of operation. ); |
A successful call to this function is guaranteed to return at least one entry.
void asio::basic_resolver< Protocol, Service >::async_resolve | ( | const query & | q, | |
Handler | handler | |||
) |
Asynchronously resolve a query to a list of entries.
This function is used to asynchronously resolve a query into a list of endpoint entries.
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& error, // Result of operation. resolver::iterator iterator // Forward-only iterator that can be used to // traverse the list of endpoint entries. ); |
A successful resolve operation is guaranteed to pass at least one entry to the handler.
iterator asio::basic_resolver< Protocol, Service >::resolve | ( | const endpoint_type & | e | ) |
Resolve an endpoint to a list of entries.
This function is used to resolve an endpoint into a list of endpoint entries.
e | An endpoint object that determines what endpoints will be returned. |
asio::error | Thrown on failure. |
A successful call to this function is guaranteed to return at least one entry.
iterator asio::basic_resolver< Protocol, Service >::resolve | ( | const endpoint_type & | e, | |
Error_Handler | error_handler | |||
) |
Resolve an endpoint to a list of entries.
This function is used to resolve an endpoint into a list of endpoint entries.
e | An endpoint object that determines what endpoints will be returned. |
error_handler | A handler to be called when the operation completes, to indicate whether or not an error has occurred. Copies will be made of the handler as required. The function signature of the handler must be: void error_handler( const asio::error& error // Result of operation. ); |
A successful call to this function is guaranteed to return at least one entry.
void asio::basic_resolver< Protocol, Service >::async_resolve | ( | const endpoint_type & | e, | |
Handler | handler | |||
) |
Asynchronously resolve an endpoint to a list of entries.
This function is used to asynchronously resolve an endpoint into a list of endpoint entries.
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& error, // Result of operation. resolver::iterator iterator // Forward-only iterator that can be used to // traverse the list of endpoint entries. ); |
A successful resolve operation is guaranteed to pass at least one entry to the handler.
asio::io_service& asio::basic_io_object< Service >::io_service | ( | ) | [inherited] |
Get the io_service associated with the object.
This function may be used to obtain the io_service object that the I/O object uses to dispatch handlers for asynchronous operations.