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

Unified Diff: ppapi/cpp/instance.h

Issue 318763003: PPAPI: Add C++ wrapper for MessageHandler stuff. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: move messag_handler.h to HEADERS section of library.dsc Created 6 years, 3 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
« no previous file with comments | « ppapi/c/ppp_message_handler.h ('k') | ppapi/cpp/instance.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: ppapi/cpp/instance.h
diff --git a/ppapi/cpp/instance.h b/ppapi/cpp/instance.h
index af024db336af64ee378481b32f8cbdf810bce6b1..9bc16fb5727e2a2d763d19b58742714afcada271 100644
--- a/ppapi/cpp/instance.h
+++ b/ppapi/cpp/instance.h
@@ -33,6 +33,8 @@ class Graphics2D;
class Graphics3D;
class InputEvent;
class InstanceHandle;
+class MessageHandler;
+class MessageLoop;
class Rect;
class URLLoader;
class Var;
@@ -495,6 +497,55 @@ class Instance {
/// All var types are copied when passing them to JavaScript.
void PostMessage(const Var& message);
+ /// Dev-Channel Only
+ ///
+ /// Registers a handler for receiving messages from JavaScript. If a handler
+ /// is registered this way, it will replace the Instance's HandleMessage
+ /// method, and all messages sent from JavaScript via postMessage and
+ /// postMessageAndAwaitResponse will be dispatched to
+ /// <code>message_handler</code>.
+ ///
+ /// The function calls will be dispatched via <code>message_loop</code>. This
+ /// means that the functions will be invoked on the thread to which
+ /// <code>message_loop</code> is attached, when <code>message_loop</code> is
+ /// run. It is illegal to pass the main thread message loop;
+ /// RegisterMessageHandler will return PP_ERROR_WRONG_THREAD in that case.
+ /// If you quit <code>message_loop</code> before calling Unregister(),
+ /// the browser will not be able to call functions in the plugin's message
+ /// handler any more. That could mean missing some messages or could cause a
+ /// leak if you depend on Destroy() to free hander data. So you should,
+ /// whenever possible, Unregister() the handler prior to quitting its event
+ /// loop.
+ ///
+ /// Attempting to register a message handler when one is already registered
+ /// will cause the current MessageHandler to be unregistered and replaced. In
+ /// that case, no messages will be sent to the "default" message handler
+ /// (pp::Instance::HandleMessage()). Messages will stop arriving at the prior
+ /// message handler and will begin to be dispatched at the new message
+ /// handler.
+ ///
+ /// @param[in] message_handler The plugin-provided object for handling
+ /// messages. The instance does not take ownership of the pointer; it is up
+ /// to the plugin to ensure that |message_handler| lives until its
+ /// WasUnregistered() function is invoked.
+ /// @param[in] message_loop Represents the message loop on which
+ /// MessageHandler's functions should be invoked.
+ /// @return PP_OK on success, or an error from pp_errors.h.
+ int32_t RegisterMessageHandler(MessageHandler* message_handler,
+ const MessageLoop& message_loop);
+
+ /// Unregisters the current message handler for this instance if one is
+ /// registered. After this call, the message handler (if one was
+ /// registered) will have "WasUnregistered" called on it and will receive no
+ /// further messages. After that point, all messages sent from JavaScript
+ /// using postMessage() will be dispatched to pp::Instance::HandleMessage()
+ /// on the main thread. Attempts to call postMessageAndAwaitResponse() from
+ /// JavaScript after that point will fail.
+ ///
+ /// Attempting to unregister a message handler when none is registered has no
+ /// effect.
+ void UnregisterMessageHandler();
+
/// @}
/// @{
« no previous file with comments | « ppapi/c/ppp_message_handler.h ('k') | ppapi/cpp/instance.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698