← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/asio/jaunty

« back to all changes in this revision

Viewing changes to doc/reference/a00011.html

  • Committer: Bazaar Package Importer
  • Author(s): Simon Richter
  • Date: 2007-09-07 11:10:41 UTC
  • Revision ID: james.westby@ubuntu.com-20070907111041-f0uwhs0llvzj9ah5
Tags: upstream-0.3.8~rc3
Import upstream version 0.3.8~rc3

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/a00011.html
 
1
<HTML>
 
2
  <HEAD>
 
3
    <TITLE>asio Reference: asio::ip::basic_resolver_iterator&lt; InternetProtocol &gt; Class Template Reference</TITLE>
 
4
    <LINK HREF="asio.css" REL="stylesheet" TYPE="text/css">
 
5
    <LINK HREF="tabs.css" REL="stylesheet" TYPE="text/css">
 
6
  </HEAD>
 
7
  <BODY BGCOLOR="#FFFFFF">
 
8
    <DIV CLASS="qindex">
 
9
      <TABLE BORDER="0" WIDTH="100%">
 
10
        <TR>
 
11
          <TD ALIGN="LEFT">
 
12
            <B>asio 0.3.8rc3</B>
 
13
          </TD>
 
14
          <TD ALIGN="RIGHT">
 
15
            <A CLASS="qindex" HREF="../index.html">Home</A> |
 
16
            <A CLASS="qindex" HREF="../reference/index.html">Reference</A> |
 
17
            <A CLASS="qindex" HREF="../tutorial/index.html">Tutorial</A> |
 
18
            <A CLASS="qindex" HREF="../examples/index.html">Examples</A> |
 
19
            <A CLASS="qindex" HREF="../design/index.html">Design</A>
 
20
          </TD>
 
21
        </TR>
 
22
      </TABLE>
 
23
    </DIV>
 
24
    <DIV CLASS="qindex">
 
25
      <TABLE BORDER="0" WIDTH="100%">
 
26
        <TR>
 
27
          <TD ALIGN="LEFT">
 
28
            <B>Reference</B>
 
29
          </TD>
 
30
          <TD ALIGN="RIGHT">
 
31
            <A CLASS="qindex" HREF="hierarchy.html">Class Hierarchy</A> |
 
32
            <A CLASS="qindex" HREF="classes.html">Class Index</A> |
 
33
            <A CLASS="qindex" HREF="functions.html">Member Index</A>
 
34
          </TD>
 
35
        </TR>
 
36
      </TABLE>
 
37
    </DIV>
 
38
<!-- Generated by Doxygen 1.5.1 -->
 
39
<div class="nav">
 
40
<a class="el" href="a00126.html">asio</a>::<a class="el" href="a00128.html">ip</a>::<a class="el" href="a00011.html">basic_resolver_iterator</a></div>
 
41
<h1>asio::ip::basic_resolver_iterator&lt; InternetProtocol &gt; Class Template Reference</h1><!-- doxytag: class="asio::ip::basic_resolver_iterator" --><a href="a00240.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
 
42
<h3>template&lt;typename InternetProtocol&gt;<br>
 
43
 class asio::ip::basic_resolver_iterator&lt; InternetProtocol &gt;</h3>
 
44
 
 
45
An iterator over the entries produced by a resolver. 
 
46
<p>
 
47
The <a class="el" href="a00011.html">asio::ip::basic_resolver_iterator</a> class template is used to define iterators over the results returned by a resolver.<p>
 
48
The iterator's value_type, obtained when the iterator is dereferenced, is: <div class="fragment"><pre class="fragment"> <span class="keyword">const</span> basic_resolver_entry&lt;InternetProtocol&gt; 
 
49
</pre></div><p>
 
50
<dl class="user" compact><dt><b>Thread Safety</b></dt><dd><em>Distinct</em> <em>objects:</em> Safe.<br>
 
51
 <em>Shared</em> <em>objects:</em> Unsafe. </dd></dl>
 
52
 
 
53
<p>
 
54
<table border="0" cellpadding="0" cellspacing="0">
 
55
<tr><td></td></tr>
 
56
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 
57
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#78a4783f973017eaa37d9c8072b732a8">basic_resolver_iterator</a> ()</td></tr>
 
58
 
 
59
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor creates an end iterator.  <a href="#78a4783f973017eaa37d9c8072b732a8"></a><br></td></tr>
 
60
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
 
61
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00011.html">basic_resolver_iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#07c8950163e5fecd4f877ffef27b2261">create</a> (asio::detail::addrinfo_type *address_info, const std::string &amp;host_name, const std::string &amp;service_name)</td></tr>
 
62
 
 
63
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an iterator from an addrinfo list returned by getaddrinfo.  <a href="#07c8950163e5fecd4f877ffef27b2261"></a><br></td></tr>
 
64
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00011.html">basic_resolver_iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#a976005ecb96a549b57e6e6fe37c12f1">create</a> (const typename InternetProtocol::endpoint &amp;endpoint, const std::string &amp;host_name, const std::string &amp;service_name)</td></tr>
 
65
 
 
66
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an iterator from an endpoint, host name and service name.  <a href="#a976005ecb96a549b57e6e6fe37c12f1"></a><br></td></tr>
 
67
</table>
 
68
<hr><h2>Constructor &amp; Destructor Documentation</h2>
 
69
<a class="anchor" name="78a4783f973017eaa37d9c8072b732a8"></a><!-- doxytag: member="asio::ip::basic_resolver_iterator::basic_resolver_iterator" ref="78a4783f973017eaa37d9c8072b732a8" args="()" -->
 
70
<div class="memitem">
 
71
<div class="memproto">
 
72
<div class="memtemplate">
 
73
template&lt;typename InternetProtocol&gt; </div>
 
74
      <table class="memname">
 
75
        <tr>
 
76
          <td class="memname"><a class="el" href="a00011.html">asio::ip::basic_resolver_iterator</a>&lt; InternetProtocol &gt;::<a class="el" href="a00011.html">basic_resolver_iterator</a>           </td>
 
77
          <td>(</td>
 
78
          <td class="paramname">          </td>
 
79
          <td>&nbsp;)&nbsp;</td>
 
80
          <td width="100%"></td>
 
81
        </tr>
 
82
      </table>
 
83
</div>
 
84
<div class="memdoc">
 
85
 
 
86
<p>
 
87
Default constructor creates an end iterator. 
 
88
<p>
 
89
 
 
90
</div>
 
91
</div><p>
 
92
<hr><h2>Member Function Documentation</h2>
 
93
<a class="anchor" name="07c8950163e5fecd4f877ffef27b2261"></a><!-- doxytag: member="asio::ip::basic_resolver_iterator::create" ref="07c8950163e5fecd4f877ffef27b2261" args="(asio::detail::addrinfo_type *address_info, const std::string &amp;host_name, const std::string &amp;service_name)" -->
 
94
<div class="memitem">
 
95
<div class="memproto">
 
96
<div class="memtemplate">
 
97
template&lt;typename InternetProtocol&gt; </div>
 
98
      <table class="memname">
 
99
        <tr>
 
100
          <td class="memname">static <a class="el" href="a00011.html">basic_resolver_iterator</a> <a class="el" href="a00011.html">asio::ip::basic_resolver_iterator</a>&lt; InternetProtocol &gt;::create           </td>
 
101
          <td>(</td>
 
102
          <td class="paramtype">asio::detail::addrinfo_type *&nbsp;</td>
 
103
          <td class="paramname"> <em>address_info</em>, </td>
 
104
        </tr>
 
105
        <tr>
 
106
          <td class="paramkey"></td>
 
107
          <td></td>
 
108
          <td class="paramtype">const std::string &amp;&nbsp;</td>
 
109
          <td class="paramname"> <em>host_name</em>, </td>
 
110
        </tr>
 
111
        <tr>
 
112
          <td class="paramkey"></td>
 
113
          <td></td>
 
114
          <td class="paramtype">const std::string &amp;&nbsp;</td>
 
115
          <td class="paramname"> <em>service_name</em></td><td>&nbsp;</td>
 
116
        </tr>
 
117
        <tr>
 
118
          <td></td>
 
119
          <td>)</td>
 
120
          <td></td><td></td><td width="100%"><code> [static]</code></td>
 
121
        </tr>
 
122
      </table>
 
123
</div>
 
124
<div class="memdoc">
 
125
 
 
126
<p>
 
127
Create an iterator from an addrinfo list returned by getaddrinfo. 
 
128
<p>
 
129
 
 
130
</div>
 
131
</div><p>
 
132
<a class="anchor" name="a976005ecb96a549b57e6e6fe37c12f1"></a><!-- doxytag: member="asio::ip::basic_resolver_iterator::create" ref="a976005ecb96a549b57e6e6fe37c12f1" args="(const typename InternetProtocol::endpoint &amp;endpoint, const std::string &amp;host_name, const std::string &amp;service_name)" -->
 
133
<div class="memitem">
 
134
<div class="memproto">
 
135
<div class="memtemplate">
 
136
template&lt;typename InternetProtocol&gt; </div>
 
137
      <table class="memname">
 
138
        <tr>
 
139
          <td class="memname">static <a class="el" href="a00011.html">basic_resolver_iterator</a> <a class="el" href="a00011.html">asio::ip::basic_resolver_iterator</a>&lt; InternetProtocol &gt;::create           </td>
 
140
          <td>(</td>
 
141
          <td class="paramtype">const typename InternetProtocol::endpoint &amp;&nbsp;</td>
 
142
          <td class="paramname"> <em>endpoint</em>, </td>
 
143
        </tr>
 
144
        <tr>
 
145
          <td class="paramkey"></td>
 
146
          <td></td>
 
147
          <td class="paramtype">const std::string &amp;&nbsp;</td>
 
148
          <td class="paramname"> <em>host_name</em>, </td>
 
149
        </tr>
 
150
        <tr>
 
151
          <td class="paramkey"></td>
 
152
          <td></td>
 
153
          <td class="paramtype">const std::string &amp;&nbsp;</td>
 
154
          <td class="paramname"> <em>service_name</em></td><td>&nbsp;</td>
 
155
        </tr>
 
156
        <tr>
 
157
          <td></td>
 
158
          <td>)</td>
 
159
          <td></td><td></td><td width="100%"><code> [static]</code></td>
 
160
        </tr>
 
161
      </table>
 
162
</div>
 
163
<div class="memdoc">
 
164
 
 
165
<p>
 
166
Create an iterator from an endpoint, host name and service name. 
 
167
<p>
 
168
 
 
169
</div>
 
170
</div><p>
 
171
    <DIV CLASS="qindex">
 
172
      <TABLE BORDER="0" WIDTH="100%">
 
173
        <TR>
 
174
          <TD ALIGN="LEFT">
 
175
            <B>asio 0.3.8rc3</B>
 
176
          </TD>
 
177
          <TD ALIGN="RIGHT">
 
178
            <A CLASS="qindex" HREF="../index.html">Home</A> |
 
179
            <A CLASS="qindex" HREF="../reference/index.html">Reference</A> |
 
180
            <A CLASS="qindex" HREF="../tutorial/index.html">Tutorial</A> |
 
181
            <A CLASS="qindex" HREF="../examples/index.html">Examples</A> |
 
182
            <A CLASS="qindex" HREF="../design/index.html">Design</A>
 
183
          </TD>
 
184
        </TR>
 
185
      </TABLE>
 
186
    </DIV>
 
187
  </BODY>
 
188
</HTML>