Cleanup IPC::ChannelProxy to use SingleThreadTaskRunner

ipc/ipc_channel_proxy.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef IPC_IPC_CHANNEL_PROXY_H_
 #define IPC_IPC_CHANNEL_PROXY_H_
 #pragma once
 
 #include <vector>
 
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
-#include "base/message_loop_proxy.h"
 #include "base/synchronization/lock.h"
 #include "ipc/ipc_channel.h"
 #include "ipc/ipc_channel_handle.h"
 #include "ipc/ipc_listener.h"
 #include "ipc/ipc_sender.h"
 
+namespace base {
+class SingleThreadTaskRunner;
+}  // namespace base

[jam, 2012/07/01 22:19:41]

ditto

[Sergey Ulanov, 2012/07/02 18:44:34]

Done.

+
 namespace IPC {
 
 class SendCallbackHelper;
 
 //-----------------------------------------------------------------------------
 // IPC::ChannelProxy
 //
 // This class is a helper class that is useful when you wish to run an IPC
 // channel on a background thread.  It provides you with the option of either
 // handling IPC messages on that background thread or having them dispatched to
@@ skipping 84 matching lines @@
     // original unchanged if no rewrite indicated.
     virtual Message *Rewrite(Message *message) = 0;
   };
 
   // Initializes a channel proxy.  The channel_handle and mode parameters are
   // passed directly to the underlying IPC::Channel.  The listener is called on
   // the thread that creates the ChannelProxy.  The filter's OnMessageReceived
   // method is called on the thread where the IPC::Channel is running.  The
   // filter may be null if the consumer is not interested in handling messages
   // on the background thread.  Any message not handled by the filter will be
-  // dispatched to the listener.  The given message loop indicates where the
-  // IPC::Channel should be created.
+  // dispatched to the listener.  The given task runner correspond to a thread
+  // on which IPC::Channel is created and used (e.g. IO thread).
   ChannelProxy(const IPC::ChannelHandle& channel_handle,
                Channel::Mode mode,
                Listener* listener,
-               base::MessageLoopProxy* ipc_thread_loop);
+               base::SingleThreadTaskRunner* ipc_task_runner);
 
   virtual ~ChannelProxy();
 
   // Initializes the channel proxy. Only call this once to initialize a channel
   // proxy that was not initialized in its constructor. If create_pipe_now is
   // true, the pipe is created synchronously. Otherwise it's created on the IO
   // thread.
   void Init(const IPC::ChannelHandle& channel_handle, Channel::Mode mode,
             bool create_pipe_now);
 
@@ skipping 20 matching lines @@
   // guaranteed to not miss any messages.  But if you call this anytime after,
   // then some messages might be missed since the filter is added internally on
   // the IO thread.
   void AddFilter(MessageFilter* filter);
   void RemoveFilter(MessageFilter* filter);
 
   void set_outgoing_message_filter(OutgoingMessageFilter* filter) {
     outgoing_message_filter_ = filter;
   }
 
-  // Called to clear the pointer to the IPC message loop when it's going away.
-  void ClearIPCMessageLoop();
+  // Called to clear the pointer to the IPC task runner when it's going away.
+  void ClearIPCTaskRunner();
 
   // Get the process ID for the connected peer.
   // Returns base::kNullProcessId if the peer is not connected yet.
   base::ProcessId peer_pid() const { return context_->peer_pid_; }
 
 #if defined(OS_POSIX) && !defined(OS_NACL)
   // Calls through to the underlying channel's methods.
   int GetClientFileDescriptor();
   int TakeClientFileDescriptor();
   bool GetClientEuid(uid_t* client_euid) const;
 #endif  // defined(OS_POSIX)
 
  protected:
   class Context;
   // A subclass uses this constructor if it needs to add more information
   // to the internal state.
   ChannelProxy(Context* context);
 
   // Used internally to hold state that is referenced on the IPC thread.
   class Context : public base::RefCountedThreadSafe<Context>,
                   public Listener {
    public:
-    Context(Listener* listener, base::MessageLoopProxy* ipc_thread);
-    void ClearIPCMessageLoop() { ipc_message_loop_ = NULL; }
-    base::MessageLoopProxy* ipc_message_loop() const {
-      return ipc_message_loop_.get();
+    Context(Listener* listener, base::SingleThreadTaskRunner* ipc_thread);
+    void ClearIPCTaskRunner();
+    base::SingleThreadTaskRunner* ipc_task_runner() const {
+      return ipc_task_runner_;
     }
     const std::string& channel_id() const { return channel_id_; }
 
     // Dispatches a message on the listener thread.
     void OnDispatchMessage(const Message& message);
 
    protected:
     friend class base::RefCountedThreadSafe<Context>;
     virtual ~Context();
 
@@ skipping 29 matching lines @@
     // Methods called on the IO thread.
     void OnSendMessage(scoped_ptr<Message> message_ptr);
     void OnAddFilter();
     void OnRemoveFilter(MessageFilter* filter);
 
     // Methods called on the listener thread.
     void AddFilter(MessageFilter* filter);
     void OnDispatchConnected();
     void OnDispatchError();
 
-    scoped_refptr<base::MessageLoopProxy> listener_message_loop_;
+    scoped_refptr<base::SingleThreadTaskRunner> listener_task_runner_;
     Listener* listener_;
 
     // List of filters.  This is only accessed on the IPC thread.
     std::vector<scoped_refptr<MessageFilter> > filters_;
-    scoped_refptr<base::MessageLoopProxy> ipc_message_loop_;
+    scoped_refptr<base::SingleThreadTaskRunner> ipc_task_runner_;
     scoped_ptr<Channel> channel_;
     std::string channel_id_;
     bool channel_connected_called_;
 
     // Holds filters between the AddFilter call on the listerner thread and the
     // IPC thread when they're added to filters_.
     std::vector<scoped_refptr<MessageFilter> > pending_filters_;
     // Lock for pending_filters_.
     base::Lock pending_filters_lock_;
 
@@ skipping 18 matching lines @@
 
   OutgoingMessageFilter* outgoing_message_filter_;
 
   // Whether the channel has been initialized.
   bool did_init_;
 };
 
 }  // namespace IPC
 
 #endif  // IPC_IPC_CHANNEL_PROXY_H_