lrcMsgStatsXmlBlock.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2006 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: lrcMsgStatsXmlBlock.h,v $ $Revision: 1.6 $ $State: Exp $
 *******************************************************************************/
#ifndef DtLrcMsgStatsXmlBlock_H_
#define DtLrcMsgStatsXmlBlock_H_

#include <rtiMsConfig.h>
#include "spyXmlBlock.h"
#include "msgStatsXmlBlock.h"
#include "statisticsXmlBlock.h"
#include <mtl/env.h>
#include "webSpyUtils.h"
#include <rtiMsg.h>

#include <vlutil/vlFedTarget.h>
#include <vlutil/vlString.h>
#include <vlutil/vlFilename.h>
#include <vlutil/vlSmartPointers.h>

#include <iosfwd>
#include <map>

// Define the XML tags used by this block
DtDECLARE_SPY_XML_TAG( DtLrcMsgStatsXmlTag );
DtDECLARE_SPY_XML_TAG( DtTotalSentBytesXmlTag );
DtDECLARE_SPY_XML_TAG( DtTotalReadBytesXmlTag );
DtDECLARE_SPY_XML_TAG( DtTotalAnonBytesXmlTag );
DtDECLARE_SPY_XML_TAG( DtTotalStampedBytesXmlTag );
DtDECLARE_SPY_XML_TAG( DtTotalNetworkReadTimesXmlTag );
DtDECLARE_SPY_XML_TAG( DtTotalNetworkSendTimesXmlTag );


class DtLrcMsgStatsXmlBlock;
typedef DtBoost::shared_ptr<DtLrcMsgStatsXmlBlock> DtLrcMsgStatsXmlBlockSP;
typedef DtBoost::weak_ptr<DtLrcMsgStatsXmlBlock>   DtLrcMsgStatsXmlBlockWP;

// The DtLrcMsgStatsXmlBlock holds the current statistics for the messages
// sent and received by a given LRC
class DT_DLL_WWW DtLrcMsgStatsXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::map< DtRtiMsgKind, DtMsgStatsXmlBlockSP > MessagesByKindMap;
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtLrcMsgStatsXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtLrcMsgStatsXmlBlock( DtEnvValueSP root );
   virtual ~DtLrcMsgStatsXmlBlock();

   // Reset all values to zero
   virtual void reset();
   
   // Add a sent message to the tally
   virtual void messageSent( unsigned int fedId, DtRtiMsgKind msgKind, 
      unsigned int size, double sendTime );

   // Add a received message to the tally
   virtual void messageRead( unsigned int fedId, DtRtiMsgKind msgKind,
      unsigned int size, double recvTime );

   // Get a pointer to the current statistics for a specific message
   const DtMsgStatsXmlBlockSP msgStats( DtRtiMsgKind msgKind ) const;
   
   // Access the complete list of RTI messages
   inline const MessagesByKindMap& messages() const;
   
   
protected:

   // @defgroup Totals

   // Total num msgs and bandwidth sent (including anon)
   // @ingroup Totals
   DtStatisticsXmlBlock<unsigned int>::BlockWP mySentBytes;
   
   // Total num msgs and bandwidth read (including anon)
   // @ingroup Totals
   DtStatisticsXmlBlock<unsigned int>::BlockWP myReadBytes;

   // Total num msgs and bandwidth read from anon messages (may have been sent by self)
   // @ingroup Totals
   DtStatisticsXmlBlock<unsigned int>::BlockWP myAnonBytes;

   // Total num msgs and bandwidth read from stamped messages (definitely sent from other feds)
   // @ingroup Totals
   DtStatisticsXmlBlock<unsigned int>::BlockWP myStampedBytes;

   // Total time spent in socket reads
   // @ingroup Totals
   DtStatisticsXmlBlock<double>::BlockWP myNetworkReadTimes;

   // Total time spent in socket sends
   // @ingroup Totals
   DtStatisticsXmlBlock<double>::BlockWP myNetworkSendTimes;

   MessagesByKindMap myMessages;
};

const DtLrcMsgStatsXmlBlock::MessagesByKindMap& DtLrcMsgStatsXmlBlock::messages() const
{
   return myMessages;
}


#endif // DtLrcMsgStatsXmlBlock_H_