boost/asio
2
0
Fork 0
mirror of https://github.com/boostorg/asio.git synced 2026-02-26 02:42:08 +00:00
Code Issues Projects Releases Wiki Activity

Document basic_resolver_query's constructor arguments.

Browse Source 
[SVN r60921]
This commit is contained in:
Christopher Kohlhoff
2010-03-29 23:51:15 +00:00
parent 399786e737
commit f1debcc472
1 changed files with 98 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
include/boost/asio/ip/basic_resolver_query.hpp
View File

@@ -47,6 +47,22 @@ public:
typedef InternetProtocol protocol_type;
/// Construct with specified service name for any protocol.
/**
* This constructor is typically used to perform name resolution for local
* service binding.
*
* @param service_name A string identifying the requested service. This may
* be a descriptive name or a numeric string corresponding to a port number.
*
* @param resolve_flags A set of flags that determine how name resolution
* should be performed. The default flags are suitable for local service
* binding.
*
* @note On POSIX systems, service names are typically defined in the file
* <tt>/etc/services</tt>. On Windows, service names may be found in the file
* <tt>c:\\windows\\system32\\drivers\\etc\\services</tt>. Operating systems
* may use additional locations when resolving service names.
*/
basic_resolver_query(const std::string& service_name,
resolver_query_base::flags resolve_flags = passive | address_configured)
: hints_(),
@@ -65,6 +81,25 @@ public:
}
/// Construct with specified service name for a given protocol.
/**
* This constructor is typically used to perform name resolution for local
* service binding with a specific protocol version.
*
* @param protocol A protocol object, normally representing either the IPv4 or
* IPv6 version of an internet protocol.
*
* @param service_name A string identifying the requested service. This may
* be a descriptive name or a numeric string corresponding to a port number.
*
* @param resolve_flags A set of flags that determine how name resolution
* should be performed. The default flags are suitable for local service
* binding.
*
* @note On POSIX systems, service names are typically defined in the file
* <tt>/etc/services</tt>. On Windows, service names may be found in the file
* <tt>c:\\windows\\system32\\drivers\\etc\\services</tt>. Operating systems
* may use additional locations when resolving service names.
*/
basic_resolver_query(const protocol_type& protocol,
const std::string& service_name,
resolver_query_base::flags resolve_flags = passive | address_configured)
@@ -83,6 +118,36 @@ public:
}
/// Construct with specified host name and service name for any protocol.
/**
* This constructor is typically used to perform name resolution for
* communication with remote hosts.
*
* @param host_name A string identifying a location. May be a descriptive name
* or a numeric address string. If an empty string and the passive flag has
* been specified, the resolved endpoints are suitable for local service
* binding. If an empty string and passive is not specified, the resolved
* endpoints will use the loopback address.
*
* @param service_name A string identifying the requested service. This may
* be a descriptive name or a numeric string corresponding to a port number.
* May be an empty string, in which case all resolved endpoints will have a
* port number of 0.
*
* @param resolve_flags A set of flags that determine how name resolution
* should be performed. The default flags are suitable for communication with
* remote hosts.
*
* @note On POSIX systems, host names may be locally defined in the file
* <tt>/etc/hosts</tt>. On Windows, host names may be defined in the file
* <tt>c:\\windows\\system32\\drivers\\etc\\hosts</tt>. Remote host name
* resolution is performed using DNS. Operating systems may use additional
* locations when resolving host names (such as NETBIOS names on Windows).
*
* On POSIX systems, service names are typically defined in the file
* <tt>/etc/services</tt>. On Windows, service names may be found in the file
* <tt>c:\\windows\\system32\\drivers\\etc\\services</tt>. Operating systems
* may use additional locations when resolving service names.
*/
basic_resolver_query(const std::string& host_name,
const std::string& service_name,
resolver_query_base::flags resolve_flags = address_configured)
@@ -102,6 +167,39 @@ public:
}
/// Construct with specified host name and service name for a given protocol.
/**
* This constructor is typically used to perform name resolution for
* communication with remote hosts.
*
* @param protocol A protocol object, normally representing either the IPv4 or
* IPv6 version of an internet protocol.
*
* @param host_name A string identifying a location. May be a descriptive name
* or a numeric address string. If an empty string and the passive flag has
* been specified, the resolved endpoints are suitable for local service
* binding. If an empty string and passive is not specified, the resolved
* endpoints will use the loopback address.
*
* @param service_name A string identifying the requested service. This may
* be a descriptive name or a numeric string corresponding to a port number.
* May be an empty string, in which case all resolved endpoints will have a
* port number of 0.
*
* @param resolve_flags A set of flags that determine how name resolution
* should be performed. The default flags are suitable for communication with
* remote hosts.
*
* @note On POSIX systems, host names may be locally defined in the file
* <tt>/etc/hosts</tt>. On Windows, host names may be defined in the file
* <tt>c:\\windows\\system32\\drivers\\etc\\hosts</tt>. Remote host name
* resolution is performed using DNS. Operating systems may use additional
* locations when resolving host names (such as NETBIOS names on Windows).
*
* On POSIX systems, service names are typically defined in the file
* <tt>/etc/services</tt>. On Windows, service names may be found in the file
* <tt>c:\\windows\\system32\\drivers\\etc\\services</tt>. Operating systems
* may use additional locations when resolving service names.
*/
basic_resolver_query(const protocol_type& protocol,
const std::string& host_name, const std::string& service_name,
resolver_query_base::flags resolve_flags = address_configured)