dep/ACE_wrappers/ace/Typed_SV_Message.h

   1 // -*- C++ -*-
   2
   3 //==========================================================================
   4 /**
   5  *  @file    Typed_SV_Message.h
   6  *
   7  *  $Id: Typed_SV_Message.h 80826 2008-03-04 14:51:23Z wotte $
   8  *
   9  *  @author Doug Schmidt
  10  */
  11 //==========================================================================
  12
  13
  14 #ifndef ACE_TYPED_SV_MESSAGE_H
  15 #define ACE_TYPED_SV_MESSAGE_H
  16
  17 #include /**/ "ace/pre.h"
  18
  19 #include /**/ "ace/ACE_export.h"
  20
  21 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  22 # pragma once
  23 #endif /* ACE_LACKS_PRAGMA_ONCE */
  24
  25 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  26
  27 /**
  28  * @class ACE_Typed_SV_Message
  29  *
  30  * @brief Defines the header file for the C++ wrapper for System V
  31  * message queues.
  32  */
  33 template <class T>
  34 class ACE_Typed_SV_Message
  35 {
  36 public:
  37   // = Initialization and termination methods.
  38   ACE_Typed_SV_Message (long type = 0,
  39                         int length = sizeof (T),
  40                         int max_size = sizeof (T));
  41   ACE_Typed_SV_Message (const T &data,
  42                         long type = 0,
  43                         int length = sizeof (T),
  44                         int max_size = sizeof (T));
  45   ~ACE_Typed_SV_Message (void);
  46
  47   /// Get the type of the message.
  48   long type (void) const;
  49
  50   /// Set the type of the message.
  51   void type (long type);
  52
  53   /// Get the length of the message.
  54   int length (void) const;
  55
  56   /// Set the length of the message.
  57   void length (int l);
  58
  59   /// Get the maximum size of the message.
  60   int max_size (void) const;
  61
  62   /// Set the maximum size of the message.
  63   void max_size (int m);
  64
  65   /// Get a pointer to the data in the message.
  66   T &data (void);
  67
  68   /// Set a pointer to the data in the message.
  69   void data (const T &data);
  70
  71   /// Dump the state of an object.
  72   void dump (void) const;
  73
  74   /// Declare the dynamic allocation hooks.
  75   ACE_ALLOC_HOOK_DECLARE;
  76
  77 private:
  78   /// Type of message.
  79   long type_;
  80
  81   /// Length of this message.
  82   int length_;
  83
  84   /// Maximum length of any message.
  85   int max_;
  86
  87   /// Data stored in a message.
  88   T data_;
  89 };
  90
  91 ACE_END_VERSIONED_NAMESPACE_DECL
  92
  93 #if defined (__ACE_INLINE__)
  94 #include "ace/Typed_SV_Message.inl"
  95 #endif /* __ACE_INLINE__ */
  96
  97 #if defined (ACE_TEMPLATES_REQUIRE_SOURCE)
  98 #include "ace/Typed_SV_Message.cpp"
  99 #endif /* ACE_TEMPLATES_REQUIRE_SOURCE */
 100
 101 #if defined (ACE_TEMPLATES_REQUIRE_PRAGMA)
 102 #pragma implementation ("Typed_SV_Message.cpp")
 103 #endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */
 104
 105 #include /**/ "ace/post.h"
 106
 107 #endif /* ACE_TYPED_SV_MESSAGE_H */