{{+bindTo:partials.standard_nacl_api}}
<h1>pp::NetworkList Class Reference</h1>
<div id="doxygen-ref">
{{- dummy div to appease doxygen -}}
  <div>
<!-- Generated by Doxygen 1.7.6.1 -->


</div>
<!--header-->
<div class="contents">
<!-- doxytag: class="pp::NetworkList" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader">
Inheritance diagram for pp::NetworkList:</div>
<div class="dyncontent">
<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>
<map name="pp_1_1_network_list_inherit__map" id="pp_1_1_network_list_inherit__map">
<area shape="rect" id="node2" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="13,5,117,32"></area></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classpp_1_1_network_list-members.html">List of all members.</a></p>
<h2>
Public Member Functions</h2><table class="memberdecls">

<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#a2f79e2f0c884db428a4e1df63b64e2c0">NetworkList</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</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>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#a4dd51a7af2b0af6c6b962e975131c3e2">GetCount</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</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>
<tr><td class="memItemLeft" align="right" valign="top">PP_NetworkList_Type&#160;</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>
<tr><td class="memItemLeft" align="right" valign="top">PP_NetworkList_State&#160;</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>
<tr><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#ab2dee43ce3ac787852438210b80361d8">GetIpAddresses</a> (uint32_t index, std::vector&lt; <a class="el" href="classpp_1_1_net_address.html">NetAddress</a> &gt; *addresses) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</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>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</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>
</table><h2>
Static Public Member Functions</h2><table class="memberdecls">
<tr><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_list.html#ab059a90bb9e2aced3f0e709853d0e61f">IsAvailable</a> ()</td></tr>
</table>
<hr /><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2f79e2f0c884db428a4e1df63b64e2c0"></a><!-- doxytag: member="pp::NetworkList::NetworkList" ref="a2f79e2f0c884db428a4e1df63b64e2c0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_network_list.html#a2f79e2f0c884db428a4e1df63b64e2c0">pp::NetworkList::NetworkList</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3d91fdce92976477be4a131fdd5c21e1"></a><!-- doxytag: member="pp::NetworkList::NetworkList" ref="a3d91fdce92976477be4a131fdd5c21e1" args="(PassRef, PP_Resource resource)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_network_list.html#a2f79e2f0c884db428a4e1df63b64e2c0">pp::NetworkList::NetworkList</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PP_Resource&#160;</td>
<td class="paramname"><em>resource</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr /><h2>Member Function Documentation</h2>
<a class="anchor" id="a4dd51a7af2b0af6c6b962e975131c3e2"></a><!-- doxytag: member="pp::NetworkList::GetCount" ref="a4dd51a7af2b0af6c6b962e975131c3e2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="classpp_1_1_network_list.html#a4dd51a7af2b0af6c6b962e975131c3e2">pp::NetworkList::GetCount</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
</div>
</div>
<a class="anchor" id="a5a9aff0b4b03205a35ba0298fb9d383f"></a><!-- doxytag: member="pp::NetworkList::GetDisplayName" ref="a5a9aff0b4b03205a35ba0298fb9d383f" args="(uint32_t index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classpp_1_1_network_list.html#a5a9aff0b4b03205a35ba0298fb9d383f">pp::NetworkList::GetDisplayName</a> </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
</div>
</div>
<a class="anchor" id="ab2dee43ce3ac787852438210b80361d8"></a><!-- doxytag: member="pp::NetworkList::GetIpAddresses" ref="ab2dee43ce3ac787852438210b80361d8" args="(uint32_t index, std::vector&lt; NetAddress &gt; *addresses) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="classpp_1_1_network_list.html#ab2dee43ce3ac787852438210b80361d8">pp::NetworkList::GetIpAddresses</a> </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; <a class="el" href="classpp_1_1_net_address.html">NetAddress</a> &gt; *&#160;</td>
<td class="paramname"><em>addresses</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
</div>
</div>
<a class="anchor" id="aebbb32231a87568e7fbe29e50e16fc58"></a><!-- doxytag: member="pp::NetworkList::GetMTU" ref="aebbb32231a87568e7fbe29e50e16fc58" args="(uint32_t index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="classpp_1_1_network_list.html#aebbb32231a87568e7fbe29e50e16fc58">pp::NetworkList::GetMTU</a> </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the MTU for the network interface with the specified <code>index</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="acb253aedb772fc42bdfbb5d05331d8b1"></a><!-- doxytag: member="pp::NetworkList::GetName" ref="acb253aedb772fc42bdfbb5d05331d8b1" args="(uint32_t index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classpp_1_1_network_list.html#acb253aedb772fc42bdfbb5d05331d8b1">pp::NetworkList::GetName</a> </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the name for the network interface with the specified <code>index</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a9c4a05d5bc5d0d23aac52f59f1718e32"></a><!-- doxytag: member="pp::NetworkList::GetState" ref="a9c4a05d5bc5d0d23aac52f59f1718e32" args="(uint32_t index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PP_NetworkList_State <a class="el" href="classpp_1_1_network_list.html#a9c4a05d5bc5d0d23aac52f59f1718e32">pp::NetworkList::GetState</a> </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
</div>
</div>
<a class="anchor" id="a61d4a2421294e176d749115cbf5fb91b"></a><!-- doxytag: member="pp::NetworkList::GetType" ref="a61d4a2421294e176d749115cbf5fb91b" args="(uint32_t index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PP_NetworkList_Type <a class="el" href="classpp_1_1_network_list.html#a61d4a2421294e176d749115cbf5fb91b">pp::NetworkList::GetType</a> </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the type of the network interface with the specified <code>index</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="ab059a90bb9e2aced3f0e709853d0e61f"></a><!-- doxytag: member="pp::NetworkList::IsAvailable" ref="ab059a90bb9e2aced3f0e709853d0e61f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="classpp_1_1_network_list.html#ab059a90bb9e2aced3f0e709853d0e61f">pp::NetworkList::IsAvailable</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the required interface is available. </p>
</div>
</div>
<hr />The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="network__list_8h.html">network_list.h</a></li>
</ul>
</div><!-- contents -->
</div>
{{/partials.standard_nacl_api}}