blob: 0bb6ad8472c421aeb5a972d56393463c25f603ba (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
// 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 on a background
/// thread when JavaScript invokes postMessage() or
/// postMessageAndAwaitResponse(). 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_data A copy of the parameter that JavaScript provided
/// to postMessage().
/// @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_
|
