src/mojo/system/data_pipe_consumer_dispatcher.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef MOJO_SYSTEM_DATA_PIPE_CONSUMER_DISPATCHER_H_
   6 #define MOJO_SYSTEM_DATA_PIPE_CONSUMER_DISPATCHER_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/compiler_specific.h"
  10 #include "base/memory/ref_counted.h"
  11 #include "mojo/system/dispatcher.h"
  12 #include "mojo/system/system_impl_export.h"
  13
  14 namespace mojo {
  15 namespace system {
  16
  17 class DataPipe;
  18
  19 // This is the |Dispatcher| implementation for the consumer handle for data
  20 // pipes (created by the Mojo primitive |MojoCreateDataPipe()|). This class is
  21 // thread-safe.
  22 class MOJO_SYSTEM_IMPL_EXPORT DataPipeConsumerDispatcher : public Dispatcher {
  23  public:
  24   DataPipeConsumerDispatcher();
  25
  26   // Must be called before any other methods.
  27   void Init(scoped_refptr<DataPipe> data_pipe);
  28
  29   virtual Type GetType() const OVERRIDE;
  30
  31  private:
  32   friend class base::RefCountedThreadSafe<DataPipeConsumerDispatcher>;
  33   virtual ~DataPipeConsumerDispatcher();
  34
  35   // |Dispatcher| implementation/overrides:
  36   virtual void CancelAllWaitersNoLock() OVERRIDE;
  37   virtual void CloseImplNoLock() OVERRIDE;
  38   virtual scoped_refptr<Dispatcher>
  39       CreateEquivalentDispatcherAndCloseImplNoLock() OVERRIDE;
  40   virtual MojoResult ReadDataImplNoLock(void* elements,
  41                                         uint32_t* num_bytes,
  42                                         MojoReadDataFlags flags) OVERRIDE;
  43   virtual MojoResult BeginReadDataImplNoLock(const void** buffer,
  44                                              uint32_t* buffer_num_bytes,
  45                                              MojoReadDataFlags flags) OVERRIDE;
  46   virtual MojoResult EndReadDataImplNoLock(uint32_t num_bytes_read) OVERRIDE;
  47   virtual MojoResult AddWaiterImplNoLock(Waiter* waiter,
  48                                          MojoWaitFlags flags,
  49                                          MojoResult wake_result) OVERRIDE;
  50   virtual void RemoveWaiterImplNoLock(Waiter* waiter) OVERRIDE;
  51   virtual bool IsBusyNoLock() const OVERRIDE;
  52
  53   // Protected by |lock()|:
  54   scoped_refptr<DataPipe> data_pipe_;  // This will be null if closed.
  55
  56   DISALLOW_COPY_AND_ASSIGN(DataPipeConsumerDispatcher);
  57 };
  58
  59 }  // namespace system
  60 }  // namespace mojo
  61
  62 #endif  // MOJO_SYSTEM_DATA_PIPE_CONSUMER_DISPATCHER_H_