initial import
[vuplus_webkit] / Source / WebKit / chromium / src / PlatformMessagePortChannel.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 PlatformMessagePortChannel_h
32 #define PlatformMessagePortChannel_h
33
34 #include "WebMessagePortChannelClient.h"
35
36 #include "MessagePortChannel.h"
37 #include <wtf/PassRefPtr.h>
38 #include <wtf/Threading.h>
39
40 namespace WebKit {
41 class WebMessagePortChannel;
42 }
43
44 namespace WebCore {
45
46 class MessagePort;
47
48 // PlatformMessagePortChannel is a platform-dependent interface to the remote side of a message channel.
49 class PlatformMessagePortChannel : public ThreadSafeRefCounted<PlatformMessagePortChannel>,
50                                    public WebKit::WebMessagePortChannelClient {
51 public:
52     static void createChannel(PassRefPtr<MessagePort>, PassRefPtr<MessagePort>);
53     static PassRefPtr<PlatformMessagePortChannel> create();
54     static PassRefPtr<PlatformMessagePortChannel> create(WebKit::WebMessagePortChannel*);
55
56     // APIs delegated from MessagePortChannel.h
57     bool entangleIfOpen(MessagePort*);
58     void disentangle();
59     void postMessageToRemote(PassOwnPtr<MessagePortChannel::EventData>);
60     bool tryGetMessageFromRemote(OwnPtr<MessagePortChannel::EventData>&);
61     void close();
62     bool isConnectedTo(MessagePort* port);
63     bool hasPendingActivity();
64
65     // Releases ownership of the contained web channel.
66     WebKit::WebMessagePortChannel* webChannelRelease();
67
68     virtual ~PlatformMessagePortChannel();
69
70 private:
71     PlatformMessagePortChannel();
72     PlatformMessagePortChannel(WebKit::WebMessagePortChannel*);
73
74     void setEntangledChannel(PassRefPtr<PlatformMessagePortChannel>);
75
76     // WebKit::WebMessagePortChannelClient implementation
77     virtual void messageAvailable();
78
79     // Mutex used to ensure exclusive access to the object internals.
80     Mutex m_mutex;
81
82     // Pointer to our entangled pair - cleared when close() is called.
83     RefPtr<PlatformMessagePortChannel> m_entangledChannel;
84
85     // The port we are connected to - this is the port that is notified when new messages arrive.
86     MessagePort* m_localPort;
87
88     WebKit::WebMessagePortChannel* m_webChannel;
89 };
90
91 } // namespace WebCore
92
93 #endif // PlatformMessagePortChannel_h