ACE/ace/IO_Cntl_Msg.h

   1 // -*- C++ -*-
   2
   3 //==========================================================================
   4 /**
   5  *  @file    IO_Cntl_Msg.h
   6  *
   7  *  @author Doug Schmidt
   8  */
   9 //==========================================================================
  10
  11
  12 #ifndef ACE_IO_CNTL_MSG_H
  13 #define ACE_IO_CNTL_MSG_H
  14
  15 #include /**/ "ace/pre.h"
  16
  17 #include /**/ "ace/ACE_export.h"
  18 #include "ace/os_include/os_stddef.h"
  19
  20 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  21 # pragma once
  22 #endif /* ACE_LACKS_PRAGMA_ONCE */
  23
  24 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  25
  26 /**
  27  * @class ACE_IO_Cntl_Msg
  28  *
  29  * @brief Data format for IOCTL messages
  30  */
  31 class ACE_Export ACE_IO_Cntl_Msg
  32 {
  33 public:
  34   enum
  35   {
  36     /// Set the low water mark.
  37     SET_LWM    = 1,
  38     /// Get the low water mark.
  39     GET_LWM    = 2,
  40     /// Set the high water mark.
  41     SET_HWM    = 3,
  42     /// Get the high water mark.
  43     GET_HWM    = 4,
  44     /// Link modules
  45     MOD_LINK   = 5,
  46     /// Unlink modules
  47     MOD_UNLINK = 6
  48   };
  49
  50   typedef unsigned short ACE_IO_Cntl_Cmds;
  51
  52   /// Initialize the control message.
  53   ACE_IO_Cntl_Msg (ACE_IO_Cntl_Cmds c);
  54
  55   // = Get/set methods
  56
  57   /// Get command.
  58   ACE_IO_Cntl_Cmds cmd ();
  59
  60   /// Set command.
  61   void cmd (ACE_IO_Cntl_Cmds c);
  62
  63   /// Get count.
  64   size_t count ();
  65
  66   /// Set count.
  67   void count (size_t c);
  68
  69   /// Get error.
  70   int error ();
  71
  72   /// Set error.
  73   void error (int e);
  74
  75   /// Get return value.
  76   int rval ();
  77
  78   /// Set return value.
  79   void rval (int r);
  80
  81   /// Dump the state of an object.
  82   void dump () const;
  83
  84   /// Declare the dynamic allocation hooks.
  85   ACE_ALLOC_HOOK_DECLARE;
  86
  87 private:
  88   /// Command.
  89   ACE_IO_Cntl_Cmds cmd_;
  90
  91   /// Count.
  92   size_t count_;
  93
  94   /// Error.
  95   int error_;
  96
  97   /// Return value
  98   int rval_;
  99 };
 100
 101 ACE_END_VERSIONED_NAMESPACE_DECL
 102
 103 #if defined (__ACE_INLINE__)
 104 #include "ace/IO_Cntl_Msg.inl"
 105 #endif /* __ACE_INLINE__ */
 106
 107 #include /**/ "ace/post.h"
 108
 109 #endif /* ACE_IO_CNTL_MSG_H */