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

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>pp::NetAddress Class Reference</h1>
   3 <div>
   4 <!-- Generated by Doxygen 1.7.6.1 -->
   5
   6
   7
   8 </div>
   9 <!--header-->
  10 <div class="contents">
  11 <!-- doxytag: class="pp::NetAddress" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader">
  12 Inheritance diagram for pp::NetAddress:</div>
  13 <div class="dyncontent">
  14 <div class="center"><img src="classpp_1_1_net_address__inherit__graph.png" border="0" usemap="#pp_1_1_net_address_inherit__map" alt="Inheritance graph" /></div>
  15 <map name="pp_1_1_net_address_inherit__map" id="pp_1_1_net_address_inherit__map">
  16 <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>
  17 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  18 <p><a href="classpp_1_1_net_address-members.html">List of all members.</a></p>
  19 <h2>
  20 Public Member Functions</h2><table class="memberdecls">
  21
  22 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_net_address.html#abe4887a33342dac27318079f07bb012d">NetAddress</a> ()</td></tr>
  23 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_net_address.html#ade2ad27841d2ccedbb202ee2c1eade14">NetAddress</a> (<a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>, PP_Resource resource)</td></tr>
  24 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_net_address.html#ae54044b80f97d259cb23b924a877ce53">NetAddress</a> (const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;instance, const PP_NetAddress_IPv4 &amp;ipv4_addr)</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_net_address.html#a76442610ed533079115a5150b7a9c98c">NetAddress</a> (const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;instance, const PP_NetAddress_IPv6 &amp;ipv6_addr)</td></tr>
  26 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_net_address.html#a8c0b559bd205387c199aba688c356298">NetAddress</a> (const <a class="el" href="classpp_1_1_net_address.html">NetAddress</a> &amp;other)</td></tr>
  27 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_net_address.html#a06b05fdecaf0b32ee74e7ebbb85a0674">~NetAddress</a> ()</td></tr>
  28 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_net_address.html">NetAddress</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_net_address.html#ab12bb266c9714d818aedc9cce7a209cf">operator=</a> (const <a class="el" href="classpp_1_1_net_address.html">NetAddress</a> &amp;other)</td></tr>
  29 <tr><td class="memItemLeft" align="right" valign="top">PP_NetAddress_Family&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_net_address.html#a271533da67cd5c6f536c6595b439bd9b">GetFamily</a> () const </td></tr>
  30 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_net_address.html#a9ff9ad19269af1c00ff02542397e92cc">DescribeAsString</a> (bool include_port) const </td></tr>
  31 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_net_address.html#a3fdbd86db0384bf334dabcefa5e46237">DescribeAsIPv4Address</a> (PP_NetAddress_IPv4 *ipv4_addr) const </td></tr>
  32 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_net_address.html#a81991279a52f8d38d9b75e1e607a81a5">DescribeAsIPv6Address</a> (PP_NetAddress_IPv6 *ipv6_addr) 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_net_address.html#a15547416a0b50b6ebd271ca421a91068">IsAvailable</a> ()</td></tr>
  36 </table>
  37 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  38 <div class="textblock"><p>The <code><a class="el" href="classpp_1_1_net_address.html" title="The NetAddress class represents a network address.">NetAddress</a></code> class represents a network address. </p>
  39 </div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
  40 <a class="anchor" id="abe4887a33342dac27318079f07bb012d"></a><!-- doxytag: member="pp::NetAddress::NetAddress" ref="abe4887a33342dac27318079f07bb012d" args="()" -->
  41 <div class="memitem">
  42 <div class="memproto">
  43 <table class="memname">
  44 <tr>
  45 <td class="memname"><a class="el" href="classpp_1_1_net_address.html#abe4887a33342dac27318079f07bb012d">pp::NetAddress::NetAddress</a> </td>
  46 <td>(</td>
  47 <td class="paramname"></td><td>)</td>
  48 <td></td>
  49 </tr>
  50 </table>
  51 </div>
  52 <div class="memdoc">
  53 <p>Default constructor for creating an <a class="el" href="classpp_1_1_resource.html#a859068e34cdc2dc0b78754c255323aa9" title="This functions determines if this resource is invalid or uninitialized.">is_null()</a> <code><a class="el" href="classpp_1_1_net_address.html" title="The NetAddress class represents a network address.">NetAddress</a></code> object. </p>
  54 </div>
  55 </div>
  56 <a class="anchor" id="ade2ad27841d2ccedbb202ee2c1eade14"></a><!-- doxytag: member="pp::NetAddress::NetAddress" ref="ade2ad27841d2ccedbb202ee2c1eade14" args="(PassRef, PP_Resource resource)" -->
  57 <div class="memitem">
  58 <div class="memproto">
  59 <table class="memname">
  60 <tr>
  61 <td class="memname"><a class="el" href="classpp_1_1_net_address.html#abe4887a33342dac27318079f07bb012d">pp::NetAddress::NetAddress</a> </td>
  62 <td>(</td>
  63 <td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
  64 <td class="paramname">, </td>
  65 </tr>
  66 <tr>
  67 <td class="paramkey"></td>
  68 <td></td>
  69 <td class="paramtype">PP_Resource&#160;</td>
  70 <td class="paramname"><em>resource</em>&#160;</td>
  71 </tr>
  72 <tr>
  73 <td></td>
  74 <td>)</td>
  75 <td></td><td></td>
  76 </tr>
  77 </table>
  78 </div>
  79 <div class="memdoc">
  80 <p>A constructor used when you have received a <code>PP_Resource</code> as a return value that has had 1 ref added for you. </p>
  81 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  82 <table class="params">
  83 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PPB_NetAddress</code> resource. </td></tr>
  84 </table>
  85 </dd>
  86 </dl>
  87 </div>
  88 </div>
  89 <a class="anchor" id="ae54044b80f97d259cb23b924a877ce53"></a><!-- doxytag: member="pp::NetAddress::NetAddress" ref="ae54044b80f97d259cb23b924a877ce53" args="(const InstanceHandle &amp;instance, const PP_NetAddress_IPv4 &amp;ipv4_addr)" -->
  90 <div class="memitem">
  91 <div class="memproto">
  92 <table class="memname">
  93 <tr>
  94 <td class="memname"><a class="el" href="classpp_1_1_net_address.html#abe4887a33342dac27318079f07bb012d">pp::NetAddress::NetAddress</a> </td>
  95 <td>(</td>
  96 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
  97 <td class="paramname"><em>instance</em>, </td>
  98 </tr>
  99 <tr>
 100 <td class="paramkey"></td>
 101 <td></td>
 102 <td class="paramtype">const PP_NetAddress_IPv4 &amp;&#160;</td>
 103 <td class="paramname"><em>ipv4_addr</em>&#160;</td>
 104 </tr>
 105 <tr>
 106 <td></td>
 107 <td>)</td>
 108 <td></td><td></td>
 109 </tr>
 110 </table>
 111 </div>
 112 <div class="memdoc">
 113 <p>A constructor used to create a <code><a class="el" href="classpp_1_1_net_address.html" title="The NetAddress class represents a network address.">NetAddress</a></code> object with the specified IPv4 address. </p>
 114 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 115 <table class="params">
 116 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance with which this resource will be associated. </td></tr>
 117 <tr><td class="paramdir">[in]</td><td class="paramname">ipv4_addr</td><td>An IPv4 address. </td></tr>
 118 </table>
 119 </dd>
 120 </dl>
 121 </div>
 122 </div>
 123 <a class="anchor" id="a76442610ed533079115a5150b7a9c98c"></a><!-- doxytag: member="pp::NetAddress::NetAddress" ref="a76442610ed533079115a5150b7a9c98c" args="(const InstanceHandle &amp;instance, const PP_NetAddress_IPv6 &amp;ipv6_addr)" -->
 124 <div class="memitem">
 125 <div class="memproto">
 126 <table class="memname">
 127 <tr>
 128 <td class="memname"><a class="el" href="classpp_1_1_net_address.html#abe4887a33342dac27318079f07bb012d">pp::NetAddress::NetAddress</a> </td>
 129 <td>(</td>
 130 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
 131 <td class="paramname"><em>instance</em>, </td>
 132 </tr>
 133 <tr>
 134 <td class="paramkey"></td>
 135 <td></td>
 136 <td class="paramtype">const PP_NetAddress_IPv6 &amp;&#160;</td>
 137 <td class="paramname"><em>ipv6_addr</em>&#160;</td>
 138 </tr>
 139 <tr>
 140 <td></td>
 141 <td>)</td>
 142 <td></td><td></td>
 143 </tr>
 144 </table>
 145 </div>
 146 <div class="memdoc">
 147 <p>A constructor used to create a <code><a class="el" href="classpp_1_1_net_address.html" title="The NetAddress class represents a network address.">NetAddress</a></code> object with the specified IPv6 address. </p>
 148 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 149 <table class="params">
 150 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance with which this resource will be associated. </td></tr>
 151 <tr><td class="paramdir">[in]</td><td class="paramname">ipv6_addr</td><td>An IPv6 address. </td></tr>
 152 </table>
 153 </dd>
 154 </dl>
 155 </div>
 156 </div>
 157 <a class="anchor" id="a8c0b559bd205387c199aba688c356298"></a><!-- doxytag: member="pp::NetAddress::NetAddress" ref="a8c0b559bd205387c199aba688c356298" args="(const NetAddress &amp;other)" -->
 158 <div class="memitem">
 159 <div class="memproto">
 160 <table class="memname">
 161 <tr>
 162 <td class="memname"><a class="el" href="classpp_1_1_net_address.html#abe4887a33342dac27318079f07bb012d">pp::NetAddress::NetAddress</a> </td>
 163 <td>(</td>
 164 <td class="paramtype">const <a class="el" href="classpp_1_1_net_address.html">NetAddress</a> &amp;&#160;</td>
 165 <td class="paramname"><em>other</em></td><td>)</td>
 166 <td></td>
 167 </tr>
 168 </table>
 169 </div>
 170 <div class="memdoc">
 171 <p>The copy constructor for <code><a class="el" href="classpp_1_1_net_address.html" title="The NetAddress class represents a network address.">NetAddress</a></code>. </p>
 172 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 173 <table class="params">
 174 <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>A reference to another <code><a class="el" href="classpp_1_1_net_address.html" title="The NetAddress class represents a network address.">NetAddress</a></code>. </td></tr>
 175 </table>
 176 </dd>
 177 </dl>
 178 </div>
 179 </div>
 180 <a class="anchor" id="a06b05fdecaf0b32ee74e7ebbb85a0674"></a><!-- doxytag: member="pp::NetAddress::~NetAddress" ref="a06b05fdecaf0b32ee74e7ebbb85a0674" args="()" -->
 181 <div class="memitem">
 182 <div class="memproto">
 183 <table class="memname">
 184 <tr>
 185 <td class="memname">virtual <a class="el" href="classpp_1_1_net_address.html#a06b05fdecaf0b32ee74e7ebbb85a0674">pp::NetAddress::~NetAddress</a> </td>
 186 <td>(</td>
 187 <td class="paramname"></td><td>)</td>
 188 <td><code> [virtual]</code></td>
 189 </tr>
 190 </table>
 191 </div>
 192 <div class="memdoc">
 193 <p>The destructor. </p>
 194 </div>
 195 </div>
 196 <hr /><h2>Member Function Documentation</h2>
 197 <a class="anchor" id="a3fdbd86db0384bf334dabcefa5e46237"></a><!-- doxytag: member="pp::NetAddress::DescribeAsIPv4Address" ref="a3fdbd86db0384bf334dabcefa5e46237" args="(PP_NetAddress_IPv4 *ipv4_addr) const " -->
 198 <div class="memitem">
 199 <div class="memproto">
 200 <table class="memname">
 201 <tr>
 202 <td class="memname">bool <a class="el" href="classpp_1_1_net_address.html#a3fdbd86db0384bf334dabcefa5e46237">pp::NetAddress::DescribeAsIPv4Address</a> </td>
 203 <td>(</td>
 204 <td class="paramtype">PP_NetAddress_IPv4 *&#160;</td>
 205 <td class="paramname"><em>ipv4_addr</em></td><td>)</td>
 206 <td> const</td>
 207 </tr>
 208 </table>
 209 </div>
 210 <div class="memdoc">
 211 <p>Fills a <code>PP_NetAddress_IPv4</code> structure if the network address is of <code>PP_NETADDRESS_FAMILY_IPV4</code> address family. </p>
 212 <p>Note that passing a network address of <code>PP_NETADDRESS_FAMILY_IPV6</code> address family will fail even if the address is an IPv4-mapped IPv6 address.</p>
 213 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 214 <table class="params">
 215 <tr><td class="paramdir">[out]</td><td class="paramname">ipv4_addr</td><td>A <code>PP_NetAddress_IPv4</code> structure to store the result.</td></tr>
 216 </table>
 217 </dd>
 218 </dl>
 219 <dl class="return"><dt><b>Returns:</b></dt><dd>A boolean value indicating whether the operation succeeded. </dd></dl>
 220 </div>
 221 </div>
 222 <a class="anchor" id="a81991279a52f8d38d9b75e1e607a81a5"></a><!-- doxytag: member="pp::NetAddress::DescribeAsIPv6Address" ref="a81991279a52f8d38d9b75e1e607a81a5" args="(PP_NetAddress_IPv6 *ipv6_addr) const " -->
 223 <div class="memitem">
 224 <div class="memproto">
 225 <table class="memname">
 226 <tr>
 227 <td class="memname">bool <a class="el" href="classpp_1_1_net_address.html#a81991279a52f8d38d9b75e1e607a81a5">pp::NetAddress::DescribeAsIPv6Address</a> </td>
 228 <td>(</td>
 229 <td class="paramtype">PP_NetAddress_IPv6 *&#160;</td>
 230 <td class="paramname"><em>ipv6_addr</em></td><td>)</td>
 231 <td> const</td>
 232 </tr>
 233 </table>
 234 </div>
 235 <div class="memdoc">
 236 <p>Fills a <code>PP_NetAddress_IPv6</code> structure if the network address is of <code>PP_NETADDRESS_FAMILY_IPV6</code> address family. </p>
 237 <p>Note that passing a network address of <code>PP_NETADDRESS_FAMILY_IPV4</code> address family will fail - this method doesn't map it to an IPv6 address.</p>
 238 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 239 <table class="params">
 240 <tr><td class="paramdir">[out]</td><td class="paramname">ipv6_addr</td><td>A <code>PP_NetAddress_IPv6</code> structure to store the result.</td></tr>
 241 </table>
 242 </dd>
 243 </dl>
 244 <dl class="return"><dt><b>Returns:</b></dt><dd>A boolean value indicating whether the operation succeeded. </dd></dl>
 245 </div>
 246 </div>
 247 <a class="anchor" id="a9ff9ad19269af1c00ff02542397e92cc"></a><!-- doxytag: member="pp::NetAddress::DescribeAsString" ref="a9ff9ad19269af1c00ff02542397e92cc" args="(bool include_port) const " -->
 248 <div class="memitem">
 249 <div class="memproto">
 250 <table class="memname">
 251 <tr>
 252 <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_net_address.html#a9ff9ad19269af1c00ff02542397e92cc">pp::NetAddress::DescribeAsString</a> </td>
 253 <td>(</td>
 254 <td class="paramtype">bool&#160;</td>
 255 <td class="paramname"><em>include_port</em></td><td>)</td>
 256 <td> const</td>
 257 </tr>
 258 </table>
 259 </div>
 260 <div class="memdoc">
 261 <p>Returns a human-readable description of the network address. </p>
 262 <p>The description is in the form of host [ ":" port ] and conforms to <a href="http://tools.ietf.org/html/rfc3986#section-3.2">http://tools.ietf.org/html/rfc3986#section-3.2</a> for IPv4 and IPv6 addresses (e.g., "192.168.0.1", "192.168.0.1:99", or "[::1]:80").</p>
 263 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 264 <table class="params">
 265 <tr><td class="paramdir">[in]</td><td class="paramname">include_port</td><td>Whether to include the port number in the description.</td></tr>
 266 </table>
 267 </dd>
 268 </dl>
 269 <dl class="return"><dt><b>Returns:</b></dt><dd>A string <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> on success; an undefined <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> on failure. </dd></dl>
 270 </div>
 271 </div>
 272 <a class="anchor" id="a271533da67cd5c6f536c6595b439bd9b"></a><!-- doxytag: member="pp::NetAddress::GetFamily" ref="a271533da67cd5c6f536c6595b439bd9b" args="() const " -->
 273 <div class="memitem">
 274 <div class="memproto">
 275 <table class="memname">
 276 <tr>
 277 <td class="memname">PP_NetAddress_Family <a class="el" href="classpp_1_1_net_address.html#a271533da67cd5c6f536c6595b439bd9b">pp::NetAddress::GetFamily</a> </td>
 278 <td>(</td>
 279 <td class="paramname"></td><td>)</td>
 280 <td> const</td>
 281 </tr>
 282 </table>
 283 </div>
 284 <div class="memdoc">
 285 <p>Gets the address family. </p>
 286 <dl class="return"><dt><b>Returns:</b></dt><dd>The address family on success; <code>PP_NETADDRESS_FAMILY_UNSPECIFIED</code> on failure. </dd></dl>
 287 </div>
 288 </div>
 289 <a class="anchor" id="a15547416a0b50b6ebd271ca421a91068"></a><!-- doxytag: member="pp::NetAddress::IsAvailable" ref="a15547416a0b50b6ebd271ca421a91068" args="()" -->
 290 <div class="memitem">
 291 <div class="memproto">
 292 <table class="memname">
 293 <tr>
 294 <td class="memname">static bool <a class="el" href="classpp_1_1_net_address.html#a15547416a0b50b6ebd271ca421a91068">pp::NetAddress::IsAvailable</a> </td>
 295 <td>(</td>
 296 <td class="paramname"></td><td>)</td>
 297 <td><code> [static]</code></td>
 298 </tr>
 299 </table>
 300 </div>
 301 <div class="memdoc">
 302 <p>Static function for determining whether the browser supports the <code>PPB_NetAddress</code> interface. </p>
 303 <dl class="return"><dt><b>Returns:</b></dt><dd>true if the interface is available, false otherwise. </dd></dl>
 304 </div>
 305 </div>
 306 <a class="anchor" id="ab12bb266c9714d818aedc9cce7a209cf"></a><!-- doxytag: member="pp::NetAddress::operator=" ref="ab12bb266c9714d818aedc9cce7a209cf" args="(const NetAddress &amp;other)" -->
 307 <div class="memitem">
 308 <div class="memproto">
 309 <table class="memname">
 310 <tr>
 311 <td class="memname"><a class="el" href="classpp_1_1_net_address.html">NetAddress</a>&amp; pp::NetAddress::operator= </td>
 312 <td>(</td>
 313 <td class="paramtype">const <a class="el" href="classpp_1_1_net_address.html">NetAddress</a> &amp;&#160;</td>
 314 <td class="paramname"><em>other</em></td><td>)</td>
 315 <td></td>
 316 </tr>
 317 </table>
 318 </div>
 319 <div class="memdoc">
 320 <p>The assignment operator for <code><a class="el" href="classpp_1_1_net_address.html" title="The NetAddress class represents a network address.">NetAddress</a></code>. </p>
 321 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 322 <table class="params">
 323 <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>A reference to another <code><a class="el" href="classpp_1_1_net_address.html" title="The NetAddress class represents a network address.">NetAddress</a></code>.</td></tr>
 324 </table>
 325 </dd>
 326 </dl>
 327 <dl class="return"><dt><b>Returns:</b></dt><dd>A reference to this <code><a class="el" href="classpp_1_1_net_address.html" title="The NetAddress class represents a network address.">NetAddress</a></code> object. </dd></dl>
 328 </div>
 329 </div>
 330 <hr />The documentation for this class was generated from the following file:<ul>
 331 <li><a class="el" href="net__address_8h.html">net_address.h</a></li>
 332 </ul>
 333 </div><!-- contents -->
 334 {{/partials.standard_nacl_article}}