Make DataPipe own an impl.

mojo/edk/system/data_pipe_impl.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 MOJO_EDK_SYSTEM_DATA_PIPE_IMPL_H_
+#define MOJO_EDK_SYSTEM_DATA_PIPE_IMPL_H_
+
+#include <stdint.h>
+
+#include "base/macros.h"
+#include "mojo/edk/embedder/platform_handle_vector.h"
+#include "mojo/edk/system/data_pipe.h"
+#include "mojo/edk/system/handle_signals_state.h"
+#include "mojo/edk/system/memory.h"
+#include "mojo/edk/system/system_impl_export.h"
+#include "mojo/public/c/system/types.h"
+
+namespace mojo {
+namespace system {
+
+class Channel;
+
+class MOJO_SYSTEM_IMPL_EXPORT DataPipeImpl {

[yzshen1, 2015/02/19 18:27:11]

Does it make sense to have comment talk about how this class is used? (owned by
XXX; methods are called under XXX's lock; etc.)

[viettrungluu, 2015/02/19 19:08:46]

Done.

+ public:
+  virtual ~DataPipeImpl() {}
+
+  void set_owner(DataPipe* owner) { owner_ = owner; }
+
+  virtual void ProducerClose() = 0;
+  // |num_bytes.Get()| will be a nonzero multiple of |element_num_bytes_|.

[yzshen1, 2015/02/19 18:27:11]

nit: there isn't a |element_num_bytes_| defined in this class.

[viettrungluu, 2015/02/19 19:08:46]

Done (elsewhere too, obviously).

+  virtual MojoResult ProducerWriteData(UserPointer<const void> elements,
+                                       UserPointer<uint32_t> num_bytes,
+                                       uint32_t max_num_bytes_to_write,
+                                       uint32_t min_num_bytes_to_write) = 0;
+  virtual MojoResult ProducerBeginWriteData(
+      UserPointer<void*> buffer,
+      UserPointer<uint32_t> buffer_num_bytes,
+      uint32_t min_num_bytes_to_write) = 0;
+  virtual MojoResult ProducerEndWriteData(uint32_t num_bytes_written) = 0;
+  // Note: A producer should not be writable during a two-phase write.
+  virtual HandleSignalsState ProducerGetHandleSignalsState() const = 0;
+  virtual void ProducerStartSerialize(Channel* channel,
+                                      size_t* max_size,
+                                      size_t* max_platform_handles) = 0;
+  virtual bool ProducerEndSerialize(
+      Channel* channel,
+      void* destination,
+      size_t* actual_size,
+      embedder::PlatformHandleVector* platform_handles) = 0;
+
+  virtual void ConsumerClose() = 0;
+  // |*num_bytes| will be a nonzero multiple of |element_num_bytes_|.
+  virtual MojoResult ConsumerReadData(UserPointer<void> elements,
+                                      UserPointer<uint32_t> num_bytes,
+                                      uint32_t max_num_bytes_to_read,
+                                      uint32_t min_num_bytes_to_read,
+                                      bool peek) = 0;
+  virtual MojoResult ConsumerDiscardData(UserPointer<uint32_t> num_bytes,
+                                         uint32_t max_num_bytes_to_discard,
+                                         uint32_t min_num_bytes_to_discard) = 0;
+  // |*num_bytes| will be a nonzero multiple of |element_num_bytes_|.
+  virtual MojoResult ConsumerQueryData(UserPointer<uint32_t> num_bytes) = 0;
+  virtual MojoResult ConsumerBeginReadData(
+      UserPointer<const void*> buffer,
+      UserPointer<uint32_t> buffer_num_bytes,
+      uint32_t min_num_bytes_to_read) = 0;
+  virtual MojoResult ConsumerEndReadData(uint32_t num_bytes_read) = 0;
+  // Note: A consumer should not be writable during a two-phase read.
+  virtual HandleSignalsState ConsumerGetHandleSignalsState() const = 0;
+  virtual void ConsumerStartSerialize(Channel* channel,
+                                      size_t* max_size,
+                                      size_t* max_platform_handles) = 0;
+  virtual bool ConsumerEndSerialize(
+      Channel* channel,
+      void* destination,
+      size_t* actual_size,
+      embedder::PlatformHandleVector* platform_handles) = 0;
+
+ protected:
+  DataPipeImpl() : owner_() {}
+
+  DataPipe* owner() const { return owner_; }
+
+  bool may_discard() const { return owner_->may_discard(); }
+  size_t element_num_bytes() const { return owner_->element_num_bytes(); }
+  size_t capacity_num_bytes() const { return owner_->capacity_num_bytes(); }
+  bool producer_open() const { return owner_->producer_open_no_lock(); }
+  bool consumer_open() const { return owner_->consumer_open_no_lock(); }
+  uint32_t producer_two_phase_max_num_bytes_written() const {
+    return owner_->producer_two_phase_max_num_bytes_written_no_lock();
+  }
+  uint32_t consumer_two_phase_max_num_bytes_read() const {
+    return owner_->consumer_two_phase_max_num_bytes_read_no_lock();
+  }
+  void set_producer_two_phase_max_num_bytes_written(uint32_t num_bytes) {
+    owner_->set_producer_two_phase_max_num_bytes_written_no_lock(num_bytes);
+  }
+  void set_consumer_two_phase_max_num_bytes_read(uint32_t num_bytes) {
+    owner_->set_consumer_two_phase_max_num_bytes_read_no_lock(num_bytes);
+  }
+  bool producer_in_two_phase_write() const {
+    return owner_->producer_in_two_phase_write_no_lock();
+  }
+  bool consumer_in_two_phase_read() const {
+    return owner_->consumer_in_two_phase_read_no_lock();
+  }
+
+ private:
+  DataPipe* owner_;
+
+  DISALLOW_COPY_AND_ASSIGN(DataPipeImpl);
+};
+
+}  // namespace system
+}  // namespace mojo
+
+#endif  // MOJO_EDK_SYSTEM_DATA_PIPE_IMPL_H_