Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::entry Struct Reference

data storage needed for each message More...

#include <MessageQueue.h>


Detailed Description

template<unsigned int MAX_UNREAD, unsigned int MAX_RECEIVERS = 10, unsigned int MAX_SENDERS = 10>
struct MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::entry

data storage needed for each message

Definition at line 225 of file MessageQueue.h.

List of all members.

Public Member Functions

 entry ()
 constructor
 entry (unsigned int serialNumber, RCRegion *r)
 constructor, pass message info

Public Attributes

RCRegion::Identifier id
 the identifier for the shared memory region so that other regions can attach it
unsigned int sn
 serial number for this message (not the same as its index in the queue -- indicies are reused, this id is unique to this message
bool readFlags [MAX_RECEIVERS]
 a flag for each receiver to indicate if they have read it
unsigned int numRead
 a count of the number of receivers which have read this message (should always equal sum(readFlags))

Constructor & Destructor Documentation

template<unsigned int MAX_UNREAD, unsigned int MAX_RECEIVERS = 10, unsigned int MAX_SENDERS = 10>
MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::entry::entry (  ) 

constructor

Definition at line 226 of file MessageQueue.h.

template<unsigned int MAX_UNREAD, unsigned int MAX_RECEIVERS = 10, unsigned int MAX_SENDERS = 10>
MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::entry::entry ( unsigned int  serialNumber,
RCRegion r 
)

constructor, pass message info

Definition at line 227 of file MessageQueue.h.


Member Data Documentation

template<unsigned int MAX_UNREAD, unsigned int MAX_RECEIVERS = 10, unsigned int MAX_SENDERS = 10>
RCRegion::Identifier MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::entry::id

the identifier for the shared memory region so that other regions can attach it

Definition at line 229 of file MessageQueue.h.

template<unsigned int MAX_UNREAD, unsigned int MAX_RECEIVERS = 10, unsigned int MAX_SENDERS = 10>
unsigned int MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::entry::numRead

a count of the number of receivers which have read this message (should always equal sum(readFlags))

Definition at line 232 of file MessageQueue.h.

template<unsigned int MAX_UNREAD, unsigned int MAX_RECEIVERS = 10, unsigned int MAX_SENDERS = 10>
bool MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::entry::readFlags[MAX_RECEIVERS]

a flag for each receiver to indicate if they have read it

Definition at line 231 of file MessageQueue.h.

Referenced by MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::entry::entry().

template<unsigned int MAX_UNREAD, unsigned int MAX_RECEIVERS = 10, unsigned int MAX_SENDERS = 10>
unsigned int MessageQueue< MAX_UNREAD, MAX_RECEIVERS, MAX_SENDERS >::entry::sn

serial number for this message (not the same as its index in the queue -- indicies are reused, this id is unique to this message

Definition at line 230 of file MessageQueue.h.


The documentation for this struct was generated from the following file:

Tekkotsu v5.1CVS
Generated Mon May 9 04:59:13 2016 by Doxygen 1.6.3