ACE/ace/FIFO_Recv.h

   1 // -*- C++ -*-
   2
   3 //==========================================================================
   4 /**
   5  *  @file    FIFO_Recv.h
   6  *
   7  *  @author Doug Schmidt
   8  */
   9 //==========================================================================
  10
  11
  12 #ifndef ACE_FIFO_RECV_H
  13 #define ACE_FIFO_RECV_H
  14
  15 #include /**/ "ace/pre.h"
  16
  17 #include "ace/FIFO.h"
  18
  19 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  20 # pragma once
  21 #endif /* ACE_LACKS_PRAGMA_ONCE */
  22
  23 #include "ace/os_include/os_fcntl.h"
  24 #include "ace/Default_Constants.h"
  25
  26 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  27
  28 /**
  29  * @class ACE_FIFO_Recv
  30  *
  31  * @brief Receiver side of the bytestream C++ wrapper for UNIX
  32  * FIFOs.
  33  */
  34 class ACE_Export ACE_FIFO_Recv : public ACE_FIFO
  35 {
  36 public:
  37   /// @name Initialization methods.
  38   ///
  39   /// Note that @c ACE_NONBLOCK will be added to any @a flags value passed.
  40   /// This causes the open to succeed even if no writer has yet opened the
  41   /// fifo. There is no way to disable this behavior.
  42   ///
  43   /// @arg persistent  Means "open fifo for writing, as well as
  44   /// reading."  This ensures that the fifo never gets EOF, even if there
  45   /// aren't any writers at the moment!
  46   //@{
  47   /// Default constructor.
  48   ACE_FIFO_Recv ();
  49
  50   /// Open up a bytestream named pipe for reading.
  51   ACE_FIFO_Recv (const ACE_TCHAR *rendezvous,
  52                  int flags = O_CREAT | O_RDONLY,
  53                  mode_t perms = ACE_DEFAULT_FILE_PERMS,
  54                  int persistent = 1,
  55                  LPSECURITY_ATTRIBUTES sa = 0);
  56
  57   /// Open up a bytestream named pipe for reading.
  58   int open (const ACE_TCHAR *rendezvous,
  59             int flags = O_CREAT | O_RDONLY,
  60             mode_t perms = ACE_DEFAULT_FILE_PERMS,
  61             int persistent = 1,
  62             LPSECURITY_ATTRIBUTES sa = 0);
  63   //@}
  64
  65   /// Close down the fifo.
  66   int close ();
  67
  68   /// Recv @a buf of up to @a len bytes.
  69   ssize_t recv (void *buf, size_t len);
  70
  71   /// Recv @a buf of exactly @a len bytes (block until done).
  72   ssize_t recv_n (void *buf, size_t len);
  73
  74   /// Dump the state of an object.
  75   void dump () const;
  76
  77   /// Declare the dynamic allocation hooks.
  78   ACE_ALLOC_HOOK_DECLARE;
  79
  80 private:
  81   /// Auxiliary handle that is used to implement persistent FIFOs.
  82   ACE_HANDLE aux_handle_;
  83 };
  84
  85 ACE_END_VERSIONED_NAMESPACE_DECL
  86
  87 #if defined (__ACE_INLINE__)
  88 #include "ace/FIFO_Recv.inl"
  89 #endif /* __ACE_INLINE__ */
  90
  91 #include /**/ "ace/post.h"
  92
  93 #endif /* ACE_FIFO_RECV_H */