netStats.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2012 MaK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#ifndef netStats_h__
#define netStats_h__


#include "rtiMsg.h"

#include <vlutil/vlString.h>
#include <vlutil/vlTime.h>
#include <vlutil/vlHashlist.h>

#include <rtiAmbAPITypes.h>
#include <fedAmbAPITypes.h>

#include <map>

// The DtMsgStats class packages statistics
// data about an individual RTI message type
class DtMsgStats
{
public:

   // Default Constructor
   DtMsgStats() { reset(); }

   // Set Stats to known state
   void reset();

   // Get a printable string of tab-delimited column headers
   static const DtString header();

   // Get a printable string of tab-delimited data
   const DtString string() const;

public:

   unsigned int sentMsgs;
   unsigned int sentBytes;
   unsigned int minSentBytes;
   unsigned int maxSentBytes;
   double       avgSentBytes;
   double       sendTime;
   double       minSendTime;
   double       maxSendTime;
   double       avgSendTime;
   unsigned int recvdMsgs;
   unsigned int recvdBytes;
   unsigned int minRecvdBytes;
   unsigned int maxRecvdBytes;
   double       avgRecvdBytes;
   double       recvTime;
   double       minRecvTime;
   double       maxRecvTime;
   double       avgRecvTime;
   unsigned int dataBytes;
   unsigned int overheadPerMsg;
   double       overheadPercent;
};

class DtRtiApiStats
{
public:
   // Default Constructor
   DtRtiApiStats() { reset(); }

   // Set Stats to known state
   void reset();

   // Get a printable string of tab-delimited column headers
   static const DtString header();

   // Get a printable string of tab-delimited data
   const DtString string() const;

public:

   unsigned int totalCalls;
   double       totalTime;
   double       minCallTime;
   double       maxCallTime;
   double       avgCallTime;
   
};

class DtObjIntStats
{
public:
   // Default Constructor
   DtObjIntStats();

   // Set Stats to known state
   void reset();

   // Get a printable string of tab-delimited column headers
   static const DtString header();

   // Get a printable string of tab-delimited data
   const DtString string() const;

public:

   DtString     instanceName;
   DtString     className;
   unsigned int instanceHandle;
   unsigned int classHandle;
   unsigned int numRegistered;
   unsigned int numDiscovered;
   unsigned int updatesReceived;
   unsigned int bytesReceived;
   unsigned int updatesSent;
   unsigned int bytesSent;
   bool statsUpdated; //Should be set to true whenever any of the above are changed.
};

//
// The DtTrafficStats class stores statistics data related to
// network traffic
//
class DtTrafficStats
{
public:
   // Uses Default Copy Ctor / Dtor / Assignment

   // Default Constructor ( just resets )
   DtTrafficStats() { reset(); }

   // Reset all values to zero
   void reset();

   // Resets FOM related maps
   void resetFomStats();

   // Reset Object and Interaction Updated Stats Flags
   void resetStatsUpdatedFlags();

   // Get a tab-separated header string for the stats data
   static const DtString header();

   // Get a string containing current stats in tab-separated form
   const DtString string() const;

   // Print stuff
   const DtString toDtString() const;

   // Add a sent message to the tally
   void msgSent( unsigned int fedId, DtRtiMsgKind msgKind, 
      unsigned int size, double sendTime );

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

   // Add an RTI Amb. API call to the tally
   void rtiAmbCalled( const DtRtiAmbAPIType callName, double callTime );

   // Add a Fed. Amb. API call to the tally
   void fedAmbCalled( const DtFedAmbAPIType callName, double callTime );

   // Get a pointer to the current message object statistics
   const DtMsgStats* getMsgStats( DtRtiMsgKind msgKind ) const; 

   // Add a new object
   void addObject( bool isRegistered, unsigned int objHandle,
      const DtString& theClassName, const DtString& theObjectName, DtObjectClassHandle theClassHandle );

   // Add a new interaction
   void addInteraction( bool isSent, unsigned int interHandle,
      const DtString& theInterName );


   // Record statistics about an update or interaction message
   void recordUpdate( bool isSent, unsigned int msgSize, double time,
      DtObjectInstanceHandle handle, const DtString& name, 
      DtObjectClassHandle classHandle, const DtString & objectClassName);
   void recordInteraction( bool isSent, unsigned int msgSize, double time,
      DtInteractionClassHandle handle, const DtString& name );


protected:

   // Update the statistics calculations
   void updateMsgStats( bool isSentMsg, DtRtiMsgKind msgKind,
      unsigned int size, double time );

   // Check that data is consistent
   void checkInternalState() const;
   bool containsObjectInstance(unsigned int objectInstanceHandle);
   bool containsInteractionClass(unsigned int interactionClassHandle);
public:
   
   // Statistics Data

   // Message Counts
   unsigned int myTotalMsgsReceived; // Count of all received msgs
   unsigned int myNumAnonMsgs;       // Count of all msgs from federate handle 0
   unsigned int myNumSentMsgs;       // Count of all msgs from local federate
   unsigned int myNumFedMsgs;        // Count of all msgs from other federates

   // Bandwidth Usage
   unsigned int myTotalBytesReceived; // Total size of all msgs received (includes anon) 
   unsigned int myTotalBytesSent;     // Total size of all msgs sent
   double       myAveMsgSize;         // Running average size of all msgs
   unsigned int myMaxMsgSize;         // Largest msg sent/received so far
   unsigned int myMinMsgSize;         // Smallest msg sent/received so far

   // Performance Stats   
   MAKRti::DtClock myCollectionPeriod; // Total time over which stats have been gathered 
   MAKRti::DtTime myTotalSendTime;     // Total Time spent in Send
   MAKRti::DtTime myAveSendTime;       // Average Time spent in Send
   MAKRti::DtTime myMinSendTime;       // Minimum Time spent in Send
   MAKRti::DtTime myMaxSendTime;       // Maximum Time spent in Send

   MAKRti::DtTime myTotalReadTime;     // Total Time spent in Read
   MAKRti::DtTime myAveReadTime;       // Average Time spent in Read
   MAKRti::DtTime myMinReadTime;       // Minimum Time spent in Read
   MAKRti::DtTime myMaxReadTime;       // Maximum Time spent in Read


   // API Stats
   MAKRti::DtTime myTotalApiTime;      // Total Time spent in RTI Amb. calls
   MAKRti::DtTime myTotalCallbackTime; // Total Time spent in Fed. Amb. callbacks

   // Per Obj/Inter/Call Data
   //DtMsgStats myMsgDataByKind[DtInvalidMsgKind];                    // Per Message Data
   std::map< DtRtiMsgKind, DtMsgStats > myMsgDataByKind;            // Per Message Data
   std::map< DtRtiAmbAPIType, DtRtiApiStats > myApiDataByCallName; // Per RTI Amb API Call Data
   std::map< DtFedAmbAPIType, DtRtiApiStats > myFedDataByCallName; // Per Fed Amb API Call Data
   std::map< unsigned int, DtObjIntStats > myObjectData;        // Per Object stats
   std::map< unsigned int, DtObjIntStats > myInteractionData;   // Per Interaction stats
   std::set< unsigned int > myObjectInstanceNamesToSend;   // Object Instance Handles

   // FOM Stats

   // Map where key is object handle and value is the attribute handle
   // This is populated when there is a transport, order, publish, or subscribe change
   std::set<unsigned int> myChangedPubSubTransOrdObjectClassHandlesSet;
   std::set<unsigned int> myChangedPubSubTransOrdInteractionHandlesSet;
   //std::map< unsigned int, unsigned int > myAttributeHandleByObjectHandleMap;

   // Map where key is interaction handle and value is the parameter handle
   // This is populated when there is a transport, order, publish, or subscribe change
   std::map< unsigned int, unsigned int > myParameterHandleByInteractionHandleMap;

};
#endif // netStats_h__