src/native_client_sdk/doc_generated/pepper_beta/cpp/classpp_1_1_network_proxy.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>pp::NetworkProxy 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::NetworkProxy" -->
  14 <p><a href="classpp_1_1_network_proxy-members.html">List of all members.</a></p>
  15 <h2>
  16 Static Public Member Functions</h2><table class="memberdecls">
  17
  18 <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_proxy.html#a864362732834af39e12f699ff5e1888d">IsAvailable</a> ()</td></tr>
  19 <tr><td class="memItemLeft" align="right" valign="top">static int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_network_proxy.html#a03ae12454a920710272c15431039b6fd">GetProxyForURL</a> (const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;instance, const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;url, const <a class="el" href="classpp_1_1_completion_callback_with_output.html">pp::CompletionCallbackWithOutput</a>&lt; <a class="el" href="classpp_1_1_var.html">Var</a> &gt; &amp;callback)</td></tr>
  20 </table>
  21 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  22 <div class="textblock"><p>This class provides a way to determine the appropriate proxy settings for for a given URL. </p>
  23 <p>Permissions: Apps permission <code>socket</code> with subrule <code>resolve-proxy</code> is required for using this API. For more details about network communication permissions, please see: <a href="http://developer.chrome.com/apps/app_network.html">http://developer.chrome.com/apps/app_network.html</a> </p>
  24 </div><hr /><h2>Member Function Documentation</h2>
  25 <a class="anchor" id="a03ae12454a920710272c15431039b6fd"></a><!-- doxytag: member="pp::NetworkProxy::GetProxyForURL" ref="a03ae12454a920710272c15431039b6fd" args="(const InstanceHandle &amp;instance, const Var &amp;url, const pp::CompletionCallbackWithOutput&lt; Var &gt; &amp;callback)" -->
  26 <div class="memitem">
  27 <div class="memproto">
  28 <table class="memname">
  29 <tr>
  30 <td class="memname">static int32_t <a class="el" href="classpp_1_1_network_proxy.html#a03ae12454a920710272c15431039b6fd">pp::NetworkProxy::GetProxyForURL</a> </td>
  31 <td>(</td>
  32 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
  33 <td class="paramname"><em>instance</em>, </td>
  34 </tr>
  35 <tr>
  36 <td class="paramkey"></td>
  37 <td></td>
  38 <td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
  39 <td class="paramname"><em>url</em>, </td>
  40 </tr>
  41 <tr>
  42 <td class="paramkey"></td>
  43 <td></td>
  44 <td class="paramtype">const <a class="el" href="classpp_1_1_completion_callback_with_output.html">pp::CompletionCallbackWithOutput</a>&lt; <a class="el" href="classpp_1_1_var.html">Var</a> &gt; &amp;&#160;</td>
  45 <td class="paramname"><em>callback</em>&#160;</td>
  46 </tr>
  47 <tr>
  48 <td></td>
  49 <td>)</td>
  50 <td></td><td><code> [static]</code></td>
  51 </tr>
  52 </table>
  53 </div>
  54 <div class="memdoc">
  55 <p>Retrieves the proxy that will be used for the given URL. </p>
  56 <p>The result will be a string in PAC format. For more details about PAC format, please see <a href="http://en.wikipedia.org/wiki/Proxy_auto-config">http://en.wikipedia.org/wiki/Proxy_auto-config</a></p>
  57 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  58 <table class="params">
  59 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>An <code><a class="el" href="classpp_1_1_instance_handle.html" title="An instance handle identifies an instance in a constructor for a resource.">InstanceHandle</a></code> identifying one instance of a module.</td></tr>
  60 <tr><td class="paramdir">[in]</td><td class="paramname">url</td><td>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> containing a URL.</td></tr>
  61 <tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>A <code><a class="el" href="classpp_1_1_completion_callback_with_output.html" title="A CompletionCallbackWithOutput defines a completion callback that additionally stores a pointer to so...">CompletionCallbackWithOutput</a></code> to be called upon completion. It will be passed 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> containing the appropriate PAC string for <code>url</code>.</td></tr>
  62 </table>
  63 </dd>
  64 </dl>
  65 <dl class="return"><dt><b>Returns:</b></dt><dd>An int32_t containing an error code from <code>pp_errors.h</code>. </dd></dl>
  66 </div>
  67 </div>
  68 <a class="anchor" id="a864362732834af39e12f699ff5e1888d"></a><!-- doxytag: member="pp::NetworkProxy::IsAvailable" ref="a864362732834af39e12f699ff5e1888d" args="()" -->
  69 <div class="memitem">
  70 <div class="memproto">
  71 <table class="memname">
  72 <tr>
  73 <td class="memname">static bool <a class="el" href="classpp_1_1_network_proxy.html#a864362732834af39e12f699ff5e1888d">pp::NetworkProxy::IsAvailable</a> </td>
  74 <td>(</td>
  75 <td class="paramname"></td><td>)</td>
  76 <td><code> [static]</code></td>
  77 </tr>
  78 </table>
  79 </div>
  80 <div class="memdoc">
  81 <p>Returns true if the browser supports this API, false otherwise. </p>
  82 </div>
  83 </div>
  84 <hr />The documentation for this class was generated from the following file:<ul>
  85 <li><a class="el" href="network__proxy_8h.html">network_proxy.h</a></li>
  86 </ul>
  87 </div><!-- contents -->
  88 </div>
  89 {{/partials.standard_nacl_article}}