summaryrefslogtreecommitdiffstats
path: root/content/public/browser/message_port_provider.h
blob: 8a725de00b59e8ded8c0248fe5da45cdb75912f8 (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
58
59
60
61
62
// 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 CONTENT_PUBLIC_BROWSER_MESSAGE_PORT_PROVIDER_H_
#define CONTENT_PUBLIC_BROWSER_MESSAGE_PORT_PROVIDER_H_

#include <vector>

#include "base/basictypes.h"
#include "base/macros.h"
#include "base/strings/string16.h"
#include "content/common/content_export.h"

namespace content {

class MessagePortDelegate;
class WebContents;

// An interface consisting of methods that can be called to use Message ports.
class CONTENT_EXPORT MessagePortProvider {
 public:
  // Posts a MessageEvent to the main frame using the given source and target
  // origins and data. The caller may also provide any message port ids as
  // part of the message.
  // See https://html.spec.whatwg.org/multipage/comms.html#messageevent for
  // further information on message events.
  // Should be called on UI thread.
  static void PostMessageToFrame(WebContents* web_contents,
                                 const base::string16& source_origin,
                                 const base::string16& target_origin,
                                 const base::string16& data,
                                 const std::vector<int>& ports);

  // Creates a message channel and provide the ids of the message ports that are
  // associated with this message channel.
  // See https://html.spec.whatwg.org/multipage/comms.html#messagechannel
  // Should be called on IO thread.
  // The message ports that are created will have their routing id numbers equal
  // to the message port numbers.
  static void CreateMessageChannel(MessagePortDelegate* delegate,
                                   int* port1,
                                   int* port2);

  // Posts a MessageEvent to a message port associated with a message channel.
  static void PostMessageToPort(int sender_port_id,
                                const base::string16& data,
                                const std::vector<int>& sent_ports);

  // Close the message port. Should be called on IO thread.
  static void ClosePort(int message_port_id);

  // Cleanup the message ports that belong to the closing delegate.
  static void OnMessagePortDelegateClosing(MessagePortDelegate * delegate);

 private:
  DISALLOW_IMPLICIT_CONSTRUCTORS(MessagePortProvider);
};

}  // namespace content

#endif  // CONTENT_PUBLIC_BROWSER_MESSAGE_PORT_PROVIDER_H_