1 {{+bindTo:partials.standard_nacl_api}}
2 <h1>pp::NetworkList Class Reference</h1>
4 {{- dummy div to appease doxygen -}}
6 <!-- Generated by Doxygen 1.7.6.1 -->
12 <div class="contents">
13 <!-- doxytag: class="pp::NetworkList" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader">
14 Inheritance diagram for pp::NetworkList:</div>
15 <div class="dyncontent">
16 <div class="center"><img src="classpp_1_1_network_list__inherit__graph.png" border="0" usemap="#pp_1_1_network_list_inherit__map" alt="Inheritance graph" /></div>
17 <map name="pp_1_1_network_list_inherit__map" id="pp_1_1_network_list_inherit__map">
18 <area shape="rect" id="node2" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="13,5,117,35"></area></map>
19 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
20 <p><a href="classpp_1_1_network_list-members.html">List of all members.</a></p>
22 Public Member Functions</h2><table class="memberdecls">
24 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#a2f79e2f0c884db428a4e1df63b64e2c0">NetworkList</a> ()</td></tr>
25 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#a3d91fdce92976477be4a131fdd5c21e1">NetworkList</a> (<a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>, PP_Resource resource)</td></tr>
26 <tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#a4dd51a7af2b0af6c6b962e975131c3e2">GetCount</a> () const </td></tr>
27 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#acb253aedb772fc42bdfbb5d05331d8b1">GetName</a> (uint32_t index) const </td></tr>
28 <tr><td class="memItemLeft" align="right" valign="top">PP_NetworkList_Type </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#a61d4a2421294e176d749115cbf5fb91b">GetType</a> (uint32_t index) const </td></tr>
29 <tr><td class="memItemLeft" align="right" valign="top">PP_NetworkList_State </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#a9c4a05d5bc5d0d23aac52f59f1718e32">GetState</a> (uint32_t index) const </td></tr>
30 <tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#ab2dee43ce3ac787852438210b80361d8">GetIpAddresses</a> (uint32_t index, std::vector< <a class="el" href="classpp_1_1_net_address.html">NetAddress</a> > *addresses) const </td></tr>
31 <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#a5a9aff0b4b03205a35ba0298fb9d383f">GetDisplayName</a> (uint32_t index) const </td></tr>
32 <tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#aebbb32231a87568e7fbe29e50e16fc58">GetMTU</a> (uint32_t index) const </td></tr>
34 Static Public Member Functions</h2><table class="memberdecls">
35 <tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#ab059a90bb9e2aced3f0e709853d0e61f">IsAvailable</a> ()</td></tr>
37 <hr /><h2>Constructor & Destructor Documentation</h2>
38 <a class="anchor" id="a2f79e2f0c884db428a4e1df63b64e2c0"></a><!-- doxytag: member="pp::NetworkList::NetworkList" ref="a2f79e2f0c884db428a4e1df63b64e2c0" args="()" -->
40 <div class="memproto">
41 <table class="memname">
43 <td class="memname"><a class="el" href="classpp_1_1_network_list.html#a2f79e2f0c884db428a4e1df63b64e2c0">pp::NetworkList::NetworkList</a> </td>
45 <td class="paramname"></td><td>)</td>
53 <a class="anchor" id="a3d91fdce92976477be4a131fdd5c21e1"></a><!-- doxytag: member="pp::NetworkList::NetworkList" ref="a3d91fdce92976477be4a131fdd5c21e1" args="(PassRef, PP_Resource resource)" -->
55 <div class="memproto">
56 <table class="memname">
58 <td class="memname"><a class="el" href="classpp_1_1_network_list.html#a2f79e2f0c884db428a4e1df63b64e2c0">pp::NetworkList::NetworkList</a> </td>
60 <td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a> </td>
61 <td class="paramname">, </td>
64 <td class="paramkey"></td>
66 <td class="paramtype">PP_Resource </td>
67 <td class="paramname"><em>resource</em> </td>
79 <hr /><h2>Member Function Documentation</h2>
80 <a class="anchor" id="a4dd51a7af2b0af6c6b962e975131c3e2"></a><!-- doxytag: member="pp::NetworkList::GetCount" ref="a4dd51a7af2b0af6c6b962e975131c3e2" args="() const " -->
82 <div class="memproto">
83 <table class="memname">
85 <td class="memname">uint32_t <a class="el" href="classpp_1_1_network_list.html#a4dd51a7af2b0af6c6b962e975131c3e2">pp::NetworkList::GetCount</a> </td>
87 <td class="paramname"></td><td>)</td>
93 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns the number of available network interfaces or 0 if the list has never been updated. </dd></dl>
96 <a class="anchor" id="a5a9aff0b4b03205a35ba0298fb9d383f"></a><!-- doxytag: member="pp::NetworkList::GetDisplayName" ref="a5a9aff0b4b03205a35ba0298fb9d383f" args="(uint32_t index) const " -->
98 <div class="memproto">
99 <table class="memname">
101 <td class="memname">std::string <a class="el" href="classpp_1_1_network_list.html#a5a9aff0b4b03205a35ba0298fb9d383f">pp::NetworkList::GetDisplayName</a> </td>
103 <td class="paramtype">uint32_t </td>
104 <td class="paramname"><em>index</em></td><td>)</td>
110 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns the display name for the network interface with the specified <code>index</code>. </dd></dl>
113 <a class="anchor" id="ab2dee43ce3ac787852438210b80361d8"></a><!-- doxytag: member="pp::NetworkList::GetIpAddresses" ref="ab2dee43ce3ac787852438210b80361d8" args="(uint32_t index, std::vector< NetAddress > *addresses) const " -->
114 <div class="memitem">
115 <div class="memproto">
116 <table class="memname">
118 <td class="memname">int32_t <a class="el" href="classpp_1_1_network_list.html#ab2dee43ce3ac787852438210b80361d8">pp::NetworkList::GetIpAddresses</a> </td>
120 <td class="paramtype">uint32_t </td>
121 <td class="paramname"><em>index</em>, </td>
124 <td class="paramkey"></td>
126 <td class="paramtype">std::vector< <a class="el" href="classpp_1_1_net_address.html">NetAddress</a> > * </td>
127 <td class="paramname"><em>addresses</em> </td>
132 <td></td><td> const</td>
137 <p>Gets the list of IP addresses for the network interface with the specified <code>index</code> and stores them in <code>addresses</code>. </p>
140 <a class="anchor" id="aebbb32231a87568e7fbe29e50e16fc58"></a><!-- doxytag: member="pp::NetworkList::GetMTU" ref="aebbb32231a87568e7fbe29e50e16fc58" args="(uint32_t index) const " -->
141 <div class="memitem">
142 <div class="memproto">
143 <table class="memname">
145 <td class="memname">uint32_t <a class="el" href="classpp_1_1_network_list.html#aebbb32231a87568e7fbe29e50e16fc58">pp::NetworkList::GetMTU</a> </td>
147 <td class="paramtype">uint32_t </td>
148 <td class="paramname"><em>index</em></td><td>)</td>
154 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns the MTU for the network interface with the specified <code>index</code>. </dd></dl>
157 <a class="anchor" id="acb253aedb772fc42bdfbb5d05331d8b1"></a><!-- doxytag: member="pp::NetworkList::GetName" ref="acb253aedb772fc42bdfbb5d05331d8b1" args="(uint32_t index) const " -->
158 <div class="memitem">
159 <div class="memproto">
160 <table class="memname">
162 <td class="memname">std::string <a class="el" href="classpp_1_1_network_list.html#acb253aedb772fc42bdfbb5d05331d8b1">pp::NetworkList::GetName</a> </td>
164 <td class="paramtype">uint32_t </td>
165 <td class="paramname"><em>index</em></td><td>)</td>
171 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns the name for the network interface with the specified <code>index</code>. </dd></dl>
174 <a class="anchor" id="a9c4a05d5bc5d0d23aac52f59f1718e32"></a><!-- doxytag: member="pp::NetworkList::GetState" ref="a9c4a05d5bc5d0d23aac52f59f1718e32" args="(uint32_t index) const " -->
175 <div class="memitem">
176 <div class="memproto">
177 <table class="memname">
179 <td class="memname">PP_NetworkList_State <a class="el" href="classpp_1_1_network_list.html#a9c4a05d5bc5d0d23aac52f59f1718e32">pp::NetworkList::GetState</a> </td>
181 <td class="paramtype">uint32_t </td>
182 <td class="paramname"><em>index</em></td><td>)</td>
188 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns the current state of the network interface with the specified <code>index</code>. </dd></dl>
191 <a class="anchor" id="a61d4a2421294e176d749115cbf5fb91b"></a><!-- doxytag: member="pp::NetworkList::GetType" ref="a61d4a2421294e176d749115cbf5fb91b" args="(uint32_t index) const " -->
192 <div class="memitem">
193 <div class="memproto">
194 <table class="memname">
196 <td class="memname">PP_NetworkList_Type <a class="el" href="classpp_1_1_network_list.html#a61d4a2421294e176d749115cbf5fb91b">pp::NetworkList::GetType</a> </td>
198 <td class="paramtype">uint32_t </td>
199 <td class="paramname"><em>index</em></td><td>)</td>
205 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns the type of the network interface with the specified <code>index</code>. </dd></dl>
208 <a class="anchor" id="ab059a90bb9e2aced3f0e709853d0e61f"></a><!-- doxytag: member="pp::NetworkList::IsAvailable" ref="ab059a90bb9e2aced3f0e709853d0e61f" args="()" -->
209 <div class="memitem">
210 <div class="memproto">
211 <table class="memname">
213 <td class="memname">static bool <a class="el" href="classpp_1_1_network_list.html#ab059a90bb9e2aced3f0e709853d0e61f">pp::NetworkList::IsAvailable</a> </td>
215 <td class="paramname"></td><td>)</td>
216 <td><code> [static]</code></td>
221 <p>Returns true if the required interface is available. </p>
224 <hr />The documentation for this class was generated from the following file:<ul>
225 <li><a class="el" href="network__list_8h.html">network_list.h</a></li>
227 </div><!-- contents -->
229 {{/partials.standard_nacl_api}}