dep/ACE_wrappers/ace/FIFO_Send_Msg.h

   1 /* -*- C++ -*- */
   2
   3 //=============================================================================
   4 /**
   5  *  @file    FIFO_Send_Msg.h
   6  *
   7  *  $Id: FIFO_Send_Msg.h 80826 2008-03-04 14:51:23Z wotte $
   8  *
   9  *  @author Doug Schmidt
  10  */
  11 //=============================================================================
  12
  13
  14 #ifndef ACE_FIFO_SEND_MSG_H
  15 #define ACE_FIFO_SEND_MSG_H
  16 #include /**/ "ace/pre.h"
  17
  18 #include "ace/FIFO_Send.h"
  19
  20 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  21 # pragma once
  22 #endif /* ACE_LACKS_PRAGMA_ONCE */
  23
  24 #if defined (ACE_HAS_STREAM_PIPES)
  25 #  include "ace/OS_NS_stropts.h"
  26 #endif /* ACE_HAS_STREAM_PIPES */
  27
  28 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  29
  30 // Forward Decls
  31 class ACE_Str_Buf;
  32
  33 /**
  34  * @class ACE_FIFO_Send_Msg
  35  *
  36  * @brief Sender side for the Record oriented C++ wrapper for UNIX
  37  * FIFOs.
  38  */
  39 class ACE_Export ACE_FIFO_Send_Msg : public ACE_FIFO_Send
  40 {
  41 public:
  42   // = Initialization methods.
  43   /// Default constructor.
  44   ACE_FIFO_Send_Msg (void);
  45
  46   /// Open up a record-oriented named pipe for writing.
  47   ACE_FIFO_Send_Msg (const ACE_TCHAR *rendezvous,
  48                      int flags = O_WRONLY,
  49                      mode_t perms = ACE_DEFAULT_FILE_PERMS,
  50                      LPSECURITY_ATTRIBUTES sa = 0);
  51
  52   /// Open up a record-oriented named pipe for writing.
  53   int open (const ACE_TCHAR *rendezvous,
  54             int flags = O_WRONLY,
  55             mode_t perms = ACE_DEFAULT_FILE_PERMS,
  56             LPSECURITY_ATTRIBUTES sa = 0);
  57
  58   /// Send @a buf of up to @a len bytes.
  59   ssize_t send (const ACE_Str_Buf &msg);
  60
  61   /// Send @a buf of exactly @a len bytes (block until done).
  62   ssize_t send (const void *buf, size_t len);
  63
  64 #if defined (ACE_HAS_STREAM_PIPES)
  65   /// Send <data> and <cntl> message via Stream pipes.
  66   ssize_t send (const ACE_Str_Buf *data,
  67                 const ACE_Str_Buf *cntl = 0,
  68                 int flags = 0);
  69
  70   /// Send <data> and <cntl> message via Stream pipes in "band" mode.
  71   ssize_t send (int band,
  72                 const ACE_Str_Buf *data,
  73                 const ACE_Str_Buf *cntl = 0,
  74                 int flags = MSG_BAND);
  75 #endif /* ACE_HAS_STREAM_PIPES */
  76
  77   /// Dump the state of an object.
  78   void dump (void) const;
  79
  80   /// Declare the dynamic allocation hooks.
  81   ACE_ALLOC_HOOK_DECLARE;
  82 };
  83
  84 ACE_END_VERSIONED_NAMESPACE_DECL
  85
  86 #if defined (__ACE_INLINE__)
  87 #include "ace/FIFO_Send_Msg.inl"
  88 #endif /* __ACE_INLINE__ */
  89
  90 #include /**/ "ace/post.h"
  91 #endif /* ACE_FIFO_SEND_MSG_H */