Home | History | Annotate | Download | only in c
      1 {{+bindTo:partials.standard_nacl_api}}
      2 <h1>PPB_NetworkList Struct 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 </div>
     10 <!--header-->
     11 <div class="contents">
     12 <!-- doxytag: class="PPB_NetworkList" --><h2>
     13 Data Fields</h2><table class="memberdecls">
     14 
     15 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___network_list__1__0.html#ac8ab7ecff9909962a839d10f6e571954">IsNetworkList</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td></tr>
     16 <tr><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___network_list__1__0.html#a9240190a389e0068088e604704b153de">GetCount</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td></tr>
     17 <tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___network_list__1__0.html#a59fdecb98a8a25e7bf257d7106d74bae">GetName</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td></tr>
     18 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga1c967cb753eb468493b3bf72e6733983">PP_NetworkList_Type</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___network_list__1__0.html#ae272fca616d11a27ea09c06a0659e0cc">GetType</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td></tr>
     19 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga9188881b5d3346626db0ea8e6aaecf1f">PP_NetworkList_State</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___network_list__1__0.html#a2d9043e33c1c09f9eeea4b49be1629b1">GetState</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td></tr>
     20 <tr><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___network_list__1__0.html#a0dcbe767aed13b3b3492343eb0aa9756">GetIpAddresses</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index, struct <a class="el" href="struct_p_p___array_output.html">PP_ArrayOutput</a> output)</td></tr>
     21 <tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___network_list__1__0.html#a54e77303af12f276181b32ff94820bd8">GetDisplayName</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td></tr>
     22 <tr><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___network_list__1__0.html#a19ecaf7b4627fe7f5d2b0edf02232e8f">GetMTU</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td></tr>
     23 </table>
     24 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
     25 <div class="textblock"><p>The <code>PPB_NetworkList</code> is used to represent a list of network interfaces and their configuration. </p>
     26 <p>The content of the list is immutable. The current networks configuration can be received using the <code>PPB_NetworkMonitor</code> interface. </p>
     27 </div><hr /><h2>Field Documentation</h2>
     28 <a class="anchor" id="a9240190a389e0068088e604704b153de"></a><!-- doxytag: member="PPB_NetworkList::GetCount" ref="a9240190a389e0068088e604704b153de" args=")(PP_Resource resource)" -->
     29 <div class="memitem">
     30 <div class="memproto">
     31 <table class="memname">
     32 <tr>
     33 <td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___network_list__1__0.html#a9240190a389e0068088e604704b153de">PPB_NetworkList::GetCount</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td>
     34 </tr>
     35 </table>
     36 </div>
     37 <div class="memdoc">
     38 <p>Gets number of interfaces in the list. </p>
     39 <dl class="params"><dt><b>Parameters:</b></dt><dd>
     40 <table class="params">
     41 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list.</td></tr>
     42 </table>
     43 </dd>
     44 </dl>
     45 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns number of available network interfaces or 0 if the list has never been updated. </dd></dl>
     46 </div>
     47 </div>
     48 <a class="anchor" id="a54e77303af12f276181b32ff94820bd8"></a><!-- doxytag: member="PPB_NetworkList::GetDisplayName" ref="a54e77303af12f276181b32ff94820bd8" args=")(PP_Resource resource, uint32_t index)" -->
     49 <div class="memitem">
     50 <div class="memproto">
     51 <table class="memname">
     52 <tr>
     53 <td class="memname">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(* <a class="el" href="struct_p_p_b___network_list__1__0.html#a54e77303af12f276181b32ff94820bd8">PPB_NetworkList::GetDisplayName</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)<code> [read]</code></td>
     54 </tr>
     55 </table>
     56 </div>
     57 <div class="memdoc">
     58 <p>Gets display name of a network interface. </p>
     59 <dl class="params"><dt><b>Parameters:</b></dt><dd>
     60 <table class="params">
     61 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list. </td></tr>
     62 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the network interface.</td></tr>
     63 </table>
     64 </dd>
     65 </dl>
     66 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns display name for the network interface with the specified <code>index</code>. </dd></dl>
     67 </div>
     68 </div>
     69 <a class="anchor" id="a0dcbe767aed13b3b3492343eb0aa9756"></a><!-- doxytag: member="PPB_NetworkList::GetIpAddresses" ref="a0dcbe767aed13b3b3492343eb0aa9756" args=")(PP_Resource resource, uint32_t index, struct PP_ArrayOutput output)" -->
     70 <div class="memitem">
     71 <div class="memproto">
     72 <table class="memname">
     73 <tr>
     74 <td class="memname">int32_t(* <a class="el" href="struct_p_p_b___network_list__1__0.html#a0dcbe767aed13b3b3492343eb0aa9756">PPB_NetworkList::GetIpAddresses</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index, struct <a class="el" href="struct_p_p___array_output.html">PP_ArrayOutput</a> output)</td>
     75 </tr>
     76 </table>
     77 </div>
     78 <div class="memdoc">
     79 <p>Gets list of IP addresses for a network interface. </p>
     80 <dl class="params"><dt><b>Parameters:</b></dt><dd>
     81 <table class="params">
     82 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list. </td></tr>
     83 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the network interface. </td></tr>
     84 <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>An output array which will receive <code>PPB_NetAddress</code> resources on success. Please note that the ref count of those resources has already been increased by 1 for the caller.</td></tr>
     85 </table>
     86 </dd>
     87 </dl>
     88 <dl class="return"><dt><b>Returns:</b></dt><dd>An error code from <code><a class="el" href="pp__errors_8h.html" title="This file defines an enumeration of all PPAPI error codes.">pp_errors.h</a></code>. </dd></dl>
     89 </div>
     90 </div>
     91 <a class="anchor" id="a19ecaf7b4627fe7f5d2b0edf02232e8f"></a><!-- doxytag: member="PPB_NetworkList::GetMTU" ref="a19ecaf7b4627fe7f5d2b0edf02232e8f" args=")(PP_Resource resource, uint32_t index)" -->
     92 <div class="memitem">
     93 <div class="memproto">
     94 <table class="memname">
     95 <tr>
     96 <td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___network_list__1__0.html#a19ecaf7b4627fe7f5d2b0edf02232e8f">PPB_NetworkList::GetMTU</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td>
     97 </tr>
     98 </table>
     99 </div>
    100 <div class="memdoc">
    101 <p>Gets MTU (Maximum Transmission Unit) of a network interface. </p>
    102 <dl class="params"><dt><b>Parameters:</b></dt><dd>
    103 <table class="params">
    104 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list. </td></tr>
    105 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the network interface.</td></tr>
    106 </table>
    107 </dd>
    108 </dl>
    109 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns MTU for the network interface with the specified <code>index</code> or 0 if MTU is unknown. </dd></dl>
    110 </div>
    111 </div>
    112 <a class="anchor" id="a59fdecb98a8a25e7bf257d7106d74bae"></a><!-- doxytag: member="PPB_NetworkList::GetName" ref="a59fdecb98a8a25e7bf257d7106d74bae" args=")(PP_Resource resource, uint32_t index)" -->
    113 <div class="memitem">
    114 <div class="memproto">
    115 <table class="memname">
    116 <tr>
    117 <td class="memname">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(* <a class="el" href="struct_p_p_b___network_list__1__0.html#a59fdecb98a8a25e7bf257d7106d74bae">PPB_NetworkList::GetName</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)<code> [read]</code></td>
    118 </tr>
    119 </table>
    120 </div>
    121 <div class="memdoc">
    122 <p>Gets name of a network interface. </p>
    123 <dl class="params"><dt><b>Parameters:</b></dt><dd>
    124 <table class="params">
    125 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list. </td></tr>
    126 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the network interface.</td></tr>
    127 </table>
    128 </dd>
    129 </dl>
    130 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns name for the network interface with the specified <code>index</code>. </dd></dl>
    131 </div>
    132 </div>
    133 <a class="anchor" id="a2d9043e33c1c09f9eeea4b49be1629b1"></a><!-- doxytag: member="PPB_NetworkList::GetState" ref="a2d9043e33c1c09f9eeea4b49be1629b1" args=")(PP_Resource resource, uint32_t index)" -->
    134 <div class="memitem">
    135 <div class="memproto">
    136 <table class="memname">
    137 <tr>
    138 <td class="memname"><a class="el" href="group___enums.html#ga9188881b5d3346626db0ea8e6aaecf1f">PP_NetworkList_State</a>(* <a class="el" href="struct_p_p_b___network_list__1__0.html#a2d9043e33c1c09f9eeea4b49be1629b1">PPB_NetworkList::GetState</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td>
    139 </tr>
    140 </table>
    141 </div>
    142 <div class="memdoc">
    143 <p>Gets state of a network interface. </p>
    144 <dl class="params"><dt><b>Parameters:</b></dt><dd>
    145 <table class="params">
    146 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list. </td></tr>
    147 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the network interface.</td></tr>
    148 </table>
    149 </dd>
    150 </dl>
    151 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns current state of the network interface with the specified <code>index</code>. </dd></dl>
    152 </div>
    153 </div>
    154 <a class="anchor" id="ae272fca616d11a27ea09c06a0659e0cc"></a><!-- doxytag: member="PPB_NetworkList::GetType" ref="ae272fca616d11a27ea09c06a0659e0cc" args=")(PP_Resource resource, uint32_t index)" -->
    155 <div class="memitem">
    156 <div class="memproto">
    157 <table class="memname">
    158 <tr>
    159 <td class="memname"><a class="el" href="group___enums.html#ga1c967cb753eb468493b3bf72e6733983">PP_NetworkList_Type</a>(* <a class="el" href="struct_p_p_b___network_list__1__0.html#ae272fca616d11a27ea09c06a0659e0cc">PPB_NetworkList::GetType</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource, uint32_t index)</td>
    160 </tr>
    161 </table>
    162 </div>
    163 <div class="memdoc">
    164 <p>Gets type of a network interface. </p>
    165 <dl class="params"><dt><b>Parameters:</b></dt><dd>
    166 <table class="params">
    167 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a network list. </td></tr>
    168 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the network interface.</td></tr>
    169 </table>
    170 </dd>
    171 </dl>
    172 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns type of the network interface with the specified <code>index</code>. </dd></dl>
    173 </div>
    174 </div>
    175 <a class="anchor" id="ac8ab7ecff9909962a839d10f6e571954"></a><!-- doxytag: member="PPB_NetworkList::IsNetworkList" ref="ac8ab7ecff9909962a839d10f6e571954" args=")(PP_Resource resource)" -->
    176 <div class="memitem">
    177 <div class="memproto">
    178 <table class="memname">
    179 <tr>
    180 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___network_list__1__0.html#ac8ab7ecff9909962a839d10f6e571954">PPB_NetworkList::IsNetworkList</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td>
    181 </tr>
    182 </table>
    183 </div>
    184 <div class="memdoc">
    185 <p>Determines if the specified <code>resource</code> is a <code>NetworkList</code> object. </p>
    186 <dl class="params"><dt><b>Parameters:</b></dt><dd>
    187 <table class="params">
    188 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> resource.</td></tr>
    189 </table>
    190 </dd>
    191 </dl>
    192 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns <code>PP_TRUE</code> if <code>resource</code> is a <code>PPB_NetworkList</code>, <code>PP_FALSE</code> otherwise. </dd></dl>
    193 </div>
    194 </div>
    195 <hr />The documentation for this struct was generated from the following file:<ul>
    196 <li><a class="el" href="ppb__network__list_8h.html">ppb_network_list.h</a></li>
    197 </ul>
    198 </div><!-- contents -->
    199 </div>
    200 {{/partials.standard_nacl_api}}
    201