metadata.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2006 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: metadata.h,v $ $Revision: 1.8 $ $State: Exp $
*********************************************************************/

#ifndef DtRtiMetadata_H_
#define DtRtiMetadata_H_


#include <list>
#include <internalTypes.h>
#include "rtiMsg.h"
#include <vlutil/vlPrint.h>

#define DtMetadataAlignNone  0
#define DtMetadataAlign16Bit 1
#define DtMetadataAlign32Bit 3
#define DtMetadataAlign64Bit 7

typedef enum DtMetadataTypes_e
{
   DtMetadataTypeNull             = 0,
   DtMetadataTypeDestinationList,
   DtMetadataTypeTransport,
   DtMetadataTypeMcastAddr,
   DtMetadataTypeFwderGroupId,
   DtMetadataTypeTestId,
   DtMetadataTypeTimeStampInitiatorSendInteraction,
   DtMetadataTypeTimeStampInitiatorNetSend,
   DtMetadataTypeTimeStampRecipientNetRead,
   DtMetadataTypeTimeStampRecipientAsynchronousQueue,
   DtMetadataTypeTimeStampRecipientReceiveInteraction,
   DtMetadataTypeTimeStampRecipientSendInteraction,
   DtMetadataTypeTimeStampRecipientNetSend,
   DtMetadataTypeTimeStampInitiatorNetRead,
   DtMetadataTypeTimeStampInitiatorAsynchronousQueue,
   DtMetadataTypeTimeStampInitiatorReceiveInteraction,
   DtMetadataTypeFederateStateInfo,


   DtMetadataTypeEnd              = 8191  
} DtMetadataType;

typedef struct DtMetadataHeader_s
{
   union DtMetadataHeaderCtl_u
   {
      DtU16 allFields;

      struct DtMetadataHeaderCtl_s
      {
#if DT_LITTLE_ENDIAN
         DtU16 type              :  9; 
         DtU16 hasPayload        :  1;
         DtU16 payloadAlignment  :  4;
         DtU16 copy              :  1;
         DtU16 more              :  1;
#else
         DtU16 more              :  1;
         DtU16 copy              :  1;
         DtU16 payloadAlignment  :  4;
         DtU16 hasPayload        :  1;
         DtU16 type              :  9;
#endif 

      } field;

   } ctl;

   union DtMetadataHeaderLenOrVal_u
   {
      DtU16 val;

      struct DtMetadataHeaderPayloadLen_s
      {
#if DT_LITTLE_ENDIAN
         DtU16 payloadLen        : 11;
         DtU16 pad               :  1;
         DtU16 alignPad          :  4;
#else
         DtU16 alignPad          :  4;
         DtU16 pad               :  1;
         DtU16 payloadLen        : 11;
#endif 
      } len;

   } lenOrVal;

} DtMetadataNetHeader;


class DT_DLL_LRC DtRtiMetadata
{
protected:

   typedef std::list< DtMetadataNetHeader* > DtMetadataHeaderList;

public:

   DtRtiMetadata( caddr_t msg, DtMetadataType type );
   DtRtiMetadata( DtRtiMsg* msg, DtMetadataType type );

   virtual ~DtRtiMetadata();

private:

   DtRtiMetadata(const DtRtiMetadata &);

   DtRtiMetadata& operator=(const DtRtiMetadata &);

public:

   virtual bool locate( void** mdVal, unsigned int& size ) const;

   virtual bool nullify();

   virtual unsigned int remove();

   virtual unsigned int purge();

   virtual bool isCopyEnabled();
   virtual void setCopyEnable( bool copyEnable );

   virtual bool setLengthAsValue(unsigned int value);

   virtual bool getLengthAsValue(unsigned int &value) const;

   virtual void print(MAKRti::DtOutputStream& stream = MAKRti::DtDebug);

   virtual DtNetMsgHeader* netMessageHeader();

public:

   static unsigned int metadataMaxSize();

protected:

   virtual DtMetadataNetHeader* getFirstHeader( ) const;
   virtual DtMetadataNetHeader* getHeaderByType( ) const;   
   virtual DtU16 compactMetadata( char* dst, DtMetadataHeaderList& retentionPool,
      bool newFinal );

protected:

   // Returns boolean: type was found?
   static bool locate( char const* msg, DtMetadataType type,
      void** mdVal, unsigned int& size );

   static bool typeIsPresent( char const* msg, DtMetadataType type );


   static DtMetadataNetHeader* getFirstHeader(char const* msg);
   static DtMetadataNetHeader* getNextHeader( DtMetadataNetHeader* hdr );
   static DtMetadataNetHeader* getHeaderByType( char const* msg, DtMetadataType type );

   static void transmogrifyHeader( DtMetadataNetHeader& src, DtMetadataNetHeader& dest );

   static void reverseTransmogrifyHeader( DtMetadataNetHeader& src, DtMetadataNetHeader& dest );

   static unsigned int metadataSize( DtMetadataNetHeader& hdr );
   static unsigned int metadataPayloadSize( DtMetadataNetHeader& hdr );

protected:

   DtRtiMsg *           myMsg;
   caddr_t              myMsgAddr;
   mutable unsigned int myMsgLen;
   char *               myStartAddr; 
   unsigned int         mySize;
   bool                 myCopyEnabled;
   const DtMetadataType myMetaDataType;

protected:

   static unsigned int theMaxMetadataBufferSize;
};

#endif