Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

PrevUpHomeNext

ip::basic_resolver

Provides endpoint resolution functionality.

template<
    typename InternetProtocol,
    typename Executor>
class basic_resolver :
  public ip::resolver_base
Types

Name

Description

endpoint_type

The endpoint type.

executor_type

The type of the executor associated with the object.

flags

A bitmask type (C++ Std [lib.bitmask.types]).

iterator

(Deprecated.) The iterator type.

protocol_type

The protocol type.

query

(Deprecated.) The query type.

results_type

The results type.

Member Functions

Name

Description

async_resolve

(Deprecated: Use overload with separate host and service parameters.) Asynchronously perform forward resolution of a query to a list of entries.

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

Asynchronously perform reverse resolution of an endpoint to a list of entries.

basic_resolver

Construct with executor.

Construct with execution context.

Move-construct a basic_resolver from another.

cancel

Cancel any asynchronous operations that are waiting on the resolver.

get_executor

Get the executor associated with the object.

operator=

Move-assign a basic_resolver from another.

resolve

(Deprecated: Use overload with separate host and service parameters.) Perform forward resolution of a query to a list of entries.

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

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

~basic_resolver

Destroys the resolver.

Data Members

Name

Description

address_configured

Only return IPv4 addresses if a non-loopback IPv4 address is configured for the system. Only return IPv6 addresses if a non-loopback IPv6 address is configured for the system.

all_matching

If used with v4_mapped, return all matching IPv6 and IPv4 addresses.

canonical_name

Determine the canonical name of the host specified in the query.

numeric_host

Host name should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted.

numeric_service

Service name should be treated as a numeric string defining a port number and no name resolution should be attempted.

passive

Indicate that returned endpoint is intended for use as a locally bound socket endpoint.

v4_mapped

If the query protocol family is specified as IPv6, return IPv4-mapped IPv6 addresses on finding no IPv6 addresses.

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

Thread Safety

Distinct objects: Safe.

Shared objects: Unsafe.

Requirements

Header: boost/asio/ip/basic_resolver.hpp

Convenience header: boost/asio.hpp


PrevUpHomeNext