PageRenderTime 47ms CodeModel.GetById 17ms RepoModel.GetById 1ms app.codeStats 0ms

/asio-1.4.8/doc/asio/reference/ip__basic_resolver_query.html

#
HTML | 317 lines | 317 code | 0 blank | 0 comment | 0 complexity | 51c5b654c616dfde06bd3b772d87c4bb MD5 | raw file
    

  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>ip::basic_resolver_query</title>
    5. 

  5. <link rel="stylesheet" href="../../boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
    7. 

  7. <link rel="start" href="../../index.html" title="Asio">
    8. 

  8. <link rel="up" href="../reference.html" title="Reference">
    9. 

  9. <link rel="prev" href="ip__basic_resolver_iterator/operator_eq__eq_.html" title="ip::basic_resolver_iterator::operator==">
    10. 

  10. <link rel="next" href="ip__basic_resolver_query/address_configured.html" title="ip::basic_resolver_query::address_configured">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
    14. 

  14. <hr>
    15. 

  15. <div class="spirit-nav">
    16. 

  16. <a accesskey="p" href="ip__basic_resolver_iterator/operator_eq__eq_.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="ip__basic_resolver_query/address_configured.html"><img src="../../next.png" alt="Next"></a>
    17. 

  17. </div>
    18. 

  18. <div class="section" lang="en">
    19. 

  19. <div class="titlepage"><div><div><h3 class="title">
    20. 

  20. <a name="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>
    21. 

  21. </h3></div></div></div>
    22. 

  22. <p>
    23. 

  23.         An query to be passed to a resolver.
    24. 

  24.       </p>
    25. 

  25. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    26. 

  26.     <span class="keyword">typename</span> <a class="link" href="InternetProtocol.html" title="Internet protocol requirements">InternetProtocol</a><span class="special">&gt;</span>
    27. 

  27. <span class="keyword">class</span> <span class="identifier">basic_resolver_query</span> <span class="special">:</span>
    28. 

  28.   <span class="keyword">public</span> <span class="identifier">ip</span><span class="special">::</span><span class="identifier">resolver_query_base</span>
    29. 

  29. </pre>
    30. 

  30. <a name="asio.reference.ip__basic_resolver_query.types"></a><h5>
    31. 

  31. <a name="id1027897"></a>
    32. 

  32.         <a class="link" href="ip__basic_resolver_query.html#asio.reference.ip__basic_resolver_query.types">Types</a>
    33. 

  33.       </h5>
    34. 

  34. <div class="informaltable"><table class="table">
    35. 

  35. <colgroup>
    36. 

  36. <col>
    37. 

  37. <col>
    38. 

  38. </colgroup>
    39. 

  39. <thead><tr>
    40. 

  40. <th>
    41. 

  41.                 <p>
    42. 

  42.                   Name
    43. 

  43.                 </p>
    44. 

  44.               </th>
    45. 

  45. <th>
    46. 

  46.                 <p>
    47. 

  47.                   Description
    48. 

  48.                 </p>
    49. 

  49.               </th>
    50. 

  50. </tr></thead>
    51. 

  51. <tbody>
    52. 

  52. <tr>
    53. 

  53. <td>
    54. 

  54.                 <p>
    55. 

  55.                   <a class="link" href="ip__basic_resolver_query/flags.html" title="ip::basic_resolver_query::flags"><span class="bold"><strong>flags</strong></span></a>
    56. 

  56.                 </p>
    57. 

  57.               </td>
    58. 

  58. <td>
    59. 

  59.                 <p>
    60. 

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

  61.                 </p>
    62. 

  62.               </td>
    63. 

  63. </tr>
    64. 

  64. <tr>
    65. 

  65. <td>
    66. 

  66.                 <p>
    67. 

  67.                   <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>
    68. 

  68.                 </p>
    69. 

  69.               </td>
    70. 

  70. <td>
    71. 

  71.                 <p>
    72. 

  72.                   The protocol type associated with the endpoint query.
    73. 

  73.                 </p>
    74. 

  74.               </td>
    75. 

  75. </tr>
    76. 

  76. </tbody>
    77. 

  77. </table></div>
    78. 

  78. <a name="asio.reference.ip__basic_resolver_query.member_functions"></a><h5>
    79. 

  79. <a name="id1028004"></a>
    80. 

  80.         <a class="link" href="ip__basic_resolver_query.html#asio.reference.ip__basic_resolver_query.member_functions">Member
    81. 

  81.         Functions</a>
    82. 

  82.       </h5>
    83. 

  83. <div class="informaltable"><table class="table">
    84. 

  84. <colgroup>
    85. 

  85. <col>
    86. 

  86. <col>
    87. 

  87. </colgroup>
    88. 

  88. <thead><tr>
    89. 

  89. <th>
    90. 

  90.                 <p>
    91. 

  91.                   Name
    92. 

  92.                 </p>
    93. 

  93.               </th>
    94. 

  94. <th>
    95. 

  95.                 <p>
    96. 

  96.                   Description
    97. 

  97.                 </p>
    98. 

  98.               </th>
    99. 

  99. </tr></thead>
    100. 

  100. <tbody>
    101. 

  101. <tr>
    102. 

  102. <td>
    103. 

  103.                 <p>
    104. 

  104.                   <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>
    105. 

  105.                 </p>
    106. 

  106.               </td>
    107. 

  107. <td>
    108. 

  108.                 <p>
    109. 

  109.                   Construct with specified service name for any protocol.
    110. 

  110.                 </p>
    111. 

  111.                 <p>
    112. 

  112.                   Construct with specified service name for a given protocol.
    113. 

  113.                 </p>
    114. 

  114.                 <p>
    115. 

  115.                   Construct with specified host name and service name for any protocol.
    116. 

  116.                 </p>
    117. 

  117.                 <p>
    118. 

  118.                   Construct with specified host name and service name for a given
    119. 

  119.                   protocol.
    120. 

  120.                 </p>
    121. 

  121.               </td>
    122. 

  122. </tr>
    123. 

  123. <tr>
    124. 

  124. <td>
    125. 

  125.                 <p>
    126. 

  126.                   <a class="link" href="ip__basic_resolver_query/hints.html" title="ip::basic_resolver_query::hints"><span class="bold"><strong>hints</strong></span></a>
    127. 

  127.                 </p>
    128. 

  128.               </td>
    129. 

  129. <td>
    130. 

  130.                 <p>
    131. 

  131.                   Get the hints associated with the query.
    132. 

  132.                 </p>
    133. 

  133.               </td>
    134. 

  134. </tr>
    135. 

  135. <tr>
    136. 

  136. <td>
    137. 

  137.                 <p>
    138. 

  138.                   <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>
    139. 

  139.                 </p>
    140. 

  140.               </td>
    141. 

  141. <td>
    142. 

  142.                 <p>
    143. 

  143.                   Get the host name associated with the query.
    144. 

  144.                 </p>
    145. 

  145.               </td>
    146. 

  146. </tr>
    147. 

  147. <tr>
    148. 

  148. <td>
    149. 

  149.                 <p>
    150. 

  150.                   <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>
    151. 

  151.                 </p>
    152. 

  152.               </td>
    153. 

  153. <td>
    154. 

  154.                 <p>
    155. 

  155.                   Get the service name associated with the query.
    156. 

  156.                 </p>
    157. 

  157.               </td>
    158. 

  158. </tr>
    159. 

  159. </tbody>
    160. 

  160. </table></div>
    161. 

  161. <a name="asio.reference.ip__basic_resolver_query.data_members"></a><h5>
    162. 

  162. <a name="id1028181"></a>
    163. 

  163.         <a class="link" href="ip__basic_resolver_query.html#asio.reference.ip__basic_resolver_query.data_members">Data
    164. 

  164.         Members</a>
    165. 

  165.       </h5>
    166. 

  166. <div class="informaltable"><table class="table">
    167. 

  167. <colgroup>
    168. 

  168. <col>
    169. 

  169. <col>
    170. 

  170. </colgroup>
    171. 

  171. <thead><tr>
    172. 

  172. <th>
    173. 

  173.                 <p>
    174. 

  174.                   Name
    175. 

  175.                 </p>
    176. 

  176.               </th>
    177. 

  177. <th>
    178. 

  178.                 <p>
    179. 

  179.                   Description
    180. 

  180.                 </p>
    181. 

  181.               </th>
    182. 

  182. </tr></thead>
    183. 

  183. <tbody>
    184. 

  184. <tr>
    185. 

  185. <td>
    186. 

  186.                 <p>
    187. 

  187.                   <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>
    188. 

  188.                 </p>
    189. 

  189.               </td>
    190. 

  190. <td>
    191. 

  191.                 <p>
    192. 

  192.                   Only return IPv4 addresses if a non-loopback IPv4 address is configured
    193. 

  193.                   for the system. Only return IPv6 addresses if a non-loopback IPv6
    194. 

  194.                   address is configured for the system.
    195. 

  195.                 </p>
    196. 

  196.               </td>
    197. 

  197. </tr>
    198. 

  198. <tr>
    199. 

  199. <td>
    200. 

  200.                 <p>
    201. 

  201.                   <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>
    202. 

  202.                 </p>
    203. 

  203.               </td>
    204. 

  204. <td>
    205. 

  205.                 <p>
    206. 

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

  207.                 </p>
    208. 

  208.               </td>
    209. 

  209. </tr>
    210. 

  210. <tr>
    211. 

  211. <td>
    212. 

  212.                 <p>
    213. 

  213.                   <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>
    214. 

  214.                 </p>
    215. 

  215.               </td>
    216. 

  216. <td>
    217. 

  217.                 <p>
    218. 

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

  219.                 </p>
    220. 

  220.               </td>
    221. 

  221. </tr>
    222. 

  222. <tr>
    223. 

  223. <td>
    224. 

  224.                 <p>
    225. 

  225.                   <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>
    226. 

  226.                 </p>
    227. 

  227.               </td>
    228. 

  228. <td>
    229. 

  229.                 <p>
    230. 

  230.                   Host name should be treated as a numeric string defining an IPv4
    231. 

  231.                   or IPv6 address and no name resolution should be attempted.
    232. 

  232.                 </p>
    233. 

  233.               </td>
    234. 

  234. </tr>
    235. 

  235. <tr>
    236. 

  236. <td>
    237. 

  237.                 <p>
    238. 

  238.                   <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>
    239. 

  239.                 </p>
    240. 

  240.               </td>
    241. 

  241. <td>
    242. 

  242.                 <p>
    243. 

  243.                   Service name should be treated as a numeric string defining a port
    244. 

  244.                   number and no name resolution should be attempted.
    245. 

  245.                 </p>
    246. 

  246.               </td>
    247. 

  247. </tr>
    248. 

  248. <tr>
    249. 

  249. <td>
    250. 

  250.                 <p>
    251. 

  251.                   <a class="link" href="ip__basic_resolver_query/passive.html" title="ip::basic_resolver_query::passive"><span class="bold"><strong>passive</strong></span></a>
    252. 

  252.                 </p>
    253. 

  253.               </td>
    254. 

  254. <td>
    255. 

  255.                 <p>
    256. 

  256.                   Indicate that returned endpoint is intended for use as a locally
    257. 

  257.                   bound socket endpoint.
    258. 

  258.                 </p>
    259. 

  259.               </td>
    260. 

  260. </tr>
    261. 

  261. <tr>
    262. 

  262. <td>
    263. 

  263.                 <p>
    264. 

  264.                   <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>
    265. 

  265.                 </p>
    266. 

  266.               </td>
    267. 

  267. <td>
    268. 

  268.                 <p>
    269. 

  269.                   If the query protocol family is specified as IPv6, return IPv4-mapped
    270. 

  270.                   IPv6 addresses on finding no IPv6 addresses.
    271. 

  271.                 </p>
    272. 

  272.               </td>
    273. 

  273. </tr>
    274. 

  274. </tbody>
    275. 

  275. </table></div>
    276. 

  276. <p>
    277. 

  277.         The <a class="link" href="ip__basic_resolver_query.html" title="ip::basic_resolver_query"><code class="computeroutput"><span class="identifier">ip</span><span class="special">::</span><span class="identifier">basic_resolver_query</span></code></a>
    278. 

  278.         class template describes a query that can be passed to a resolver.
    279. 

  279.       </p>
    280. 

  280. <a name="asio.reference.ip__basic_resolver_query.thread_safety"></a><h5>
    281. 

  281. <a name="id1028459"></a>
    282. 

  282.         <a class="link" href="ip__basic_resolver_query.html#asio.reference.ip__basic_resolver_query.thread_safety">Thread
    283. 

  283.         Safety</a>
    284. 

  284.       </h5>
    285. 

  285. <p>
    286. 

  286.         <span class="bold"><strong>Distinct</strong></span> <span class="bold"><strong>objects:</strong></span>
    287. 

  287.         Safe.
    288. 

  288.       </p>
    289. 

  289. <p>
    290. 

  290.         <span class="bold"><strong>Shared</strong></span> <span class="bold"><strong>objects:</strong></span>
    291. 

  291.         Unsafe.
    292. 

  292.       </p>
    293. 

  293. <a name="asio.reference.ip__basic_resolver_query.requirements"></a><h5>
    294. 

  294. <a name="id1028509"></a>
    295. 

  295.         <a class="link" href="ip__basic_resolver_query.html#asio.reference.ip__basic_resolver_query.requirements">Requirements</a>
    296. 

  296.       </h5>
    297. 

  297. <p>
    298. 

  298.         <span class="bold"><strong>Header: </strong></span><code class="literal">asio/ip/basic_resolver_query.hpp</code>
    299. 

  299.       </p>
    300. 

  300. <p>
    301. 

  301.         <span class="bold"><strong>Convenience header: </strong></span><code class="literal">asio.hpp</code>
    302. 

  302.       </p>
    303. 

  303. </div>
    304. 

  304. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    305. 

  305. <td align="left"></td>
    306. 

  306. <td align="right"><div class="copyright-footer">Copyright &#169; 2003 - 2010 Christopher M. Kohlhoff<p>
    307. 

  307.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    308. 

  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. 

  309.       </p>
    310. 

  310. </div></td>
    311. 

  311. </tr></table>
    312. 

  312. <hr>
    313. 

  313. <div class="spirit-nav">
    314. 

  314. <a accesskey="p" href="ip__basic_resolver_iterator/operator_eq__eq_.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="ip__basic_resolver_query/address_configured.html"><img src="../../next.png" alt="Next"></a>
    315. 

  315. </div>
    316. 

  316. </body>
    317. 

  317. </html>
    318. 

  318.