Refactor PPAPI proxy resource handling to maintain which host they came from,...

ppapi/proxy/dispatcher.h

 // Copyright (c) 2010 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 PPAPI_PROXY_DISPATCHER_H_
 #define PPAPI_PROXY_DISPATCHER_H_
 
 #include <map>
 #include <string>
 #include <vector>
@@ skipping 11 matching lines @@
 
 class MessageLoop;
 struct PPB_Var_Deprecated;
 
 namespace base {
 class WaitableEvent;
 }
 
 namespace IPC {
 class SyncChannel;
+class TestSink;
 }
 
 namespace pp {
 namespace proxy {
 
 class InterfaceProxy;
 class VarSerializationRules;
 
 // An interface proxy can represent either end of a cross-process interface
 // call. The "source" side is where the call is invoked, and the "target" side
@@ skipping 11 matching lines @@
 //                                      |
 class Dispatcher : public IPC::Channel::Listener,
                    public IPC::Message::Sender {
  public:
   typedef const void* (*GetInterfaceFunc)(const char*);
   typedef int32_t (*InitModuleFunc)(PP_Module, GetInterfaceFunc);
   typedef void (*ShutdownModuleFunc)();
 
   ~Dispatcher();
 
+  // You must call this function before anything else. Returns true on success.
   bool InitWithChannel(MessageLoop* ipc_message_loop,
                        const IPC::ChannelHandle& channel_handle,
                        bool is_client,
                        base::WaitableEvent* shutdown_event);
 
+  // Alternative to InitWithChannel() for unit tests that want to send all
+  // messages sent via this dispatcher to the given test sink. The test sink
+  // must outlive this class.
+  void InitWithTestSink(IPC::TestSink* test_sink);
+
   // Returns true if the dispatcher is on the plugin side, or false if it's the
   // browser side.
   virtual bool IsPlugin() const = 0;
 
   VarSerializationRules* serialization_rules() const {
     return serialization_rules_.get();
   }
   PP_Module pp_module() const {
     return pp_module_;
   }
@@ skipping 19 matching lines @@
   // Called if the remote side is declaring to us which interfaces it supports
   // so we don't have to query for each one. We'll pre-create proxies for
   // each of the given interfaces.
 
   // IPC::Message::Sender implementation.
   virtual bool Send(IPC::Message* msg);
 
   // IPC::Channel::Listener implementation.
   virtual bool OnMessageReceived(const IPC::Message& msg);
 
+  // Will be NULL in some unit tests.
   IPC::SyncChannel* channel() const {
     return channel_.get();
   }
 
   CallbackTracker& callback_tracker() {
     return callback_tracker_;
   }
 
  protected:
   Dispatcher(base::ProcessHandle remote_process_handle,
@@ skipping 40 matching lines @@
   // proxyable.
   bool SetupProxyForTargetInterface(const std::string& interface);
 
   bool IsInterfaceTrusted(const std::string& interface);
 
   // Set by the derived classed to indicate the module ID corresponding to
   // this dispatcher.
   PP_Module pp_module_;
 
   base::ProcessHandle remote_process_handle_;  // See getter above.
+
+  // When we're unit testing, this will indicate the sink for the messages to
+  // be deposited so they can be inspected by the test. When non-NULL, this
+  // indicates that the channel should not be used.
+  IPC::TestSink* test_sink_;
+
+  // Will be null for some tests when there is a test_sink_.
   scoped_ptr<IPC::SyncChannel> channel_;
 
   bool disallow_trusted_interfaces_;
 
   GetInterfaceFunc local_get_interface_;
 
   ProxyMap proxies_;
   InterfaceProxy* id_to_proxy_[INTERFACE_ID_COUNT];
 
   // True if the remote side has declared which interfaces it supports in
@@ skipping 11 matching lines @@
 
   scoped_ptr<VarSerializationRules> serialization_rules_;
 
   DISALLOW_COPY_AND_ASSIGN(Dispatcher);
 };
 
 }  // namespace proxy
 }  // namespace pp
 
 #endif  // PPAPI_PROXY_DISPATCHER_H_