ACE/ace/FIFO_Send.h

   1 // -*- C++ -*-
   2
   3 //==========================================================================
   4 /**
   5  *  @file    FIFO_Send.h
   6  *
   7  *  @author Doug Schmidt
   8  */
   9 //==========================================================================
  10
  11 #ifndef ACE_FIFO_SEND_H
  12 #define ACE_FIFO_SEND_H
  13
  14 #include /**/ "ace/pre.h"
  15
  16 #include "ace/FIFO.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "ace/os_include/os_fcntl.h"
  23 #include "ace/Default_Constants.h"
  24
  25 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  26
  27 /**
  28  * @class ACE_FIFO_Send
  29  *
  30  * @brief Sender side for the bytestream C++ wrapper for UNIX FIFOs
  31  */
  32 class ACE_Export ACE_FIFO_Send : public ACE_FIFO
  33 {
  34 public:
  35   /// @name Initialization methods.
  36   ///
  37   /// Note that @c O_WRONLY will be added to any @a flags value passed.
  38   /// Default behavior is to block until a receiver also opens the fifo.
  39   /// To use non-blocking behavior include ACE_NONBLOCK in @a flags.
  40   //@{
  41   /// Default constructor.
  42   ACE_FIFO_Send (void);
  43
  44   /// Open up a bytestream named pipe for writing.
  45   ACE_FIFO_Send (const ACE_TCHAR *rendezvous,
  46                  int flags = O_WRONLY,
  47                  mode_t perms = ACE_DEFAULT_FILE_PERMS,
  48                  LPSECURITY_ATTRIBUTES sa = 0);
  49
  50   /// Open up a bytestream named pipe for writing.
  51   int open (const ACE_TCHAR *rendezvous,
  52             int flags = O_WRONLY,
  53             mode_t perms = ACE_DEFAULT_FILE_PERMS,
  54             LPSECURITY_ATTRIBUTES sa = 0);
  55   //@}
  56
  57   /// Send @a buf of up to @a len bytes.
  58   ssize_t send (const void *buf, size_t len);
  59
  60   /// Send @a buf of exactly @a len bytes (block until done).
  61   ssize_t send_n (const void *buf, size_t len);
  62
  63   /// Dump the state of an object.
  64   void dump () const;
  65
  66   /// Declare the dynamic allocation hooks.
  67   ACE_ALLOC_HOOK_DECLARE;
  68 };
  69
  70 ACE_END_VERSIONED_NAMESPACE_DECL
  71
  72 #if defined (__ACE_INLINE__)
  73 #include "ace/FIFO_Send.inl"
  74 #endif /* __ACE_INLINE__ */
  75
  76 #include /**/ "ace/post.h"
  77
  78 #endif /* ACE_FIFO_SEND_H */