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

   1 {{+bindTo:partials.standard_nacl_api}}
   2 <h1>pp::MessageHandler 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::MessageHandler" -->
  14 <p><a href="classpp_1_1_message_handler-members.html">List of all members.</a></p>
  15 <h2>
  16 Public Member Functions</h2><table class="memberdecls">
  17
  18 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_message_handler.html#a7dca8d4b899382782aaa163fb2654b83">~MessageHandler</a> ()</td></tr>
  19 <tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_message_handler.html#a1040f95297420067a69000612bbe6c06">HandleMessage</a> (<a class="el" href="classpp_1_1_instance_handle.html">pp::InstanceHandle</a> instance, const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;message_data)=0</td></tr>
  20 <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classpp_1_1_var.html">pp::Var</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_message_handler.html#a37212226dba86f1bf900016116fabdfe">HandleBlockingMessage</a> (<a class="el" href="classpp_1_1_instance_handle.html">pp::InstanceHandle</a> instance, const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;message_data)=0</td></tr>
  21 <tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_message_handler.html#ac19edb6318796c337865e39d764ed322">WasUnregistered</a> (<a class="el" href="classpp_1_1_instance_handle.html">pp::InstanceHandle</a> instance)=0</td></tr>
  22 </table>
  23 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  24 <div class="textblock"><p><code><a class="el" href="classpp_1_1_message_handler.html" title="MessageHandler is an abstract base class that the plugin may implement if it wants to receive message...">MessageHandler</a></code> is an abstract base class that the plugin may implement if it wants to receive messages from JavaScript on a background thread when JavaScript invokes postMessage() or postMessageAndAwaitResponse(). </p>
  25 <p>See <a class="el" href="classpp_1_1_instance.html#a5b5b1a66eda2d0e6884de8f7e25e2346" title="Dev-Channel Only.">pp::Instance::RegisterMessageHandler()</a> for usage. </p>
  26 </div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
  27 <a class="anchor" id="a7dca8d4b899382782aaa163fb2654b83"></a><!-- doxytag: member="pp::MessageHandler::~MessageHandler" ref="a7dca8d4b899382782aaa163fb2654b83" args="()" -->
  28 <div class="memitem">
  29 <div class="memproto">
  30 <table class="memname">
  31 <tr>
  32 <td class="memname">virtual <a class="el" href="classpp_1_1_message_handler.html#a7dca8d4b899382782aaa163fb2654b83">pp::MessageHandler::~MessageHandler</a> </td>
  33 <td>(</td>
  34 <td class="paramname"></td><td>)</td>
  35 <td><code> [inline, virtual]</code></td>
  36 </tr>
  37 </table>
  38 </div>
  39 <div class="memdoc">
  40 </div>
  41 </div>
  42 <hr /><h2>Member Function Documentation</h2>
  43 <a class="anchor" id="a37212226dba86f1bf900016116fabdfe"></a><!-- doxytag: member="pp::MessageHandler::HandleBlockingMessage" ref="a37212226dba86f1bf900016116fabdfe" args="(pp::InstanceHandle instance, const Var &amp;message_data)=0" -->
  44 <div class="memitem">
  45 <div class="memproto">
  46 <table class="memname">
  47 <tr>
  48 <td class="memname">virtual <a class="el" href="classpp_1_1_var.html">pp::Var</a> <a class="el" href="classpp_1_1_message_handler.html#a37212226dba86f1bf900016116fabdfe">pp::MessageHandler::HandleBlockingMessage</a> </td>
  49 <td>(</td>
  50 <td class="paramtype"><a class="el" href="classpp_1_1_instance_handle.html">pp::InstanceHandle</a>&#160;</td>
  51 <td class="paramname"><em>instance</em>, </td>
  52 </tr>
  53 <tr>
  54 <td class="paramkey"></td>
  55 <td></td>
  56 <td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
  57 <td class="paramname"><em>message_data</em>&#160;</td>
  58 </tr>
  59 <tr>
  60 <td></td>
  61 <td>)</td>
  62 <td></td><td><code> [pure virtual]</code></td>
  63 </tr>
  64 </table>
  65 </div>
  66 <div class="memdoc">
  67 <p>Invoked as a result of JavaScript invoking postMessageAndAwaitResponse() on the plugin's DOM element. </p>
  68 <p>NOTE: JavaScript execution is blocked during the duration of this call. Hence, the plugin should respond as quickly as possible. For this reason, blocking completion callbacks are disallowed while handling a blocking message.</p>
  69 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  70 <table class="params">
  71 <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>
  72 <tr><td class="paramdir">[in]</td><td class="paramname">message_data</td><td>A copy of the parameter that JavaScript provided to postMessage(). </td></tr>
  73 </table>
  74 </dd>
  75 </dl>
  76 <dl class="return"><dt><b>Returns:</b></dt><dd>Returns a <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">pp::Var</a> that is then copied to a JavaScript object which is returned as the result of JavaScript's call of postMessageAndAwaitResponse(). </dd></dl>
  77 </div>
  78 </div>
  79 <a class="anchor" id="a1040f95297420067a69000612bbe6c06"></a><!-- doxytag: member="pp::MessageHandler::HandleMessage" ref="a1040f95297420067a69000612bbe6c06" args="(pp::InstanceHandle instance, const Var &amp;message_data)=0" -->
  80 <div class="memitem">
  81 <div class="memproto">
  82 <table class="memname">
  83 <tr>
  84 <td class="memname">virtual void <a class="el" href="classpp_1_1_message_handler.html#a1040f95297420067a69000612bbe6c06">pp::MessageHandler::HandleMessage</a> </td>
  85 <td>(</td>
  86 <td class="paramtype"><a class="el" href="classpp_1_1_instance_handle.html">pp::InstanceHandle</a>&#160;</td>
  87 <td class="paramname"><em>instance</em>, </td>
  88 </tr>
  89 <tr>
  90 <td class="paramkey"></td>
  91 <td></td>
  92 <td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
  93 <td class="paramname"><em>message_data</em>&#160;</td>
  94 </tr>
  95 <tr>
  96 <td></td>
  97 <td>)</td>
  98 <td></td><td><code> [pure virtual]</code></td>
  99 </tr>
 100 </table>
 101 </div>
 102 <div class="memdoc">
 103 <p>Invoked as a result of JavaScript invoking postMessage() on the plugin's DOM element. </p>
 104 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 105 <table class="params">
 106 <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>
 107 <tr><td class="paramdir">[in]</td><td class="paramname">message_data</td><td>A copy of the parameter that JavaScript provided to postMessage(). </td></tr>
 108 </table>
 109 </dd>
 110 </dl>
 111 </div>
 112 </div>
 113 <a class="anchor" id="ac19edb6318796c337865e39d764ed322"></a><!-- doxytag: member="pp::MessageHandler::WasUnregistered" ref="ac19edb6318796c337865e39d764ed322" args="(pp::InstanceHandle instance)=0" -->
 114 <div class="memitem">
 115 <div class="memproto">
 116 <table class="memname">
 117 <tr>
 118 <td class="memname">virtual void <a class="el" href="classpp_1_1_message_handler.html#ac19edb6318796c337865e39d764ed322">pp::MessageHandler::WasUnregistered</a> </td>
 119 <td>(</td>
 120 <td class="paramtype"><a class="el" href="classpp_1_1_instance_handle.html">pp::InstanceHandle</a>&#160;</td>
 121 <td class="paramname"><em>instance</em></td><td>)</td>
 122 <td><code> [pure virtual]</code></td>
 123 </tr>
 124 </table>
 125 </div>
 126 <div class="memdoc">
 127 <p>Invoked when this <a class="el" href="classpp_1_1_message_handler.html" title="MessageHandler is an abstract base class that the plugin may implement if it wants to receive message...">MessageHandler</a> is no longer needed. </p>
 128 <p>After this, no more calls will be made to this object.</p>
 129 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 130 <table class="params">
 131 <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>
 132 </table>
 133 </dd>
 134 </dl>
 135 </div>
 136 </div>
 137 <hr />The documentation for this class was generated from the following file:<ul>
 138 <li><a class="el" href="message__handler_8h.html">message_handler.h</a></li>
 139 </ul>
 140 </div><!-- contents -->
 141 </div>
 142 {{/partials.standard_nacl_api}}