File: MessagePort.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (151 lines) | stat: -rw-r--r-- 5,459 bytes parent folder | download
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
 * Copyright (C) 2008 Apple Inc. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef MessagePort_h
#define MessagePort_h

#include "bindings/core/v8/ActiveScriptWrappable.h"
#include "bindings/core/v8/SerializedScriptValue.h"
#include "core/CoreExport.h"
#include "core/dom/ContextLifecycleObserver.h"
#include "core/events/EventListener.h"
#include "core/events/EventTarget.h"
#include "public/platform/WebMessagePortChannel.h"
#include "public/platform/WebMessagePortChannelClient.h"
#include "wtf/PassRefPtr.h"
#include "wtf/RefPtr.h"
#include "wtf/Vector.h"
#include <memory>

namespace blink {

class ExceptionState;
class ExecutionContext;
class MessagePort;
class SerializedScriptValue;

// Not to be confused with WebMessagePortChannelArray; this one uses Vector and
// std::unique_ptr instead of WebVector and raw pointers.
typedef Vector<WebMessagePortChannelUniquePtr, 1> MessagePortChannelArray;

class CORE_EXPORT MessagePort : public EventTargetWithInlineData,
                                public ActiveScriptWrappable<MessagePort>,
                                public ContextLifecycleObserver,
                                public WebMessagePortChannelClient {
  DEFINE_WRAPPERTYPEINFO();
  USING_GARBAGE_COLLECTED_MIXIN(MessagePort);

 public:
  static MessagePort* create(ExecutionContext&);
  ~MessagePort() override;

  void postMessage(ExecutionContext*,
                   PassRefPtr<SerializedScriptValue> message,
                   const MessagePortArray&,
                   ExceptionState&);
  static bool canTransferArrayBuffersAndImageBitmaps() { return false; }

  void start();
  void close();

  void entangle(WebMessagePortChannelUniquePtr);
  WebMessagePortChannelUniquePtr disentangle();

  // Returns nullptr if the passed-in array is nullptr/empty.
  static std::unique_ptr<WebMessagePortChannelArray>
      toWebMessagePortChannelArray(std::unique_ptr<MessagePortChannelArray>);

  // Returns an empty array if the passed array is empty.
  static MessagePortArray* toMessagePortArray(
      ExecutionContext*,
      const WebMessagePortChannelArray&);

  // Returns nullptr if there is an exception, or if the passed-in array is
  // nullptr/empty.
  static std::unique_ptr<MessagePortChannelArray>
  disentanglePorts(ExecutionContext*, const MessagePortArray&, ExceptionState&);

  // Returns an empty array if the passed array is nullptr/empty.
  static MessagePortArray* entanglePorts(
      ExecutionContext&,
      std::unique_ptr<MessagePortChannelArray>);

  bool started() const { return m_started; }

  const AtomicString& interfaceName() const override;
  ExecutionContext* getExecutionContext() const override {
    return ContextLifecycleObserver::getExecutionContext();
  }
  MessagePort* toMessagePort() override { return this; }

  // ScriptWrappable implementation.
  bool hasPendingActivity() const final;

  // ContextLifecycleObserver implementation.
  void contextDestroyed(ExecutionContext*) override { close(); }

  void setOnmessage(EventListener* listener) {
    setAttributeEventListener(EventTypeNames::message, listener);
    start();
  }
  EventListener* onmessage() {
    return getAttributeEventListener(EventTypeNames::message);
  }

  // A port starts out its life entangled, and remains entangled until it is
  // closed or is cloned.
  bool isEntangled() const { return !m_closed && !isNeutered(); }

  // A port gets neutered when it is transferred to a new owner via
  // postMessage().
  bool isNeutered() const { return !m_entangledChannel; }

  // For testing only: allows inspection of the entangled channel.
  WebMessagePortChannel* entangledChannelForTesting() const {
    return m_entangledChannel.get();
  }

  DECLARE_VIRTUAL_TRACE();

 protected:
  explicit MessagePort(ExecutionContext&);
  bool tryGetMessage(RefPtr<SerializedScriptValue>& message,
                     std::unique_ptr<MessagePortChannelArray>& channels);

 private:
  // WebMessagePortChannelClient implementation.
  void messageAvailable() override;
  void dispatchMessages();

  WebMessagePortChannelUniquePtr m_entangledChannel;

  bool m_started;
  bool m_closed;
};

}  // namespace blink

#endif  // MessagePort_h