← Back to branch summary

~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to src/3rdparty/webkit/WebCore/dom/MessagePortChannel.h

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
Import upstream version 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/3rdparty/webkit/WebCore/dom/MessagePortChannel.h
 
1
/*
 
2
 * Copyright (C) 2009 Google Inc. All rights reserved.
 
3
 *
 
4
 * Redistribution and use in source and binary forms, with or without
 
5
 * modification, are permitted provided that the following conditions are
 
6
 * met:
 
7
 *
 
8
 *     * Redistributions of source code must retain the above copyright
 
9
 * notice, this list of conditions and the following disclaimer.
 
10
 *     * Redistributions in binary form must reproduce the above
 
11
 * copyright notice, this list of conditions and the following disclaimer
 
12
 * in the documentation and/or other materials provided with the
 
13
 * distribution.
 
14
 *     * Neither the name of Google Inc. nor the names of its
 
15
 * contributors may be used to endorse or promote products derived from
 
16
 * this software without specific prior written permission.
 
17
 *
 
18
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 
19
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 
20
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 
21
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 
22
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 
23
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 
24
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 
25
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 
26
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 
27
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 
28
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
29
 */
 
30
 
 
31
#ifndef MessagePortChannel_h
 
32
#define MessagePortChannel_h
 
33
 
 
34
#include "PlatformString.h"
 
35
 
 
36
#include <wtf/OwnPtr.h>
 
37
#include <wtf/PassOwnPtr.h>
 
38
#include <wtf/PassRefPtr.h>
 
39
#include <wtf/RefCounted.h>
 
40
#include <wtf/RefPtr.h>
 
41
 
 
42
namespace WebCore {
 
43
 
 
44
    class MessagePort;
 
45
    class MessagePortChannel;
 
46
    class PlatformMessagePortChannel;
 
47
    class ScriptExecutionContext;
 
48
    class String;
 
49
 
 
50
    // The overwhelmingly common case is sending a single port, so handle that efficiently with an inline buffer of size 1.
 
51
    typedef Vector<OwnPtr<MessagePortChannel>, 1> MessagePortChannelArray;
 
52
 
 
53
    // MessagePortChannel is a platform-independent interface to the remote side of a message channel.
 
54
    // It acts as a wrapper around the platform-dependent PlatformMessagePortChannel implementation which ensures that the platform-dependent close() method is invoked before destruction.
 
55
    class MessagePortChannel : public Noncopyable {
 
56
    public:
 
57
        static void createChannel(PassRefPtr<MessagePort>, PassRefPtr<MessagePort>);
 
58
 
 
59
        // Creates a new wrapper for the passed channel.
 
60
        static PassOwnPtr<MessagePortChannel> create(PassRefPtr<PlatformMessagePortChannel>);
 
61
 
 
62
        // Entangles the channel with a port (called when a port has been cloned, after the clone has been marshalled to its new owning thread and is ready to receive messages).
 
63
        // Returns false if the entanglement failed because the port was closed.
 
64
        bool entangleIfOpen(MessagePort*);
 
65
 
 
66
        // Disentangles the channel from a given port so it no longer forwards messages to the port. Called when the port is being cloned and no new owning thread has yet been established.
 
67
        void disentangle();
 
68
 
 
69
        // Closes the port (ensures that no further messages can be added to either queue).
 
70
        void close();
 
71
 
 
72
        // Used by MessagePort.postMessage() to prevent callers from passing a port's own entangled port.
 
73
        bool isConnectedTo(MessagePort*);
 
74
 
 
75
        // Returns true if the proxy currently contains messages for this port.
 
76
        bool hasPendingActivity();
 
77
 
 
78
        class EventData {
 
79
        public:
 
80
            static PassOwnPtr<EventData> create(const String&, PassOwnPtr<MessagePortChannelArray>);
 
81
 
 
82
            const String& message() { return m_message; }
 
83
            PassOwnPtr<MessagePortChannelArray> channels() { return m_channels.release(); }
 
84
 
 
85
        private:
 
86
            EventData(const String& message, PassOwnPtr<MessagePortChannelArray>);
 
87
            String m_message;
 
88
            OwnPtr<MessagePortChannelArray> m_channels;
 
89
        };
 
90
 
 
91
        // Sends a message and optional cloned port to the remote port.
 
92
        void postMessageToRemote(PassOwnPtr<EventData>);
 
93
 
 
94
        // Extracts a message from the message queue for this port.
 
95
        bool tryGetMessageFromRemote(OwnPtr<EventData>&);
 
96
 
 
97
        // Returns the entangled port if run by the same thread (see MessagePort::locallyEntangledPort() for more details).
 
98
        MessagePort* locallyEntangledPort(const ScriptExecutionContext*);
 
99
 
 
100
        ~MessagePortChannel();
 
101
 
 
102
        PlatformMessagePortChannel* channel() const { return m_channel.get(); }
 
103
 
 
104
    private:
 
105
        MessagePortChannel(PassRefPtr<PlatformMessagePortChannel>);
 
106
        RefPtr<PlatformMessagePortChannel> m_channel;
 
107
    };
 
108
 
 
109
} // namespace WebCore
 
110
 
 
111
#endif // MessagePortChannel_h