src/native_client_sdk/doc_generated/pepper_dev/cpp/classpp_1_1_network_list.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>pp::NetworkList Class Reference</h1>
   3 <div id="doxygen-ref">
   4 {{- dummy div to appease doxygen -}}
   5   <div>
   6 <!-- Generated by Doxygen 1.7.6.1 -->
   7
   8
   9
  10 </div>
  11 <!--header-->
  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>
  21 <h2>
  22 Public Member Functions</h2><table class="memberdecls">
  23
  24 <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>
  25 <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>
  26 <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>
  27 <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>
  28 <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>
  29 <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>
  30 <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>
  31 <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>
  32 <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>
  33 </table><h2>
  34 Static Public Member Functions</h2><table class="memberdecls">
  35 <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>
  36 </table>
  37 <hr /><h2>Constructor &amp; Destructor Documentation</h2>
  38 <a class="anchor" id="a2f79e2f0c884db428a4e1df63b64e2c0"></a><!-- doxytag: member="pp::NetworkList::NetworkList" ref="a2f79e2f0c884db428a4e1df63b64e2c0" args="()" -->
  39 <div class="memitem">
  40 <div class="memproto">
  41 <table class="memname">
  42 <tr>
  43 <td class="memname"><a class="el" href="classpp_1_1_network_list.html#a2f79e2f0c884db428a4e1df63b64e2c0">pp::NetworkList::NetworkList</a> </td>
  44 <td>(</td>
  45 <td class="paramname"></td><td>)</td>
  46 <td></td>
  47 </tr>
  48 </table>
  49 </div>
  50 <div class="memdoc">
  51 </div>
  52 </div>
  53 <a class="anchor" id="a3d91fdce92976477be4a131fdd5c21e1"></a><!-- doxytag: member="pp::NetworkList::NetworkList" ref="a3d91fdce92976477be4a131fdd5c21e1" args="(PassRef, PP_Resource resource)" -->
  54 <div class="memitem">
  55 <div class="memproto">
  56 <table class="memname">
  57 <tr>
  58 <td class="memname"><a class="el" href="classpp_1_1_network_list.html#a2f79e2f0c884db428a4e1df63b64e2c0">pp::NetworkList::NetworkList</a> </td>
  59 <td>(</td>
  60 <td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
  61 <td class="paramname">, </td>
  62 </tr>
  63 <tr>
  64 <td class="paramkey"></td>
  65 <td></td>
  66 <td class="paramtype">PP_Resource&#160;</td>
  67 <td class="paramname"><em>resource</em>&#160;</td>
  68 </tr>
  69 <tr>
  70 <td></td>
  71 <td>)</td>
  72 <td></td><td></td>
  73 </tr>
  74 </table>
  75 </div>
  76 <div class="memdoc">
  77 </div>
  78 </div>
  79 <hr /><h2>Member Function Documentation</h2>
  80 <a class="anchor" id="a4dd51a7af2b0af6c6b962e975131c3e2"></a><!-- doxytag: member="pp::NetworkList::GetCount" ref="a4dd51a7af2b0af6c6b962e975131c3e2" args="() const " -->
  81 <div class="memitem">
  82 <div class="memproto">
  83 <table class="memname">
  84 <tr>
  85 <td class="memname">uint32_t <a class="el" href="classpp_1_1_network_list.html#a4dd51a7af2b0af6c6b962e975131c3e2">pp::NetworkList::GetCount</a> </td>
  86 <td>(</td>
  87 <td class="paramname"></td><td>)</td>
  88 <td> const</td>
  89 </tr>
  90 </table>
  91 </div>
  92 <div class="memdoc">
  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>
  94 </div>
  95 </div>
  96 <a class="anchor" id="a5a9aff0b4b03205a35ba0298fb9d383f"></a><!-- doxytag: member="pp::NetworkList::GetDisplayName" ref="a5a9aff0b4b03205a35ba0298fb9d383f" args="(uint32_t index) const " -->
  97 <div class="memitem">
  98 <div class="memproto">
  99 <table class="memname">
 100 <tr>
 101 <td class="memname">std::string <a class="el" href="classpp_1_1_network_list.html#a5a9aff0b4b03205a35ba0298fb9d383f">pp::NetworkList::GetDisplayName</a> </td>
 102 <td>(</td>
 103 <td class="paramtype">uint32_t&#160;</td>
 104 <td class="paramname"><em>index</em></td><td>)</td>
 105 <td> const</td>
 106 </tr>
 107 </table>
 108 </div>
 109 <div class="memdoc">
 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>
 111 </div>
 112 </div>
 113 <a class="anchor" id="ab2dee43ce3ac787852438210b80361d8"></a><!-- doxytag: member="pp::NetworkList::GetIpAddresses" ref="ab2dee43ce3ac787852438210b80361d8" args="(uint32_t index, std::vector&lt; NetAddress &gt; *addresses) const " -->
 114 <div class="memitem">
 115 <div class="memproto">
 116 <table class="memname">
 117 <tr>
 118 <td class="memname">int32_t <a class="el" href="classpp_1_1_network_list.html#ab2dee43ce3ac787852438210b80361d8">pp::NetworkList::GetIpAddresses</a> </td>
 119 <td>(</td>
 120 <td class="paramtype">uint32_t&#160;</td>
 121 <td class="paramname"><em>index</em>, </td>
 122 </tr>
 123 <tr>
 124 <td class="paramkey"></td>
 125 <td></td>
 126 <td class="paramtype">std::vector&lt; <a class="el" href="classpp_1_1_net_address.html">NetAddress</a> &gt; *&#160;</td>
 127 <td class="paramname"><em>addresses</em>&#160;</td>
 128 </tr>
 129 <tr>
 130 <td></td>
 131 <td>)</td>
 132 <td></td><td> const</td>
 133 </tr>
 134 </table>
 135 </div>
 136 <div class="memdoc">
 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>
 138 </div>
 139 </div>
 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">
 144 <tr>
 145 <td class="memname">uint32_t <a class="el" href="classpp_1_1_network_list.html#aebbb32231a87568e7fbe29e50e16fc58">pp::NetworkList::GetMTU</a> </td>
 146 <td>(</td>
 147 <td class="paramtype">uint32_t&#160;</td>
 148 <td class="paramname"><em>index</em></td><td>)</td>
 149 <td> const</td>
 150 </tr>
 151 </table>
 152 </div>
 153 <div class="memdoc">
 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>
 155 </div>
 156 </div>
 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">
 161 <tr>
 162 <td class="memname">std::string <a class="el" href="classpp_1_1_network_list.html#acb253aedb772fc42bdfbb5d05331d8b1">pp::NetworkList::GetName</a> </td>
 163 <td>(</td>
 164 <td class="paramtype">uint32_t&#160;</td>
 165 <td class="paramname"><em>index</em></td><td>)</td>
 166 <td> const</td>
 167 </tr>
 168 </table>
 169 </div>
 170 <div class="memdoc">
 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>
 172 </div>
 173 </div>
 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">
 178 <tr>
 179 <td class="memname">PP_NetworkList_State <a class="el" href="classpp_1_1_network_list.html#a9c4a05d5bc5d0d23aac52f59f1718e32">pp::NetworkList::GetState</a> </td>
 180 <td>(</td>
 181 <td class="paramtype">uint32_t&#160;</td>
 182 <td class="paramname"><em>index</em></td><td>)</td>
 183 <td> const</td>
 184 </tr>
 185 </table>
 186 </div>
 187 <div class="memdoc">
 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>
 189 </div>
 190 </div>
 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">
 195 <tr>
 196 <td class="memname">PP_NetworkList_Type <a class="el" href="classpp_1_1_network_list.html#a61d4a2421294e176d749115cbf5fb91b">pp::NetworkList::GetType</a> </td>
 197 <td>(</td>
 198 <td class="paramtype">uint32_t&#160;</td>
 199 <td class="paramname"><em>index</em></td><td>)</td>
 200 <td> const</td>
 201 </tr>
 202 </table>
 203 </div>
 204 <div class="memdoc">
 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>
 206 </div>
 207 </div>
 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">
 212 <tr>
 213 <td class="memname">static bool <a class="el" href="classpp_1_1_network_list.html#ab059a90bb9e2aced3f0e709853d0e61f">pp::NetworkList::IsAvailable</a> </td>
 214 <td>(</td>
 215 <td class="paramname"></td><td>)</td>
 216 <td><code> [static]</code></td>
 217 </tr>
 218 </table>
 219 </div>
 220 <div class="memdoc">
 221 <p>Returns true if the required interface is available. </p>
 222 </div>
 223 </div>
 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>
 226 </ul>
 227 </div><!-- contents -->
 228 </div>
 229 {{/partials.standard_nacl_article}}