1/*
2 * Copyright (C) 2013 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. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#if ENABLE(REMOTE_INSPECTOR)
27
28#ifndef RemoteInspectorXPCConnection_h
29#define RemoteInspectorXPCConnection_h
30
31#import <dispatch/dispatch.h>
32#import <mutex>
33#import <wtf/ThreadSafeRefCounted.h>
34#import <xpc/xpc.h>
35
36OBJC_CLASS NSDictionary;
37OBJC_CLASS NSString;
38
39namespace Inspector {
40
41class RemoteInspectorXPCConnection : public ThreadSafeRefCounted<RemoteInspectorXPCConnection> {
42public:
43    class Client {
44    public:
45        virtual ~Client() { }
46        virtual void xpcConnectionReceivedMessage(RemoteInspectorXPCConnection*, NSString *messageName, NSDictionary *userInfo) = 0;
47        virtual void xpcConnectionFailed(RemoteInspectorXPCConnection*) = 0;
48        virtual void xpcConnectionUnhandledMessage(RemoteInspectorXPCConnection*, xpc_object_t) = 0;
49    };
50
51    RemoteInspectorXPCConnection(xpc_connection_t, dispatch_queue_t, Client*);
52    virtual ~RemoteInspectorXPCConnection();
53
54    void close();
55    void closeFromMessage();
56    void sendMessage(NSString *messageName, NSDictionary *userInfo);
57
58private:
59    NSDictionary *deserializeMessage(xpc_object_t);
60    void handleEvent(xpc_object_t);
61    void closeOnQueue();
62
63    // We handle XPC events on the queue, but a client may call close() on any queue.
64    // We make sure that m_client is thread safe and immediately cleared in close().
65    std::mutex m_mutex;
66
67    xpc_connection_t m_connection;
68    dispatch_queue_t m_queue;
69    Client* m_client;
70    bool m_closed;
71};
72
73} // namespace Inspector
74
75#endif // RemoteInspectorXPCConnection_h
76
77#endif // ENABLE(REMOTE_INSPECTOR)
78