smSubscribableMessageQueue.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2016 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <portal/messageQueue.h>
#include <vlutil/vlShmPool.h>

namespace MAKVrExchange
{

   struct DtQueueHeader;
   struct DtBucketHeader;

   class DT_DLL_LIBPORTAL DtSubscribableMessageQueue: public DtMessageQueue
   {
   public:

      static const unsigned int theMaxSubscribers = 256;

      static unsigned long theLockFailureTimeoutMs;

   public:

      DtSubscribableMessageQueue( const DtString& name, DtU8 subscriberId );

      virtual ~DtSubscribableMessageQueue();

      virtual bool isEmpty();

      virtual bool isSubscribed( DtU8 subscriberId ) const;

      virtual DtU32 subscriberDrops( DtU8 subscriberId ) const;

      virtual void sendMessage( const void* message, unsigned int size,
         bool global = false );

      virtual void* message( unsigned int* outSize = 0 );

      virtual void unsubscribe( DtU8 id );

      void subscribe( DtU8 id );

      virtual void resetQueue( DtU32 numberOfBuckets, DtU32 payloadSize );

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

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

      virtual DtString name() const;

      DtQueueHeader* queueHeader() const;

      DtU32 numberOfBuckets() const;

      DtU32 payloadSize() const;

      virtual char* payloadInBucket( unsigned int bucketNum ) const;

      virtual DtBucketHeader* bucketHeader( unsigned int bucketNum ) const;

      virtual int usedBucketCount() const;

   private:

      DtSubscribableMessageQueue( const DtSubscribableMessageQueue& other );

      DtSubscribableMessageQueue& operator = (const DtSubscribableMessageQueue& other );

   protected:

      std::vector<char> myReadBuffer;
      DtU8 mySubscriberId;
      DtString myShmName;

      DtSharedMemoryPoolClient* myShmPool;

   };

}