Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

PANA_MsgHeader Class Reference

PANA message header class definition. More...

#include <pana_message.h>

Inheritance diagram for PANA_MsgHeader:

List of all members.

Public Types

enum  { HeaderLength = 16 }

Public Member Functions

 PANA_MsgHeader ()
virtual ~PANA_MsgHeader ()
UCHAR version ()
void version (UCHAR ver)
ACE_UINT32 length ()
void length (ACE_UINT32 len)
PANA_MsgHeader::Flags & flags ()
void flags (PANA_MsgHeader::Flags flg)
ACE_UINT32 type ()
void type (ACE_UINT32 typ)
ACE_UINT32 tseq ()
void tseq (ACE_UINT32 seq)
ACE_UINT32 rseq ()
void rseq (ACE_UINT32 seq)
AAADictionaryHandle * getDictHandle ()
void setDictHandle (AAADictionaryHandle *handle)

Protected Attributes

UCHAR version_
ACE_UINT32 length_:24
PANA_MsgHeader::Flags flags_
ACE_UINT32 type_:24
ACE_UINT32 tseq_
ACE_UINT32 rseq_
AAADictionaryHandle * dictHandle_

Detailed Description

PANA message header class definition.

Definition at line 110 of file pana_message.h.

Member Enumeration Documentation

anonymous enum
 

Default header length definition

Definition at line 126 of file pana_message.h. 

00126                     {
00127            HeaderLength = 16 // length in UCHAR
00128        };

Constructor & Destructor Documentation

PANA_MsgHeader::PANA_MsgHeader (   ) 
 

constructor

Definition at line 131 of file pana_message.cxx.

References dictHandle_, flags_, length_, rseq_, tseq_, type_, and version_. 

00132 {
00133    version_ = PANA_VERSION;
00134    length_  = 0;
00135    type_    = 0;
00136    rseq_    = 0;
00137    tseq_    = 0;
00138    dictHandle_ = NULL;
00139    ACE_OS::memset(&flags_, 0, sizeof(PANA_MsgHeader::Flags));
00140 }

virtual PANA_MsgHeader::~PANA_MsgHeader (   )  [inline, virtual]
 

destructor

Definition at line 139 of file pana_message.h. 

00139 { }

Member Function Documentation

void PANA_MsgHeader::flags (  PANA_MsgHeader::Flags  flg  )  [inline]
 

Access function that sets the header flags

Parameters:
flg New flags to set

Definition at line 175 of file pana_message.h. 

00175 { flags_ = flg; }

PANA_MsgHeader::Flags& PANA_MsgHeader::flags (   )  [inline]
 

Access function that returns header flags

Definition at line 168 of file pana_message.h. 

00168 { return flags_; }

AAADictionaryHandle* PANA_MsgHeader::getDictHandle (   )  [inline]
 

returns the current dictionary handle

Definition at line 214 of file pana_message.h. 

00214 { return dictHandle_; }

void PANA_MsgHeader::length (  ACE_UINT32  len  )  [inline]
 

Access function that sets the message length

Parameters:
len Message length

Definition at line 163 of file pana_message.h. 

00163 { length_ = len; }

ACE_UINT32 PANA_MsgHeader::length (   )  [inline]
 

Access function that returns message length

Definition at line 156 of file pana_message.h. 

00156 { return length_; }

void PANA_MsgHeader::rseq (  ACE_UINT32  seq  )  [inline]
 

Access function that sets the receive sequence number

Parameters:
seq New receive sequence number

Definition at line 209 of file pana_message.h. 

00209 { rseq_ = seq; }

ACE_UINT32 PANA_MsgHeader::rseq (   )  [inline]
 

Access function that returns the receive sequence number

Definition at line 202 of file pana_message.h. 

00202 { return rseq_; }

void PANA_MsgHeader::setDictHandle (  AAADictionaryHandle *  handle  )  [inline]
 

returns the current dictionary handle

Definition at line 219 of file pana_message.h. 

00219 { dictHandle_ = handle; }

void PANA_MsgHeader::tseq (  ACE_UINT32  seq  )  [inline]
 

Access function that sets the transmitt sequence number

Parameters:
seq New transmitt sequence number

Definition at line 197 of file pana_message.h. 

00197 { tseq_ = seq; }

ACE_UINT32 PANA_MsgHeader::tseq (   )  [inline]
 

Access function that returns the transmitt sequence number

Definition at line 190 of file pana_message.h. 

00190 { return tseq_; }

void PANA_MsgHeader::type (  ACE_UINT32  typ  )  [inline]
 

Access functions that sets the message type

Definition at line 185 of file pana_message.h. 

00185 { type_ = typ; }

ACE_UINT32 PANA_MsgHeader::type (   )  [inline]
 

Access functions that returns the message type

Definition at line 180 of file pana_message.h. 

00180 { return type_; }

void PANA_MsgHeader::version (  UCHAR  ver  )  [inline]
 

Access function that sets the version number

Parameters:
ver New version number

Definition at line 151 of file pana_message.h. 

00151 { version_ = ver; }

UCHAR PANA_MsgHeader::version (   )  [inline]
 

Access function that returns the version number

Definition at line 144 of file pana_message.h. 

00144 { return version_; }

Member Data Documentation

AAADictionaryHandle* PANA_MsgHeader::dictHandle_ [protected]
 

Parser dictionary handle

Definition at line 235 of file pana_message.h.

Referenced by PANA_MsgHeader().

PANA_MsgHeader::Flags PANA_MsgHeader::flags_ [protected]
 

header flags

Definition at line 227 of file pana_message.h.

Referenced by PANA_MsgHeader().

ACE_UINT32 PANA_MsgHeader::length_ [protected]
 

packet length including header

Definition at line 225 of file pana_message.h.

Referenced by PANA_MsgHeader().

ACE_UINT32 PANA_MsgHeader::rseq_ [protected]
 

Receive sequence number

Definition at line 233 of file pana_message.h.

Referenced by PANA_MsgHeader().

ACE_UINT32 PANA_MsgHeader::tseq_ [protected]
 

Transmit sequence number

Definition at line 231 of file pana_message.h.

Referenced by PANA_MsgHeader().

ACE_UINT32 PANA_MsgHeader::type_ [protected]
 

Message types

Definition at line 229 of file pana_message.h.

Referenced by PANA_MsgHeader().

UCHAR PANA_MsgHeader::version_ [protected]
 

Protocol version

Definition at line 223 of file pana_message.h.

Referenced by PANA_MsgHeader().

The documentation for this class was generated from the following files:
Generated on Fri Jun 25 19:18:31 2004 for PANA by doxygen 1.3.5