ACE_Typed_SV_Message< T > Class Template Reference

Defines the header file for the C++ wrapper for System V message queues. More...

#include <Typed_SV_Message.h>

Collaboration diagram for ACE_Typed_SV_Message< T >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ACE_Typed_SV_Message (long type=0, int length=sizeof(T), int max_size=sizeof(T))
 ACE_Typed_SV_Message (const T &data, long type=0, int length=sizeof(T), int max_size=sizeof(T))
 ~ACE_Typed_SV_Message (void)
long type (void) const
 Get the type of the message.
void type (long type)
 Set the type of the message.
int length (void) const
 Get the length of the message.
void length (int l)
 Set the length of the message.
int max_size (void) const
 Get the maximum size of the message.
void max_size (int m)
 Set the maximum size of the message.
T & data (void)
 Get a pointer to the data in the message.
void data (const T &data)
 Set a pointer to the data in the message.
void dump (void) const
 Dump the state of an object.

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.

Private Attributes

long type_
 Type of message.
int length_
 Length of this message.
int max_
 Maximum length of any message.
T data_
 Data stored in a message.

Detailed Description

template<class T>
class ACE_Typed_SV_Message< T >

Defines the header file for the C++ wrapper for System V message queues.

Definition at line 34 of file Typed_SV_Message.h.

Constructor & Destructor Documentation

template<class T>
ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE ACE_Typed_SV_Message< T >::ACE_Typed_SV_Message ( long  type = 0,
int  length = sizeof(T),
int  max_size = sizeof(T) 
)

Definition at line 11 of file Typed_SV_Message.inl.

References ACE_TRACE, ACE_Typed_SV_Message< T >::length(), and ACE_Typed_SV_Message< T >::max_size().

00014   : type_ (t)
00015 {
00016   ACE_TRACE ("ACE_Typed_SV_Message<T>::ACE_Typed_SV_Message");
00017   this->length (l);
00018   this->max_size (m);
00019 }

template<class T>
ACE_INLINE ACE_Typed_SV_Message< T >::ACE_Typed_SV_Message ( const T &  data,
long  type = 0,
int  length = sizeof(T),
int  max_size = sizeof(T) 
)

Definition at line 22 of file Typed_SV_Message.inl.

References ACE_TRACE, ACE_Typed_SV_Message< T >::length(), and ACE_Typed_SV_Message< T >::max_size().

00026   : type_ (t),
00027     data_ (d)
00028 {
00029   ACE_TRACE ("ACE_Typed_SV_Message<T>::ACE_Typed_SV_Message");
00030   this->length (l);
00031   this->max_size (m);
00032 }

template<class T>
ACE_INLINE ACE_Typed_SV_Message< T >::~ACE_Typed_SV_Message ( void   ) 

Definition at line 35 of file Typed_SV_Message.inl.

References ACE_TRACE.

00036 {
00037   ACE_TRACE ("ACE_Typed_SV_Message<T>::~ACE_Typed_SV_Message");
00038 }

Member Function Documentation

template<class T>
void ACE_Typed_SV_Message< T >::data ( const T &  data  ) 

Set a pointer to the data in the message.

Definition at line 90 of file Typed_SV_Message.inl.

References ACE_TRACE, and ACE_Typed_SV_Message< T >::data_.

00091 {
00092   ACE_TRACE ("ACE_Typed_SV_Message<T>::data");
00093   this->data_ = d;
00094 }

template<class T>
T & ACE_Typed_SV_Message< T >::data ( void   ) 

Get a pointer to the data in the message.

Definition at line 83 of file Typed_SV_Message.inl.

References ACE_TRACE, and ACE_Typed_SV_Message< T >::data_.

00084 {
00085   ACE_TRACE ("ACE_Typed_SV_Message<T>::data");
00086   return this->data_;
00087 }

template<class T>
ACE_BEGIN_VERSIONED_NAMESPACE_DECL void ACE_Typed_SV_Message< T >::dump ( void   )  const

Dump the state of an object.

Definition at line 21 of file Typed_SV_Message.cpp.

References ACE_TRACE.

00022 {
00023 #if defined (ACE_HAS_DUMP)
00024   ACE_TRACE ("ACE_Typed_SV_Message<T>::dump");
00025 #endif /* ACE_HAS_DUMP */
00026 }

template<class T>
ACE_INLINE void ACE_Typed_SV_Message< T >::length ( int  l  ) 

Set the length of the message.

Definition at line 62 of file Typed_SV_Message.inl.

References ACE_TRACE, ACE_Typed_SV_Message< T >::data_, ACE_Typed_SV_Message< T >::length_, and ACE_Typed_SV_Message< T >::type_.

00063 {
00064   ACE_TRACE ("ACE_Typed_SV_Message<T>::length");
00065   this->length_ = len + (sizeof *this - (sizeof this->type_ + sizeof this->data_));
00066 }

template<class T>
ACE_INLINE int ACE_Typed_SV_Message< T >::length ( void   )  const

Get the length of the message.

Definition at line 55 of file Typed_SV_Message.inl.

References ACE_TRACE, and ACE_Typed_SV_Message< T >::length_.

Referenced by ACE_Typed_SV_Message< T >::ACE_Typed_SV_Message(), and ACE_Typed_SV_Message_Queue< T >::send().

00056 {
00057   ACE_TRACE ("ACE_Typed_SV_Message<T>::length");
00058   return this->length_;
00059 }

template<class T>
ACE_INLINE void ACE_Typed_SV_Message< T >::max_size ( int  m  ) 

Set the maximum size of the message.

Definition at line 76 of file Typed_SV_Message.inl.

References ACE_TRACE, ACE_Typed_SV_Message< T >::data_, ACE_Typed_SV_Message< T >::max_, and ACE_Typed_SV_Message< T >::type_.

00077 {
00078   ACE_TRACE ("ACE_Typed_SV_Message<T>::max_size");
00079   this->max_ = m + (sizeof *this - (sizeof this->type_ + sizeof this->data_));
00080 }

template<class T>
ACE_INLINE int ACE_Typed_SV_Message< T >::max_size ( void   )  const

Get the maximum size of the message.

Definition at line 69 of file Typed_SV_Message.inl.

References ACE_TRACE, and ACE_Typed_SV_Message< T >::max_.

Referenced by ACE_Typed_SV_Message< T >::ACE_Typed_SV_Message().

00070 {
00071   ACE_TRACE ("ACE_Typed_SV_Message<T>::max_size");
00072   return this->max_;
00073 }

template<class T>
ACE_INLINE void ACE_Typed_SV_Message< T >::type ( long  type  ) 

Set the type of the message.

Definition at line 48 of file Typed_SV_Message.inl.

References ACE_TRACE, and ACE_Typed_SV_Message< T >::type_.

00049 {
00050   ACE_TRACE ("ACE_Typed_SV_Message<T>::type");
00051   this->type_ = t;
00052 }

template<class T>
ACE_INLINE long ACE_Typed_SV_Message< T >::type ( void   )  const

Get the type of the message.

Definition at line 41 of file Typed_SV_Message.inl.

References ACE_TRACE, and ACE_Typed_SV_Message< T >::type_.

00042 {
00043   ACE_TRACE ("ACE_Typed_SV_Message<T>::type");
00044   return this->type_;
00045 }

Member Data Documentation

template<class T>
ACE_Typed_SV_Message< T >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

Definition at line 75 of file Typed_SV_Message.h.

template<class T>
T ACE_Typed_SV_Message< T >::data_ [private]

Data stored in a message.

Definition at line 88 of file Typed_SV_Message.h.

Referenced by ACE_Typed_SV_Message< T >::data(), ACE_Typed_SV_Message< T >::length(), and ACE_Typed_SV_Message< T >::max_size().

template<class T>
int ACE_Typed_SV_Message< T >::length_ [private]

Length of this message.

Definition at line 82 of file Typed_SV_Message.h.

Referenced by ACE_Typed_SV_Message< T >::length().

template<class T>
int ACE_Typed_SV_Message< T >::max_ [private]

Maximum length of any message.

Definition at line 85 of file Typed_SV_Message.h.

Referenced by ACE_Typed_SV_Message< T >::max_size().

template<class T>
long ACE_Typed_SV_Message< T >::type_ [private]

Type of message.

Definition at line 79 of file Typed_SV_Message.h.

Referenced by ACE_Typed_SV_Message< T >::length(), ACE_Typed_SV_Message< T >::max_size(), and ACE_Typed_SV_Message< T >::type().

The documentation for this class was generated from the following files:
Generated on Tue Feb 2 17:35:50 2010 for ACE by  doxygen 1.4.7