src/native_client_sdk/doc_generated/pepper_beta/c/struct_p_p_b___host_resolver__1__0.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>PPB_HostResolver Struct Reference</h1>
   3 <div>
   4 <!-- Generated by Doxygen 1.7.6.1 -->
   5
   6
   7 </div>
   8 <!--header-->
   9 <div class="contents">
  10 <!-- doxytag: class="PPB_HostResolver" --><h2>
  11 Data Fields</h2><table class="memberdecls">
  12
  13 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___host_resolver__1__0.html#a7dfb4977c9bb0b3efb8016393e1adcc1">Create</a> )(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance)</td></tr>
  14 <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___host_resolver__1__0.html#a26202fbec754f45ec43e1b7479f07365">IsHostResolver</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td></tr>
  15 <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___host_resolver__1__0.html#a006c54c355fc4258fc1c9e75e8861dea">Resolve</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> host_resolver, const char *host, uint16_t port, const struct <a class="el" href="struct_p_p___host_resolver___hint.html">PP_HostResolver_Hint</a> *hint, struct <a class="el" href="struct_p_p___completion_callback.html">PP_CompletionCallback</a> callback)</td></tr>
  16 <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___host_resolver__1__0.html#a5edb535ad2bdc3db835ef7ec57f98f49">GetCanonicalName</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> host_resolver)</td></tr>
  17 <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___host_resolver__1__0.html#afe9dc8c673c2a12331eceaf60ecba911">GetNetAddressCount</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> host_resolver)</td></tr>
  18 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___host_resolver__1__0.html#a7202ffb6c7b6d02da4ece9e748aaa886">GetNetAddress</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> host_resolver, uint32_t index)</td></tr>
  19 </table>
  20 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  21 <div class="textblock"><p>The <code>PPB_HostResolver</code> interface supports host name resolution. </p>
  22 <p>Permissions: In order to run <code><a class="el" href="struct_p_p_b___host_resolver__1__0.html#a006c54c355fc4258fc1c9e75e8861dea" title="Requests resolution of a host name.">Resolve()</a></code>, apps permission <code>socket</code> with subrule <code>resolve-host</code> is required. 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>
  23 </div><hr /><h2>Field Documentation</h2>
  24 <a class="anchor" id="a7dfb4977c9bb0b3efb8016393e1adcc1"></a><!-- doxytag: member="PPB_HostResolver::Create" ref="a7dfb4977c9bb0b3efb8016393e1adcc1" args=")(PP_Instance instance)" -->
  25 <div class="memitem">
  26 <div class="memproto">
  27 <table class="memname">
  28 <tr>
  29 <td class="memname"><a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a>(* <a class="el" href="struct_p_p_b___host_resolver__1__0.html#a7dfb4977c9bb0b3efb8016393e1adcc1">PPB_HostResolver::Create</a>)(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance)</td>
  30 </tr>
  31 </table>
  32 </div>
  33 <div class="memdoc">
  34 <p>Creates a host resolver resource. </p>
  35 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  36 <table class="params">
  37 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>A <code>PP_Instance</code> identifying one instance of a module.</td></tr>
  38 </table>
  39 </dd>
  40 </dl>
  41 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_Resource</code> corresponding to a host reslover or 0 on failure. </dd></dl>
  42 </div>
  43 </div>
  44 <a class="anchor" id="a5edb535ad2bdc3db835ef7ec57f98f49"></a><!-- doxytag: member="PPB_HostResolver::GetCanonicalName" ref="a5edb535ad2bdc3db835ef7ec57f98f49" args=")(PP_Resource host_resolver)" -->
  45 <div class="memitem">
  46 <div class="memproto">
  47 <table class="memname">
  48 <tr>
  49 <td class="memname">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(* <a class="el" href="struct_p_p_b___host_resolver__1__0.html#a5edb535ad2bdc3db835ef7ec57f98f49">PPB_HostResolver::GetCanonicalName</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> host_resolver)<code> [read]</code></td>
  50 </tr>
  51 </table>
  52 </div>
  53 <div class="memdoc">
  54 <p>Gets the canonical name of the host. </p>
  55 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  56 <table class="params">
  57 <tr><td class="paramdir">[in]</td><td class="paramname">host_resolver</td><td>A <code>PP_Resource</code> corresponding to a host resolver.</td></tr>
  58 </table>
  59 </dd>
  60 </dl>
  61 <dl class="return"><dt><b>Returns:</b></dt><dd>A string <code><a class="el" href="struct_p_p___var.html" title="The PP_VAR struct is a variant data type and can contain any value of one of the types named in the P...">PP_Var</a></code> on success, which is an empty string if <code>PP_HOSTRESOLVER_FLAG_CANONNAME</code> is not set in the hint flags when calling <code><a class="el" href="struct_p_p_b___host_resolver__1__0.html#a006c54c355fc4258fc1c9e75e8861dea" title="Requests resolution of a host name.">Resolve()</a></code>; an undefined <code><a class="el" href="struct_p_p___var.html" title="The PP_VAR struct is a variant data type and can contain any value of one of the types named in the P...">PP_Var</a></code> if there is a pending <code><a class="el" href="struct_p_p_b___host_resolver__1__0.html#a006c54c355fc4258fc1c9e75e8861dea" title="Requests resolution of a host name.">Resolve()</a></code> call or the previous <code><a class="el" href="struct_p_p_b___host_resolver__1__0.html#a006c54c355fc4258fc1c9e75e8861dea" title="Requests resolution of a host name.">Resolve()</a></code> call failed. </dd></dl>
  62 </div>
  63 </div>
  64 <a class="anchor" id="a7202ffb6c7b6d02da4ece9e748aaa886"></a><!-- doxytag: member="PPB_HostResolver::GetNetAddress" ref="a7202ffb6c7b6d02da4ece9e748aaa886" args=")(PP_Resource host_resolver, uint32_t index)" -->
  65 <div class="memitem">
  66 <div class="memproto">
  67 <table class="memname">
  68 <tr>
  69 <td class="memname"><a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a>(* <a class="el" href="struct_p_p_b___host_resolver__1__0.html#a7202ffb6c7b6d02da4ece9e748aaa886">PPB_HostResolver::GetNetAddress</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> host_resolver, uint32_t index)</td>
  70 </tr>
  71 </table>
  72 </div>
  73 <div class="memdoc">
  74 <p>Gets a network address. </p>
  75 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  76 <table class="params">
  77 <tr><td class="paramdir">[in]</td><td class="paramname">host_resolver</td><td>A <code>PP_Resource</code> corresponding to a host resolver. </td></tr>
  78 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>An index indicating which address to return.</td></tr>
  79 </table>
  80 </dd>
  81 </dl>
  82 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PPB_NetAddress</code> resource on success; 0 if there is a pending <code><a class="el" href="struct_p_p_b___host_resolver__1__0.html#a006c54c355fc4258fc1c9e75e8861dea" title="Requests resolution of a host name.">Resolve()</a></code> call or the previous <code><a class="el" href="struct_p_p_b___host_resolver__1__0.html#a006c54c355fc4258fc1c9e75e8861dea" title="Requests resolution of a host name.">Resolve()</a></code> call failed, or the specified index is out of range. </dd></dl>
  83 </div>
  84 </div>
  85 <a class="anchor" id="afe9dc8c673c2a12331eceaf60ecba911"></a><!-- doxytag: member="PPB_HostResolver::GetNetAddressCount" ref="afe9dc8c673c2a12331eceaf60ecba911" args=")(PP_Resource host_resolver)" -->
  86 <div class="memitem">
  87 <div class="memproto">
  88 <table class="memname">
  89 <tr>
  90 <td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___host_resolver__1__0.html#afe9dc8c673c2a12331eceaf60ecba911">PPB_HostResolver::GetNetAddressCount</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> host_resolver)</td>
  91 </tr>
  92 </table>
  93 </div>
  94 <div class="memdoc">
  95 <p>Gets the number of network addresses. </p>
  96 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  97 <table class="params">
  98 <tr><td class="paramdir">[in]</td><td class="paramname">host_resolver</td><td>A <code>PP_Resource</code> corresponding to a host resolver.</td></tr>
  99 </table>
 100 </dd>
 101 </dl>
 102 <dl class="return"><dt><b>Returns:</b></dt><dd>The number of available network addresses on success; 0 if there is a pending <code><a class="el" href="struct_p_p_b___host_resolver__1__0.html#a006c54c355fc4258fc1c9e75e8861dea" title="Requests resolution of a host name.">Resolve()</a></code> call or the previous <code><a class="el" href="struct_p_p_b___host_resolver__1__0.html#a006c54c355fc4258fc1c9e75e8861dea" title="Requests resolution of a host name.">Resolve()</a></code> call failed. </dd></dl>
 103 </div>
 104 </div>
 105 <a class="anchor" id="a26202fbec754f45ec43e1b7479f07365"></a><!-- doxytag: member="PPB_HostResolver::IsHostResolver" ref="a26202fbec754f45ec43e1b7479f07365" args=")(PP_Resource resource)" -->
 106 <div class="memitem">
 107 <div class="memproto">
 108 <table class="memname">
 109 <tr>
 110 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___host_resolver__1__0.html#a26202fbec754f45ec43e1b7479f07365">PPB_HostResolver::IsHostResolver</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td>
 111 </tr>
 112 </table>
 113 </div>
 114 <div class="memdoc">
 115 <p>Determines if a given resource is a host resolver. </p>
 116 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 117 <table class="params">
 118 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> to check.</td></tr>
 119 </table>
 120 </dd>
 121 </dl>
 122 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_TRUE</code> if the input is a <code>PPB_HostResolver</code> resource; <code>PP_FALSE</code> otherwise. </dd></dl>
 123 </div>
 124 </div>
 125 <a class="anchor" id="a006c54c355fc4258fc1c9e75e8861dea"></a><!-- doxytag: member="PPB_HostResolver::Resolve" ref="a006c54c355fc4258fc1c9e75e8861dea" args=")(PP_Resource host_resolver, const char *host, uint16_t port, const struct PP_HostResolver_Hint *hint, struct PP_CompletionCallback callback)" -->
 126 <div class="memitem">
 127 <div class="memproto">
 128 <table class="memname">
 129 <tr>
 130 <td class="memname">int32_t(* <a class="el" href="struct_p_p_b___host_resolver__1__0.html#a006c54c355fc4258fc1c9e75e8861dea">PPB_HostResolver::Resolve</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> host_resolver, const char *host, uint16_t port, const struct <a class="el" href="struct_p_p___host_resolver___hint.html">PP_HostResolver_Hint</a> *hint, struct <a class="el" href="struct_p_p___completion_callback.html">PP_CompletionCallback</a> callback)</td>
 131 </tr>
 132 </table>
 133 </div>
 134 <div class="memdoc">
 135 <p>Requests resolution of a host name. </p>
 136 <p>If the call completes successfully, the results can be retrieved by <code><a class="el" href="struct_p_p_b___host_resolver__1__0.html#a5edb535ad2bdc3db835ef7ec57f98f49" title="Gets the canonical name of the host.">GetCanonicalName()</a></code>, <code><a class="el" href="struct_p_p_b___host_resolver__1__0.html#afe9dc8c673c2a12331eceaf60ecba911" title="Gets the number of network addresses.">GetNetAddressCount()</a></code> and <code><a class="el" href="struct_p_p_b___host_resolver__1__0.html#a7202ffb6c7b6d02da4ece9e748aaa886" title="Gets a network address.">GetNetAddress()</a></code>.</p>
 137 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 138 <table class="params">
 139 <tr><td class="paramdir">[in]</td><td class="paramname">host_resolver</td><td>A <code>PP_Resource</code> corresponding to a host resolver. </td></tr>
 140 <tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>The host name (or IP address literal) to resolve. </td></tr>
 141 <tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>The port number to be set in the resulting network addresses. </td></tr>
 142 <tr><td class="paramdir">[in]</td><td class="paramname">hint</td><td>A <code><a class="el" href="struct_p_p___host_resolver___hint.html" title="PP_HostResolver_Hint represents hints for host resolution.">PP_HostResolver_Hint</a></code> structure providing hints for host resolution. </td></tr>
 143 <tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>A <code><a class="el" href="struct_p_p___completion_callback.html" title="PP_CompletionCallback is a common mechanism for supporting potentially asynchronous calls in browser ...">PP_CompletionCallback</a></code> to be called upon completion.</td></tr>
 144 </table>
 145 </dd>
 146 </dl>
 147 <dl class="return"><dt><b>Returns:</b></dt><dd>An int32_t containing 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>. <code>PP_ERROR_NOACCESS</code> will be returned if the caller doesn't have required permissions. <code>PP_ERROR_NAME_NOT_RESOLVED</code> will be returned if the host name couldn't be resolved. </dd></dl>
 148 </div>
 149 </div>
 150 <hr />The documentation for this struct was generated from the following file:<ul>
 151 <li><a class="el" href="ppb__host__resolver_8h.html">ppb_host_resolver.h</a></li>
 152 </ul>
 153 </div><!-- contents -->
 154 {{/partials.standard_nacl_article}}