cf5caad8581e4fb669d1a8cded111b78c81b8eb8
[WebKit-https.git] / Source / WebKit2 / Shared / WebConnection.h
1 /*
2  * Copyright (C) 2011 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef WebConnection_h
27 #define WebConnection_h
28
29 #include "APIObject.h"
30 #include "MessageReceiver.h"
31 #include "MessageSender.h"
32 #include "UserData.h"
33 #include "WebConnectionClient.h"
34 #include <wtf/RefPtr.h>
35
36 namespace WebKit {
37
38 class UserData;
39 class WebConnection : public API::ObjectImpl<API::Object::Type::Connection>, public IPC::MessageReceiver, public IPC::MessageSender {
40 public:
41     virtual ~WebConnection();
42
43     void initializeConnectionClient(const WKConnectionClientBase*);
44     void postMessage(const String&, API::Object*);
45     void didClose();
46
47 protected:
48     explicit WebConnection();
49
50     virtual RefPtr<API::Object> transformHandlesToObjects(API::Object*) = 0;
51     virtual RefPtr<API::Object> transformObjectsToHandles(API::Object*) = 0;
52
53     // IPC::MessageReceiver
54     // Implemented in generated WebConnectionMessageReceiver.cpp
55     void didReceiveMessage(IPC::Connection*, IPC::MessageDecoder&) override;
56
57     // Mesage handling implementation functions.
58     void handleMessage(const String& messageName, const UserData& messageBody);
59
60     virtual bool hasValidConnection() const = 0;
61
62     WebConnectionClient m_client;
63 };
64
65 } // namespace WebKit
66
67 #endif // WebConnection_h