Public Member Functions | Public Attributes | Static Public Attributes

CxUtils::MappedMessageBox::Header Class Reference

Class for storing MappedMessageBox header information that is stored at the beginning of shared memory used in MappedMessageBox. More...

#include <mappedmessagebox.h>

List of all members.

Public Member Functions

 Header ()
 Constructor, initializes all values to 0.
 Header (const Header &header)
 Copy constructor.
 ~Header ()
 Destructor.
Headeroperator= (const Header &header)
 Sets equal to.

Public Attributes

Time::Stamp mWriteTimeMs
 The last time a message was written to box in ms.
Time::Stamp mReadTimeMs
 The last time a process read data from the box in ms.
unsigned int mCount
 The current number of messages stored in the box in ms.
unsigned int mStartBytePos
 The byte index of the first message in the box (from memory index 0).
unsigned int mEndBytePos
 The ending byte index of the last message (from memory index 0).

Static Public Attributes

static const unsigned int Size = 28
 Size of message box header in bytes.

Detailed Description

Class for storing MappedMessageBox header information that is stored at the beginning of shared memory used in MappedMessageBox.

Definition at line 74 of file mappedmessagebox.h.


Constructor & Destructor Documentation

MappedMessageBox::Header::Header (  )

Constructor, initializes all values to 0.

Definition at line 59 of file mappedmessagebox.cpp.

MappedMessageBox::Header::Header ( const Header header )

Copy constructor.

Definition at line 74 of file mappedmessagebox.cpp.

MappedMessageBox::Header::~Header (  )

Destructor.

Definition at line 89 of file mappedmessagebox.cpp.


Member Function Documentation

MappedMessageBox::Header & MappedMessageBox::Header::operator= ( const Header header )

Sets equal to.

Definition at line 99 of file mappedmessagebox.cpp.


Member Data Documentation

The current number of messages stored in the box in ms.

Definition at line 84 of file mappedmessagebox.h.

The ending byte index of the last message (from memory index 0).

Definition at line 86 of file mappedmessagebox.h.

The last time a process read data from the box in ms.

Definition at line 83 of file mappedmessagebox.h.

The byte index of the first message in the box (from memory index 0).

Definition at line 85 of file mappedmessagebox.h.

The last time a message was written to box in ms.

Definition at line 82 of file mappedmessagebox.h.

const unsigned int CxUtils::MappedMessageBox::Header::Size = 28 [static]

Size of message box header in bytes.

Definition at line 77 of file mappedmessagebox.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines