device/serial/data_sink_receiver.h

// Copyright 2014 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 DEVICE_SERIAL_DATA_SINK_RECEIVER_H_
#define DEVICE_SERIAL_DATA_SINK_RECEIVER_H_

#include <queue>

#include "base/callback.h"
#include "base/memory/linked_ptr.h"
#include "base/memory/ref_counted.h"
#include "base/memory/weak_ptr.h"
#include "device/serial/buffer.h"
#include "device/serial/data_stream.mojom.h"
#include "mojo/public/cpp/system/data_pipe.h"

namespace device {

class AsyncWaiter;

class DataSinkReceiver : public base::RefCounted<DataSinkReceiver>,
                         public mojo::InterfaceImpl<serial::DataSink> {
 public:
  typedef base::Callback<void(scoped_ptr<ReadOnlyBuffer>)> ReadyCallback;
  typedef base::Callback<void(int32_t error)> CancelCallback;
  typedef base::Callback<void()> ErrorCallback;

  // Constructs a DataSinkReceiver. Whenever the pipe is ready for reading, the
  // |ready_callback| will be called with the ReadOnlyBuffer to read.
  // |ready_callback| will not be called again until the previous ReadOnlyBuffer
  // is destroyed. If a connection error occurs, |error_callback| will be called
  // and the DataSinkReceiver will act as if ShutDown() had been called. If
  // |cancel_callback| is valid, it will be called when the DataSinkClient
  // requests cancellation of the in-progress read.
  DataSinkReceiver(const ReadyCallback& ready_callback,
                   const CancelCallback& cancel_callback,
                   const ErrorCallback& error_callback);

  // Shuts down this DataSinkReceiver. After shut down, |ready_callback|,
  // |cancel_callback| and |error_callback| will never be called.
  void ShutDown();

 private:
  class Buffer;
  class PendingFlush;
  friend class base::RefCounted<DataSinkReceiver>;

  virtual ~DataSinkReceiver();

  // mojo::InterfaceImpl<serial::DataSink> overrides.
  virtual void Init(mojo::ScopedDataPipeConsumerHandle handle) override;
  virtual void Cancel(int32_t error) override;
  virtual void OnConnectionError() override;

  // Starts waiting for |handle_| to be ready for reads.
  void StartWaiting();

  // Invoked when |handle_| is ready for reads.
  void OnDoneWaiting(MojoResult result);

  // Reports a successful read of |bytes_read|.
  void Done(uint32_t bytes_read);

  // Reports a partially successful or unsuccessful read of |bytes_read|
  // with an error of |error|.
  void DoneWithError(uint32_t bytes_read, int32_t error);

  // Finishes the two-phase data pipe read.
  bool DoneInternal(uint32_t bytes_read);

  // Sends an ReportBytesSentAndError message to the client.
  void ReportBytesSentAndError(uint32_t bytes_read, int32_t error);

  // Invoked in response to an ReportBytesSentAndError call to the client with
  // the number of bytes to flush.
  void SetNumBytesToFlush(uint32_t bytes_to_flush);

  // Reports a fatal error to the client and shuts down.
  void DispatchFatalError();

  // The data connection to the data sender.
  mojo::ScopedDataPipeConsumerHandle handle_;

  // The callback to call when |handle_| has data ready to read.
  const ReadyCallback ready_callback_;

  // The callback to call when the client has requested cancellation.
  const CancelCallback cancel_callback_;

  // The callback to call if a fatal error occurs.
  const ErrorCallback error_callback_;

  // The queue of pending flushes.
  std::queue<linked_ptr<PendingFlush> > pending_flushes_;

  // A waiter used to wait until |handle_| is readable if we are waiting.
  scoped_ptr<AsyncWaiter> waiter_;

  // The buffer passed to |ready_callback_| if one exists. This is not owned,
  // but the Buffer will call Done or DoneWithError before being deleted.
  Buffer* buffer_in_use_;

  // Whether we have encountered a fatal error and shut down.
  bool shut_down_;

  base::WeakPtrFactory<DataSinkReceiver> weak_factory_;

  DISALLOW_COPY_AND_ASSIGN(DataSinkReceiver);
};

}  // namespace device

#endif  // DEVICE_SERIAL_DATA_SINK_RECEIVER_H_