summaryrefslogtreecommitdiff
path: root/Source/WebKit2/UIProcess/ChildProcessProxy.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/WebKit2/UIProcess/ChildProcessProxy.h')
-rw-r--r--Source/WebKit2/UIProcess/ChildProcessProxy.h123
1 files changed, 123 insertions, 0 deletions
diff --git a/Source/WebKit2/UIProcess/ChildProcessProxy.h b/Source/WebKit2/UIProcess/ChildProcessProxy.h
new file mode 100644
index 000000000..a1f5227e1
--- /dev/null
+++ b/Source/WebKit2/UIProcess/ChildProcessProxy.h
@@ -0,0 +1,123 @@
+/*
+ * Copyright (C) 2012-2016 Apple Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+ * THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#include "Connection.h"
+#include "MessageReceiverMap.h"
+#include "ProcessLauncher.h"
+
+#include <wtf/ThreadSafeRefCounted.h>
+
+namespace WebKit {
+
+class ChildProcessProxy : ProcessLauncher::Client, public IPC::Connection::Client, public ThreadSafeRefCounted<ChildProcessProxy> {
+ WTF_MAKE_NONCOPYABLE(ChildProcessProxy);
+
+protected:
+ explicit ChildProcessProxy(bool alwaysRunsAtBackgroundPriority = false);
+
+public:
+ virtual ~ChildProcessProxy();
+
+ void connect();
+ void terminate();
+
+ template<typename T> bool send(T&& message, uint64_t destinationID, OptionSet<IPC::SendOption> sendOptions = { });
+ template<typename T> bool sendSync(T&& message, typename T::Reply&&, uint64_t destinationID, Seconds timeout = 1_s, OptionSet<IPC::SendSyncOption> sendSyncOptions = { });
+
+ IPC::Connection* connection() const
+ {
+ ASSERT(m_connection);
+ return m_connection.get();
+ }
+
+ bool hasConnection(const IPC::Connection& connection) const
+ {
+ return m_connection == &connection;
+ }
+
+ void addMessageReceiver(IPC::StringReference messageReceiverName, IPC::MessageReceiver&);
+ void addMessageReceiver(IPC::StringReference messageReceiverName, uint64_t destinationID, IPC::MessageReceiver&);
+ void removeMessageReceiver(IPC::StringReference messageReceiverName, uint64_t destinationID);
+ void removeMessageReceiver(IPC::StringReference messageReceiverName);
+
+ enum class State {
+ Launching,
+ Running,
+ Terminated,
+ };
+ State state() const;
+
+ pid_t processIdentifier() const { return m_processLauncher ? m_processLauncher->processIdentifier() : 0; }
+
+ bool canSendMessage() const { return state() != State::Terminated;}
+ bool sendMessage(std::unique_ptr<IPC::Encoder>, OptionSet<IPC::SendOption>);
+
+ void shutDownProcess();
+
+protected:
+ // ProcessLauncher::Client
+ void didFinishLaunching(ProcessLauncher*, IPC::Connection::Identifier) override;
+
+ bool dispatchMessage(IPC::Connection&, IPC::Decoder&);
+ bool dispatchSyncMessage(IPC::Connection&, IPC::Decoder&, std::unique_ptr<IPC::Encoder>&);
+
+ virtual void getLaunchOptions(ProcessLauncher::LaunchOptions&);
+
+private:
+ virtual void connectionWillOpen(IPC::Connection&);
+ virtual void processWillShutDown(IPC::Connection&) = 0;
+
+ Vector<std::pair<std::unique_ptr<IPC::Encoder>, OptionSet<IPC::SendOption>>> m_pendingMessages;
+ RefPtr<ProcessLauncher> m_processLauncher;
+ RefPtr<IPC::Connection> m_connection;
+ IPC::MessageReceiverMap m_messageReceiverMap;
+ bool m_alwaysRunsAtBackgroundPriority { false };
+};
+
+template<typename T>
+bool ChildProcessProxy::send(T&& message, uint64_t destinationID, OptionSet<IPC::SendOption> sendOptions)
+{
+ COMPILE_ASSERT(!T::isSync, AsyncMessageExpected);
+
+ auto encoder = std::make_unique<IPC::Encoder>(T::receiverName(), T::name(), destinationID);
+ encoder->encode(message.arguments());
+
+ return sendMessage(WTFMove(encoder), sendOptions);
+}
+
+template<typename U>
+bool ChildProcessProxy::sendSync(U&& message, typename U::Reply&& reply, uint64_t destinationID, Seconds timeout, OptionSet<IPC::SendSyncOption> sendSyncOptions)
+{
+ COMPILE_ASSERT(U::isSync, SyncMessageExpected);
+
+ if (!m_connection)
+ return false;
+
+ return connection()->sendSync(std::forward<U>(message), WTFMove(reply), destinationID, timeout, sendSyncOptions);
+}
+
+} // namespace WebKit