Replace uses of ArgumentEncoder/ArgumentDecoder with MessageEncoder/MessageDecoder
[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 "WebConnectionClient.h"
31 #include <wtf/RefPtr.h>
32
33 namespace CoreIPC {
34     class ArgumentDecoder;
35     class ArgumentEncoder;
36     class Connection;
37     class DataReference;
38     class MessageDecoder;
39     class MessageEncoder;
40     class MessageID;
41 }
42
43 namespace WebKit {
44
45 class WebConnection : public APIObject {
46 public:
47     static const Type APIType = TypeConnection;
48     virtual ~WebConnection();
49
50     CoreIPC::Connection* connection() { return m_connection.get(); }
51
52     void initializeConnectionClient(const WKConnectionClient*);
53     void postMessage(const String&, APIObject*);
54
55     void invalidate();
56
57 protected:
58     explicit WebConnection(PassRefPtr<CoreIPC::Connection>);
59
60     virtual Type type() const { return APIType; }
61     virtual void encodeMessageBody(CoreIPC::ArgumentEncoder&, APIObject*) = 0;
62     virtual bool decodeMessageBody(CoreIPC::ArgumentDecoder&, RefPtr<APIObject>&) = 0;
63
64     // Implemented in generated WebConnectionMessageReceiver.cpp
65     void didReceiveWebConnectionMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::MessageDecoder&);
66     void handleMessage(const CoreIPC::DataReference& messageData);
67
68     RefPtr<CoreIPC::Connection> m_connection;
69     WebConnectionClient m_client;
70 };
71
72 } // namespace WebKit
73
74 #endif // WebConnection_h