Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(240)

Unified Diff: native_client_sdk/doc_generated/pepper_stable/c/struct_p_p_b___messaging__1__0.html

Issue 901083002: [NaCl SDK Docs] Update Pepper docs to latest. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 5 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: native_client_sdk/doc_generated/pepper_stable/c/struct_p_p_b___messaging__1__0.html
diff --git a/native_client_sdk/doc_generated/pepper_stable/c/struct_p_p_b___messaging__1__0.html b/native_client_sdk/doc_generated/pepper_stable/c/struct_p_p_b___messaging__1__0.html
deleted file mode 100644
index a13d4fa97a4b9bfb687ef2031801394ce98ca5f5..0000000000000000000000000000000000000000
--- a/native_client_sdk/doc_generated/pepper_stable/c/struct_p_p_b___messaging__1__0.html
+++ /dev/null
@@ -1,68 +0,0 @@
-{{+bindTo:partials.standard_nacl_api}}
-<h1>PPB_Messaging Struct Reference</h1>
-<div id="doxygen-ref">
-{{- dummy div to appease doxygen -}}
- <div>
-<!-- Generated by Doxygen 1.7.6.1 -->
-
-
-</div>
-<!--header-->
-<div class="contents">
-<!-- doxytag: class="PPB_Messaging" --><h2>
-Data Fields</h2><table class="memberdecls">
-
-<tr><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___messaging__1__0.html#a7f0412c47b340d21c9c98be2e83dcc53">PostMessage</a> )(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance, struct <a class="el" href="struct_p_p___var.html">PP_Var</a> message)</td></tr>
-</table>
-<hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
-<div class="textblock"><p>The <code>PPB_Messaging</code> interface is implemented by the browser and is related to sending messages to JavaScript message event listeners on the DOM element associated with specific module instance. </p>
-</div><hr /><h2>Field Documentation</h2>
-<a class="anchor" id="a7f0412c47b340d21c9c98be2e83dcc53"></a><!-- doxytag: member="PPB_Messaging::PostMessage" ref="a7f0412c47b340d21c9c98be2e83dcc53" args=")(PP_Instance instance, struct PP_Var message)" -->
-<div class="memitem">
-<div class="memproto">
-<table class="memname">
-<tr>
-<td class="memname">void(* <a class="el" href="struct_p_p_b___messaging__1__0.html#a7f0412c47b340d21c9c98be2e83dcc53">PPB_Messaging::PostMessage</a>)(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance, struct <a class="el" href="struct_p_p___var.html">PP_Var</a> message)</td>
-</tr>
-</table>
-</div>
-<div class="memdoc">
-<p><a class="el" href="struct_p_p_b___messaging__1__0.html#a7f0412c47b340d21c9c98be2e83dcc53" title="PostMessage() asynchronously invokes any listeners for message events on the DOM element for the give...">PostMessage()</a> asynchronously invokes any listeners for message events on the DOM element for the given module instance. </p>
-<p>A call to <a class="el" href="struct_p_p_b___messaging__1__0.html#a7f0412c47b340d21c9c98be2e83dcc53" title="PostMessage() asynchronously invokes any listeners for message events on the DOM element for the give...">PostMessage()</a> will not block while the message is processed.</p>
-<dl class="params"><dt><b>Parameters:</b></dt><dd>
-<table class="params">
-<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>
-<tr><td class="paramdir">[in]</td><td class="paramname">message</td><td>A <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> containing the data to be sent to JavaScript. <code>message</code> can be any <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> type except <code>PP_VARTYPE_OBJECT</code>. Array/Dictionary types are supported from Chrome M29 onward. All var types are copied when passing them to JavaScript.</td></tr>
-</table>
-</dd>
-</dl>
-<p>When passing array or dictionary <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>s, the entire reference graph will be converted and transferred. If the reference graph has cycles, the message will not be sent and an error will be logged to the console.</p>
-<p>Listeners for message events in JavaScript code will receive an object conforming to the HTML 5 <code>MessageEvent</code> interface. Specifically, the value of message will be contained as a property called data in the received <code>MessageEvent</code>.</p>
-<p>This messaging system is similar to the system used for listening for messages from Web Workers. Refer to <code><a href="http://www.whatwg.org/specs/web-workers/current-work/">http://www.whatwg.org/specs/web-workers/current-work/</a></code> for further information.</p>
-<p><b>Example:</b></p>
-<div class="fragment"><pre class="fragment"> &lt;body&gt;
- &lt;<span class="keywordtype">object</span> <span class="keywordtype">id</span>=<span class="stringliteral">&quot;plugin&quot;</span>
- type=<span class="stringliteral">&quot;application/x-ppapi-postMessage-example&quot;</span>/&gt;
- &lt;script type=<span class="stringliteral">&quot;text/javascript&quot;</span>&gt;
- var plugin = document.getElementById(<span class="stringliteral">&#39;plugin&#39;</span>);
- plugin.addEventListener(<span class="stringliteral">&quot;message&quot;</span>,
- <span class="keyword">function</span>(message) { alert(message.data); },
- <span class="keyword">false</span>);
- &lt;/script&gt;
- &lt;/body&gt;
-</pre></div><p>The module instance then invokes <a class="el" href="struct_p_p_b___messaging__1__0.html#a7f0412c47b340d21c9c98be2e83dcc53" title="PostMessage() asynchronously invokes any listeners for message events on the DOM element for the give...">PostMessage()</a> as follows:</p>
-<div class="fragment"><pre class="fragment"> <span class="keywordtype">char</span> hello_world[] = <span class="stringliteral">&quot;Hello world!&quot;</span>;
- <a class="code" 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> hello_var = ppb_var_interface-&gt;VarFromUtf8(instance,
- hello_world,
- <span class="keyword">sizeof</span>(hello_world));
- ppb_messaging_interface-&gt;PostMessage(instance, hello_var); <span class="comment">// Copies var.</span>
- ppb_var_interface-&gt;Release(hello_var);
-</pre></div><p>The browser will pop-up an alert saying "Hello world!" </p>
-</div>
-</div>
-<hr />The documentation for this struct was generated from the following file:<ul>
-<li><a class="el" href="ppb__messaging_8h.html">ppb_messaging.h</a></li>
-</ul>
-</div><!-- contents -->
-</div>
-{{/partials.standard_nacl_api}}

Powered by Google App Engine
This is Rietveld 408576698