11320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// Copyright 2014 The Chromium Authors. All rights reserved. 21320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// Use of this source code is governed by a BSD-style license that can be 31320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// found in the LICENSE file. 41320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 51320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#ifndef PPAPI_CPP_MESSAGE_HANDLER_H_ 61320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#define PPAPI_CPP_MESSAGE_HANDLER_H_ 71320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 81320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tuccinamespace pp { 91320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 101320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci/// <code>MessageHandler</code> is an abstract base class that the plugin may 111320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci/// implement if it wants to receive messages from JavaScript on a background 121320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci/// thread when JavaScript invokes postMessage() or 131320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci/// postMessageAndAwaitResponse(). See pp::Instance::RegisterMessageHandler() 141320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci/// for usage. 151320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucciclass MessageHandler { 161320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci public: 171320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci virtual ~MessageHandler() {}; 181320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 191320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// Invoked as a result of JavaScript invoking postMessage() on the plugin's 201320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// DOM element. 211320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// 221320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// @param[in] instance An <code>InstanceHandle</code> identifying one 231320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// instance of a module. 241320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// @param[in] message_data A copy of the parameter that JavaScript provided 251320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// to postMessage(). 261320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci virtual void HandleMessage(pp::InstanceHandle instance, 271320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci const Var& message_data) = 0; 281320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 291320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// Invoked as a result of JavaScript invoking postMessageAndAwaitResponse() 301320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// on the plugin's DOM element. 311320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// 321320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// NOTE: JavaScript execution is blocked during the duration of this call. 331320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// Hence, the plugin should respond as quickly as possible. For this reason, 341320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// blocking completion callbacks are disallowed while handling a blocking 351320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// message. 361320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// 371320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// @param[in] instance An <code>InstanceHandle</code> identifying one 381320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// instance of a module. 391320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// @param[in] message_data A copy of the parameter that JavaScript provided 401320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// to postMessage(). 411320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// @return Returns a pp::Var that is then copied to a JavaScript object 421320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// which is returned as the result of JavaScript's call of 431320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// postMessageAndAwaitResponse(). 441320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci virtual pp::Var HandleBlockingMessage(pp::InstanceHandle instance, 451320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci const Var& message_data) = 0; 461320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 471320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// Invoked when this MessageHandler is no longer needed. After this, no more 481320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// calls will be made to this object. 491320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// 501320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// @param[in] instance An <code>InstanceHandle</code> identifying one 511320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci /// instance of a module. 521320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci virtual void WasUnregistered(pp::InstanceHandle instance) = 0; 531320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci}; 541320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 551320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci} // namespace pp 561320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 571320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#endif // PPAPI_CPP_MESSAGE_HANDLER_H_ 58