IPC: Introduce MessageAttachment and PlatformFileAttachment.

ipc/ipc_message_attachment_set.h

 // Copyright (c) 2011 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_MESSAGE_ATTACHMENT_SET_H_
 #define IPC_IPC_MESSAGE_ATTACHMENT_SET_H_
 
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_vector.h"
 #include "ipc/ipc_export.h"
 
 #if defined(OS_POSIX)
 #include "base/files/file.h"
 #endif
 
 namespace IPC {
 
+class MessageAttachment;
+
 // -----------------------------------------------------------------------------
 // A MessageAttachmentSet is an ordered set of POSIX file descriptors. These are
 // associated with IPC messages so that descriptors can be transmitted over a
 // UNIX domain socket.
 // -----------------------------------------------------------------------------
 class IPC_EXPORT MessageAttachmentSet
     : public base::RefCountedThreadSafe<MessageAttachmentSet> {
  public:
   MessageAttachmentSet();
 
-  // Return the number of descriptors
+  // Return the number of attachmentes

[agl, 2015/01/15 03:00:53]

attachments

[Hajime Morrita, 2015/01/23 00:29:05]

Done.

   unsigned size() const;
+  // Return the number of file descriptors
+  unsigned file_size() const;

[agl, 2015/01/15 03:00:53]

file_size seems like a poor name for this.

num_fds()? num_descriptors()?

[Hajime Morrita, 2015/01/23 00:29:05]

Makes sense. Renamed to num_descriptors().

   // Return true if no unconsumed descriptors remain
   bool empty() const { return 0 == size(); }
 
+  void AddAttachment(scoped_refptr<MessageAttachment> attachment);
+  scoped_refptr<MessageAttachment> TakeAttachmentAt(unsigned index);

[agl, 2015/01/15 03:00:53]

It's called TakeAttachmentAt, but it returns a reference—not ownership. Should
it have the word "Take" in the name?

[Hajime Morrita, 2015/01/23 00:29:05]

Uh, the name was leftover of my failed experiment. Ranamed to Get...().

+
 #if defined(OS_POSIX)
   // This is the maximum number of descriptors per message. We need to know this
   // because the control message kernel interface has to be given a buffer which
   // is large enough to store all the descriptor numbers. Otherwise the kernel
   // tells us that it truncated the control data and the extra descriptors are
   // lost.
   //
   // In debugging mode, it's a fatal error to try and add more than this number
   // of descriptors to a MessageAttachmentSet.
   static const size_t kMaxDescriptorsPerMessage = 7;
@@ skipping 52 matching lines @@
 
 #endif  // OS_POSIX
 
   // ---------------------------------------------------------------------------
 
  private:
   friend class base::RefCountedThreadSafe<MessageAttachmentSet>;
 
   ~MessageAttachmentSet();
 
+  // A vector of attachments of the message, which might be |PlatformFile| or
+  // |MessagePipe|.
+  std::vector<scoped_refptr<MessageAttachment>> attachments_;
+
 #if defined(OS_POSIX)
-  // A vector of descriptors and close flags. If this message is sent, then
-  // these descriptors are sent as control data. After sending, any descriptors
-  // with a true flag are closed. If this message has been received, then these
-  // are the descriptors which were received and all close flags are true.
-  std::vector<base::PlatformFile> descriptors_;
+  // A vector of owning descriptors If this message is sent, then file

[agl, 2015/01/15 03:00:53]

. after "descriptors"

[Hajime Morrita, 2015/01/23 00:29:05]

Done.

+  // descriptors are sent as control data. After sending, any owning descriptors
+  // are closed. If this message has been received, then all received

[agl, 2015/01/15 03:00:53]

no comma before "then" (existing issue).

[Hajime Morrita, 2015/01/23 00:29:05]

Done.

+  // descriptors are owned by this message.
   ScopedVector<base::ScopedFD> owned_descriptors_;
 #endif
 
   // This contains the index of the next descriptor which should be consumed.
   // It's used in a couple of ways. Firstly, at destruction we can check that
   // all the descriptors have been read (with GetNthDescriptor). Secondly, we
   // can check that they are read in order.
   mutable unsigned consumed_descriptor_highwater_;
 
   DISALLOW_COPY_AND_ASSIGN(MessageAttachmentSet);
 };
 
 }  // namespace IPC
 
 #endif  // IPC_IPC_MESSAGE_ATTACHMENT_SET_H_