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

Unified Diff: ppapi/cpp/message_handler.h

Issue 318763003: PPAPI: Add C++ wrapper for MessageHandler stuff. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Update, make test use C++, add comments 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
Index: ppapi/cpp/message_handler.h
diff --git a/ppapi/cpp/message_handler.h b/ppapi/cpp/message_handler.h
new file mode 100644
index 0000000000000000000000000000000000000000..4a60c42042411d2b5392fcd5171fa9fcdcb05f56
--- /dev/null
+++ b/ppapi/cpp/message_handler.h
@@ -0,0 +1,56 @@
+// Copyright 2014 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef PPAPI_CPP_MESSAGE_HANDLER_H_
+#define PPAPI_CPP_MESSAGE_HANDLER_H_
+
+namespace pp {
+
+/// <code>MessageHandler</code> is an abstract base class that the plugin may
+/// implement if it wants to receive messages from JavaScript (postMessage() or
bbudge 2014/09/18 12:41:17 the first ( doesn't seem to have a matching )
+/// postMessageAndAwaitResponse() on a background thread. See
+/// pp::Instance::RegisterMessageHandler() for usage.
+class MessageHandler {
+ public:
+ virtual ~MessageHandler() {};
+
+ /// Invoked as a result of JavaScript invoking postMessage() on the plugin's
+ /// DOM element.
+ ///
+ /// @param[in] instance An <code>InstanceHandle</code> identifying one
+ /// instance of a module.
+ /// @param[in] message_data A copy of the parameter that JavaScript provided
+ /// to postMessage().
+ virtual void HandleMessage(pp::InstanceHandle instance,
+ const Var& message_data) = 0;
+
+ /// Invoked as a result of JavaScript invoking postMessageAndAwaitResponse()
+ /// on the plugin's DOM element.
+ ///
+ /// 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.
+ ///
+ /// @param[in] instance An <code>InstanceHandle</code> identifying one
+ /// instance of a module.
+ /// @param[in] message is a copy of the parameter that JavaScript provided
bbudge 2014/09/18 12:41:17 s/message/message_data This should be identical to
+ /// to postMessageAndAwaitResponse.
+ /// @return Returns a pp::Var that is then copied to a JavaScript object
+ /// which is returned as the result of JavaScript's call of
+ /// postMessageAndAwaitResponse().
+ virtual pp::Var HandleBlockingMessage(pp::InstanceHandle instance,
+ const Var& message_data) = 0;
+
+ /// Invoked when this MessageHandler is no longer needed. After this, no more
+ /// calls will be made to this object.
+ ///
+ /// @param[in] instance An <code>InstanceHandle</code> identifying one
+ /// instance of a module.
+ virtual void WasUnregistered(pp::InstanceHandle instance) = 0;
+};
+
+} // namespace pp
+
+#endif // PPAPI_CPP_MESSAGE_HANDLER_H_

Powered by Google App Engine
This is Rietveld 408576698