smSubscribableMessageQueue.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2005 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*********************************************************************
 ** $RCSfile: smSubscribableMessageQueue.h,v $ $Revision: 1.14 $ $State: Exp $
 *********************************************************************/
#ifndef smSubscribableMessageQueue_H_
#define smSubscribableMessageQueue_H_


#include "rtiMsConfig.h"
#include "vlShmSubscribableMessageQueue__rti__.h"
#include "vlIpcCondVar__rti__.h"
#include "vlIpcMutex__rti__.h"
#include <vlutil/vlTime.h>
#include <vlutil/vlUtil.h>
#include <vlutil/vlInetAddr.h>
#include <list>

#define DtSMQ_PRIO_0          0x00  
#define DtSMQ_PRIO_1          0x01  
#define DtSMQ_PRIO_2          0x02  
#define DtSMQ_PRIO_3          0x03  
#define DtSMQ_PRIO_4          0x04  
#define DtSMQ_PRIO_5          0x05  
#define DtSMQ_PRIO_6          0x06  
#define DtSMQ_PRIO_7          0x07  
#define DtSMQ_PRIO_MASK       0x07  
#define DtSMQ_MSG_RELIABLE    0x10  
#define DtSMQ_MSG_BESTEFFORT  0x20  
//#define DtSMQ_MSG_TBD         0x40   
#define DtSMQ_SKIP_RELIABLE   0x10  
#define DtSMQ_SKIP_BESTEFFORT 0x20  

enum DtSmqEnqueueMode
{
   DtSmqEnqueueBestEffortMode = 0,
   DtSmqEnqueueReliableMode   = 1,

   DtSmqEnqueueInvalidMode        
};

#define DtRtiSubMsgQ_theMaxSubscribers 16384

class DT_DLL_LRC DtRtiSubscribableMessageQueue: public MAKRti::DtSmSubscribableMessageQueue__rti__
{

public:

   DtRtiSubscribableMessageQueue(const MAKRti::DtString &name);
   virtual ~DtRtiSubscribableMessageQueue();

private:

   DtRtiSubscribableMessageQueue(const DtRtiSubscribableMessageQueue &other);

   DtRtiSubscribableMessageQueue& operator=(const DtRtiSubscribableMessageQueue &other);

public:

   virtual int subscribe(MAKRti::DtU32 subscriberId = DtSM_INVALID_SUBSCRIBER_ID);

   virtual void unsubscribeSelf();

   virtual void unsubscribe(MAKRti::DtU32 id);

   virtual bool isEmpty(int *nextSize, MAKRti::DtU32 flagsMask = DtSMQ_FETCH_DEFAULT);

   virtual bool queueIsReliable() const;

   virtual bool isSubscribed(MAKRti::DtU32 subscriberId) const;

   virtual int subscriberCount() const;

   virtual bool sendMessage(const void *message, unsigned int size);
   virtual bool sendMessage(const void *message, unsigned int size, unsigned int flags,
      const MAKRti::DtInetAddr& destAddr = MAKRti::DtInetAddr::inaddrAny());

   virtual void getRcvMsgTransportInfo(MAKRti::DtInetAddr *destAddr, MAKRti::DtU32 *flags);

   virtual void getRcvMsgSenderInfo(MAKRti::DtU32* senderId, MAKRti::DtU32* msgSn = NULL);

   virtual int waitForMessages(MAKRti::DtTime waitTime = 0);

   virtual int waitUntilFull(MAKRti::DtTime waitTime = 0);

   virtual void resetQueue(MAKRti::DtU32 numberOfBuckets, MAKRti::DtU32 payloadSize);

   virtual void setEnqueueMode(DtSmqEnqueueMode mode);

   virtual void initSyncVars();

   virtual void clearSyncVars();

   virtual std::ostream &printDataToStream(std::ostream &str) const;

public:

   static unsigned int poolSize(MAKRti::DtU32 numberOfBuckets, MAKRti::DtU32 payloadSize);

protected:
   struct DtRtiQueueHeader;
   struct DtRtiBucketHeader;
   class DtStalledSubscriber;
   typedef std::list< DtStalledSubscriber * > DtStalledSubscriberList;

   virtual unsigned int maxSubscribers() const;

   volatile DtRtiQueueHeader *queueHeader() const;

   MAKRti::DtU32 queueHeaderSize() const;

   virtual MAKRti::DtU32 numberOfBuckets() const;

   virtual MAKRti::DtU32 payloadSize() const;

   virtual volatile MAKRti::DtU32 queueState() const;

   virtual volatile MAKRti::DtU32 queueFront(unsigned int sub) const;

   virtual volatile MAKRti::DtU32 queueBack() const;

   virtual volatile MAKRti::DtU32 queueBackstop() const;

   virtual MAKRti::DtU32 updateFront(unsigned int sub, unsigned int val);

   virtual MAKRti::DtU32 updateBack(unsigned int val);

   virtual MAKRti::DtU32 updateBackstop(unsigned int val);

   virtual void setSubscribed(unsigned int sub, unsigned int val);

   virtual int setSubscriberCount(MAKRti::DtU32 val);

   virtual int incrementSubscriberCount();

   virtual int decrementSubscriberCount();

   virtual void setState(MAKRti::DtU32 val);

   virtual void lockForRead();
   virtual void unlockForRead();

   virtual bool stalledSubscribers(unsigned int bucketNum, unsigned int numStalled);

   virtual bool handleStall(unsigned int bucketNum, unsigned int sub);

   virtual MAKRti::DtU32 bucketHeaderSize() const;

   virtual MAKRti::DtU32 bucketSenderId(unsigned int bucketNum) const;
   virtual MAKRti::DtU32 bucketMsgSn(unsigned int bucketNum) const;
   virtual MAKRti::DtU32 bucketOutstandingReadCount(unsigned int bucketNum) const;
   virtual MAKRti::DtInetAddr bucketDestinationAddr(unsigned int bucketNum) const;
   virtual MAKRti::DtU32 bucketPayloadLen(unsigned int bucketNum) const;
   virtual MAKRti::DtU32 bucketPriority(unsigned int bucketNum) const;
   virtual bool  bucketIsReliable(unsigned int bucketNum) const;
   virtual bool  bucketIsBestEffort(unsigned int bucketNum) const;
   virtual bool  bucketIsFirst(unsigned int bucketNum) const;
   virtual bool  bucketIsLast(unsigned int bucketNum) const;

   virtual void  setSenderId(unsigned int bucketNum, MAKRti::DtU32 sid);
   virtual void  setMsgSn(unsigned int bucketNum, MAKRti::DtU32 seqnum);
   virtual void  setOutstandingReadCount(unsigned int bucketNum, MAKRti::DtU32 val);
   virtual void  decrementOutstandingReadCount(unsigned int bucketNum);
   virtual void  setDestinationAddr(unsigned int bucketNum, const MAKRti::DtInetAddr& dest);
   virtual void  setPayloadLen(unsigned int bucketNum, MAKRti::DtU32 len);
   virtual void  setPriority(unsigned int bucketNum, MAKRti::DtU32 priority);
   virtual void  setReliable(unsigned int bucketNum, MAKRti::DtU32 val);
   virtual void  setBestEffort(unsigned int bucketNum, MAKRti::DtU32 val);
   virtual void  setFirst(unsigned int bucketNum, MAKRti::DtU32 val);
   virtual void  setLast(unsigned int bucketNum, MAKRti::DtU32 val);

#ifndef WIN32
   virtual pthread_rwlock_t * rdWrLock();
   virtual pthread_mutex_t  * orcMutex();
   virtual pthread_cond_t   * newMessageCond();
   virtual pthread_mutex_t  * newMessageCondMutex();
   virtual pthread_cond_t   * queueFullCond();
   virtual pthread_mutex_t  * queueFullCondMutex();
#endif 

protected:

   DtStalledSubscriberList   myStalledSubs;
   MAKRti::DtClock                   myTimestampClock;
   MAKRti::DtIpcCondVar__rti__           *  myNewMessageCond;
   MAKRti::DtIpcMutex__rti__             *  myNewMessageMutex;
   MAKRti::DtIpcCondVar__rti__           *  myQueueFullCond;
   MAKRti::DtIpcMutex__rti__             *  myQueueFullMutex;

   unsigned int theMaxSubscribers;

   unsigned int theMaxStallTime;

protected:

   struct DtRtiBucketHeader
   {
      MAKRti::DtU32 senderId;       
      MAKRti::DtU32 msgSn;            
      MAKRti::DtU32 outstandingReadCount;  
      MAKRti::DtU32  sizeInBytes : 24; 
      MAKRti::DtU32 msgPriority  : 3;  
      MAKRti::DtU32 reliable     : 1;  
      MAKRti::DtU32 besteffort   : 1;  
      MAKRti::DtU32 ipv6         : 1;  
      MAKRti::DtU32 last         : 1;  
      MAKRti::DtU32 first        : 1;  
      MAKRti::DtU128 destAddr;        
   };

   struct DtRtiQueueHeader
   {
      MAKRti::DtU32 state;             
      MAKRti::DtU32 payloadSize : 24;  
      MAKRti::DtU32 reliable    :  1;
      MAKRti::DtU32 reserved_1  :  7;
      MAKRti::DtU32 numberOfBuckets;
      MAKRti::DtU32 numberOfSubscribers;
      MAKRti::DtU32 front[DtRtiSubMsgQ_theMaxSubscribers];
      MAKRti::DtU32 subscribed[DtRtiSubMsgQ_theMaxSubscribers];
      MAKRti::DtU32 back;
      MAKRti::DtU32 backstop;
#ifndef WIN32
      pthread_rwlock_t  rwlock;
      pthread_cond_t    newMessage;   
      pthread_mutex_t   newMessageMutex;
      pthread_cond_t    queueFull;
      pthread_mutex_t   queueFullMutex;
      pthread_mutex_t   ptOrcMutex;   
#endif 
   };

   class DtStalledSubscriber
   {
   public:
      DtStalledSubscriber(MAKRti::DtU32 bucket, MAKRti::DtU32 id, MAKRti::DtU32 sender, MAKRti::DtU32 seq, MAKRti::DtTime tstamp) :
         bucketIndex(bucket), stalledId(id), senderId(sender), senderSn(seq), posted(tstamp)
         {};
      ~DtStalledSubscriber(){};
      MAKRti::DtU32    bucketIndex; 
      MAKRti::DtU32    stalledId;  
      MAKRti::DtU32    senderId;   
      MAKRti::DtU32    senderSn;   
      MAKRti::DtTime   posted;     
   };

};

#endif