ipc: Move methods into AttachmentBroker interface.

ipc/attachment_broker.h

 // Copyright 2015 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_ATTACHMENT_BROKER_H_
 #define IPC_ATTACHMENT_BROKER_H_
 
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/process/process_handle.h"
 #include "ipc/brokerable_attachment.h"
 #include "ipc/ipc_export.h"
 #include "ipc/ipc_listener.h"
 
 // If the platform has no attachments that need brokering, then it shouldn't
 // compile any code that calls member functions of AttachmentBroker. This
 // prevents symbols only used by AttachmentBroker and its subclasses from
 // making it into the binary.
 #if defined(OS_WIN) || (defined(OS_MACOSX) && !defined(OS_IOS))
 #define USE_ATTACHMENT_BROKER 1
 #else
 #define USE_ATTACHMENT_BROKER 0
 #endif  // defined(OS_WIN)
 
+#if defined(OS_MACOSX) && !defined(OS_IOS)
+namespace base {
+class PortProvider;
+}  // namespace base
+#endif  // defined(OS_MACOSX) && !defined(OS_IOS)
+
 namespace IPC {
 
 class AttachmentBroker;
+class Endpoint;
+
 // Classes that inherit from this abstract base class are capable of
 // communicating with a broker to send and receive attachments to Chrome IPC
 // messages.
 class IPC_EXPORT SupportsAttachmentBrokering {
  public:
   // Returns an AttachmentBroker used to broker attachments of IPC messages to
   // other processes. There must be exactly one AttachmentBroker per process.
   virtual AttachmentBroker* GetAttachmentBroker() = 0;
 };
 
@@ skipping 30 matching lines @@
 
   // Returns whether the attachment was available. If the attachment was
   // available, populates the output parameter |attachment|.
   bool GetAttachmentWithId(BrokerableAttachment::AttachmentId id,
                            scoped_refptr<BrokerableAttachment>* attachment);
 
   // Any given observer should only ever add itself once to the observer list.
   void AddObserver(Observer* observer);
   void RemoveObserver(Observer* observer);
 
+  // These two methods should only be called by the broker process.
+  //
+  // Each unprivileged process should have one IPC channel on which it
+  // communicates attachment information with the broker process. In the broker
+  // process, these channels must be registered and deregistered with the
+  // Attachment Broker as they are created and destroyed.
+  virtual void RegisterCommunicationChannel(Endpoint* endpoint);
+  virtual void DeregisterCommunicationChannel(Endpoint* endpoint);
+
+#if defined(OS_MACOSX) && !defined(OS_IOS)
+  // This method should only be called by the broker process.
+  //
+  // The port provider must live as long as the AttachmentBroker. A port
+  // provider must be set before any attachment brokering occurs.
+  void set_port_provider(base::PortProvider* port_provider) {
+    CHECK(!port_provider_);

[Tom Sepez, 2015/10/21 17:59:15]

DCHECK().  Check in a privileged process is usually undesirable.

[erikchen, 2015/10/21 18:05:28]

Done.

+    port_provider_ = port_provider;
+  }
+#endif  // defined(OS_MACOSX) && !defined(OS_IOS)
+
  protected:
   using AttachmentVector = std::vector<scoped_refptr<BrokerableAttachment>>;
 
   // Adds |attachment| to |attachments_|, and notifies the observers.
   void HandleReceivedAttachment(
       const scoped_refptr<BrokerableAttachment>& attachment);
 
   // Informs the observers that a new BrokerableAttachment has been received.
   void NotifyObservers(const BrokerableAttachment::AttachmentId& id);
 
   // This method is exposed for testing only.
   AttachmentVector* get_attachments() { return &attachments_; }
 
+#if defined(OS_MACOSX) && !defined(OS_IOS)
+  base::PortProvider* get_port_provider() { return port_provider_; }

[Tom Sepez, 2015/10/21 17:59:15]

nit: const method, typical naming is just port_provider().

[erikchen, 2015/10/21 18:05:28]

Done.

+#endif  // defined(OS_MACOSX) && !defined(OS_IOS)
+
  private:
 #if defined(OS_WIN)
   FRIEND_TEST_ALL_PREFIXES(AttachmentBrokerUnprivilegedWinTest,
                            ReceiveValidMessage);
   FRIEND_TEST_ALL_PREFIXES(AttachmentBrokerUnprivilegedWinTest,
                            ReceiveInvalidMessage);
 #endif  // defined(OS_WIN)
 
+#if defined(OS_MACOSX) && !defined(OS_IOS)
+  base::PortProvider* port_provider_;
+#endif  // defined(OS_MACOSX) && !defined(OS_IOS)
+
   // A vector of BrokerableAttachments that have been received, but not yet
   // consumed.
   // A std::vector is used instead of a std::map because this container is
   // expected to have few elements, for which a std::vector is expected to have
   // better performance.
   AttachmentVector attachments_;
 
   std::vector<Observer*> observers_;
   DISALLOW_COPY_AND_ASSIGN(AttachmentBroker);
 };
 
 }  // namespace IPC
 
 #endif  // IPC_ATTACHMENT_BROKER_H_