1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>ip::basic_resolver_query</title> 5<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../reference.html" title="Reference"> 9<link rel="prev" href="ip__basic_resolver_iterator/values_.html" title="ip::basic_resolver_iterator::values_"> 10<link rel="next" href="ip__basic_resolver_query/address_configured.html" title="ip::basic_resolver_query::address_configured"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 15<td align="center"><a href="../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="ip__basic_resolver_iterator/values_.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ip__basic_resolver_query/address_configured.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="boost_asio.reference.ip__basic_resolver_query"></a><a class="link" href="ip__basic_resolver_query.html" title="ip::basic_resolver_query">ip::basic_resolver_query</a> 28</h3></div></div></div> 29<p> 30 An query to be passed to a resolver. 31 </p> 32<pre class="programlisting">template< 33 typename <a class="link" href="InternetProtocol.html" title="Internet protocol requirements">InternetProtocol</a>> 34class basic_resolver_query : 35 public ip::resolver_query_base 36</pre> 37<h5> 38<a name="boost_asio.reference.ip__basic_resolver_query.h0"></a> 39 <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_query.types"></a></span><a class="link" href="ip__basic_resolver_query.html#boost_asio.reference.ip__basic_resolver_query.types">Types</a> 40 </h5> 41<div class="informaltable"><table class="table"> 42<colgroup> 43<col> 44<col> 45</colgroup> 46<thead><tr> 47<th> 48 <p> 49 Name 50 </p> 51 </th> 52<th> 53 <p> 54 Description 55 </p> 56 </th> 57</tr></thead> 58<tbody> 59<tr> 60<td> 61 <p> 62 <a class="link" href="ip__basic_resolver_query/flags.html" title="ip::basic_resolver_query::flags"><span class="bold"><strong>flags</strong></span></a> 63 </p> 64 </td> 65<td> 66 <p> 67 A bitmask type (C++ Std [lib.bitmask.types]). 68 </p> 69 </td> 70</tr> 71<tr> 72<td> 73 <p> 74 <a class="link" href="ip__basic_resolver_query/protocol_type.html" title="ip::basic_resolver_query::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a> 75 </p> 76 </td> 77<td> 78 <p> 79 The protocol type associated with the endpoint query. 80 </p> 81 </td> 82</tr> 83</tbody> 84</table></div> 85<h5> 86<a name="boost_asio.reference.ip__basic_resolver_query.h1"></a> 87 <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_query.member_functions"></a></span><a class="link" href="ip__basic_resolver_query.html#boost_asio.reference.ip__basic_resolver_query.member_functions">Member 88 Functions</a> 89 </h5> 90<div class="informaltable"><table class="table"> 91<colgroup> 92<col> 93<col> 94</colgroup> 95<thead><tr> 96<th> 97 <p> 98 Name 99 </p> 100 </th> 101<th> 102 <p> 103 Description 104 </p> 105 </th> 106</tr></thead> 107<tbody> 108<tr> 109<td> 110 <p> 111 <a class="link" href="ip__basic_resolver_query/basic_resolver_query.html" title="ip::basic_resolver_query::basic_resolver_query"><span class="bold"><strong>basic_resolver_query</strong></span></a> <span class="silver">[constructor]</span> 112 </p> 113 </td> 114<td> 115 <p> 116 Construct with specified service name for any protocol. <br> 117 <span class="silver"> —</span><br> Construct with specified service name for a given protocol. 118 <br> <span class="silver"> —</span><br> Construct with specified host name and service name 119 for any protocol. <br> <span class="silver"> —</span><br> Construct with specified host name 120 and service name for a given protocol. 121 </p> 122 </td> 123</tr> 124<tr> 125<td> 126 <p> 127 <a class="link" href="ip__basic_resolver_query/hints.html" title="ip::basic_resolver_query::hints"><span class="bold"><strong>hints</strong></span></a> 128 </p> 129 </td> 130<td> 131 <p> 132 Get the hints associated with the query. 133 </p> 134 </td> 135</tr> 136<tr> 137<td> 138 <p> 139 <a class="link" href="ip__basic_resolver_query/host_name.html" title="ip::basic_resolver_query::host_name"><span class="bold"><strong>host_name</strong></span></a> 140 </p> 141 </td> 142<td> 143 <p> 144 Get the host name associated with the query. 145 </p> 146 </td> 147</tr> 148<tr> 149<td> 150 <p> 151 <a class="link" href="ip__basic_resolver_query/service_name.html" title="ip::basic_resolver_query::service_name"><span class="bold"><strong>service_name</strong></span></a> 152 </p> 153 </td> 154<td> 155 <p> 156 Get the service name associated with the query. 157 </p> 158 </td> 159</tr> 160</tbody> 161</table></div> 162<h5> 163<a name="boost_asio.reference.ip__basic_resolver_query.h2"></a> 164 <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_query.data_members"></a></span><a class="link" href="ip__basic_resolver_query.html#boost_asio.reference.ip__basic_resolver_query.data_members">Data 165 Members</a> 166 </h5> 167<div class="informaltable"><table class="table"> 168<colgroup> 169<col> 170<col> 171</colgroup> 172<thead><tr> 173<th> 174 <p> 175 Name 176 </p> 177 </th> 178<th> 179 <p> 180 Description 181 </p> 182 </th> 183</tr></thead> 184<tbody> 185<tr> 186<td> 187 <p> 188 <a class="link" href="ip__basic_resolver_query/address_configured.html" title="ip::basic_resolver_query::address_configured"><span class="bold"><strong>address_configured</strong></span></a> <span class="silver">[static]</span> 189 </p> 190 </td> 191<td> 192 <p> 193 Only return IPv4 addresses if a non-loopback IPv4 address is configured 194 for the system. Only return IPv6 addresses if a non-loopback IPv6 195 address is configured for the system. 196 </p> 197 </td> 198</tr> 199<tr> 200<td> 201 <p> 202 <a class="link" href="ip__basic_resolver_query/all_matching.html" title="ip::basic_resolver_query::all_matching"><span class="bold"><strong>all_matching</strong></span></a> <span class="silver">[static]</span> 203 </p> 204 </td> 205<td> 206 <p> 207 If used with v4_mapped, return all matching IPv6 and IPv4 addresses. 208 </p> 209 </td> 210</tr> 211<tr> 212<td> 213 <p> 214 <a class="link" href="ip__basic_resolver_query/canonical_name.html" title="ip::basic_resolver_query::canonical_name"><span class="bold"><strong>canonical_name</strong></span></a> <span class="silver">[static]</span> 215 </p> 216 </td> 217<td> 218 <p> 219 Determine the canonical name of the host specified in the query. 220 </p> 221 </td> 222</tr> 223<tr> 224<td> 225 <p> 226 <a class="link" href="ip__basic_resolver_query/numeric_host.html" title="ip::basic_resolver_query::numeric_host"><span class="bold"><strong>numeric_host</strong></span></a> <span class="silver">[static]</span> 227 </p> 228 </td> 229<td> 230 <p> 231 Host name should be treated as a numeric string defining an IPv4 232 or IPv6 address and no name resolution should be attempted. 233 </p> 234 </td> 235</tr> 236<tr> 237<td> 238 <p> 239 <a class="link" href="ip__basic_resolver_query/numeric_service.html" title="ip::basic_resolver_query::numeric_service"><span class="bold"><strong>numeric_service</strong></span></a> <span class="silver">[static]</span> 240 </p> 241 </td> 242<td> 243 <p> 244 Service name should be treated as a numeric string defining a port 245 number and no name resolution should be attempted. 246 </p> 247 </td> 248</tr> 249<tr> 250<td> 251 <p> 252 <a class="link" href="ip__basic_resolver_query/passive.html" title="ip::basic_resolver_query::passive"><span class="bold"><strong>passive</strong></span></a> <span class="silver">[static]</span> 253 </p> 254 </td> 255<td> 256 <p> 257 Indicate that returned endpoint is intended for use as a locally 258 bound socket endpoint. 259 </p> 260 </td> 261</tr> 262<tr> 263<td> 264 <p> 265 <a class="link" href="ip__basic_resolver_query/v4_mapped.html" title="ip::basic_resolver_query::v4_mapped"><span class="bold"><strong>v4_mapped</strong></span></a> <span class="silver">[static]</span> 266 </p> 267 </td> 268<td> 269 <p> 270 If the query protocol family is specified as IPv6, return IPv4-mapped 271 IPv6 addresses on finding no IPv6 addresses. 272 </p> 273 </td> 274</tr> 275</tbody> 276</table></div> 277<p> 278 The <a class="link" href="ip__basic_resolver_query.html" title="ip::basic_resolver_query"><code class="computeroutput">ip::basic_resolver_query</code></a> 279 class template describes a query that can be passed to a resolver. 280 </p> 281<h5> 282<a name="boost_asio.reference.ip__basic_resolver_query.h3"></a> 283 <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_query.thread_safety"></a></span><a class="link" href="ip__basic_resolver_query.html#boost_asio.reference.ip__basic_resolver_query.thread_safety">Thread 284 Safety</a> 285 </h5> 286<p> 287 <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe. 288 </p> 289<p> 290 <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe. 291 </p> 292<h5> 293<a name="boost_asio.reference.ip__basic_resolver_query.h4"></a> 294 <span class="phrase"><a name="boost_asio.reference.ip__basic_resolver_query.requirements"></a></span><a class="link" href="ip__basic_resolver_query.html#boost_asio.reference.ip__basic_resolver_query.requirements">Requirements</a> 295 </h5> 296<p> 297 <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/ip/basic_resolver_query.hpp</code> 298 </p> 299<p> 300 <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code> 301 </p> 302</div> 303<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 304<td align="left"></td> 305<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 306 Kohlhoff<p> 307 Distributed under the Boost Software License, Version 1.0. (See accompanying 308 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 309 </p> 310</div></td> 311</tr></table> 312<hr> 313<div class="spirit-nav"> 314<a accesskey="p" href="ip__basic_resolver_iterator/values_.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ip__basic_resolver_query/address_configured.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 315</div> 316</body> 317</html> 318
