latencyReportMsg.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2008 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: latencyReportMsg.h,v $ $Revision: 1.2 $ $State: Exp $
*********************************************************************/

#ifndef DtLatencyReportMsg_H_
#define DtLatencyReportMsg_H_


// PLEASE NOTE: This class is duplicated as DtAssistantLatencyReportMsg 
// in assistantLatencyReportMsg.h. Any changes made to this class 
// should also be made there.

#include <vlutil/vlString.h>
#include <vlutil/vlUtil.h>

#include "rtiMsg.h"
#include "netLatencyReportMsg.h"
#include <averagedLatencyTestReport.h>
#include <map>

class DtConnectionMgr;
class DtLatencyReportMsg;

typedef void (*DtLatencyReportCb)(const DtLatencyReportMsg& report, void* usr);


class DT_DLL_LRC DtLatencyReportMsg : public DtRtiMsg
{
public:
   

   DtLatencyReportMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtLatencyReportMsg(const DtAveragedLatencyTestReport& rep,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtLatencyReportMsg(const DtNetLatencyReportMsg* netRepMsg,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtLatencyReportMsg();

   virtual DtRtiMsg* clone(bool copy = true) const;

   virtual void printData(DtLogicalTimeFactory* logicalTimeFactory) const;

   virtual unsigned char* encodedReport();

   virtual const unsigned char* encodedReport() const;

   virtual unsigned int encodedReportSize() const;

   virtual void setEncodedReportSize(unsigned int times);

   virtual void get(DtAveragedLatencyTestReport& report) const;

   virtual void set(const DtAveragedLatencyTestReport& report, bool adjustBufferSize = true);

public:

   static DtRtiMsg* create(const DtNetMsgHeader* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static DtRtiMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static void addCallback(DtConnectionMgr* conn,
      DtLatencyReportCb cb, void* usr);
   static void removeCallback(DtConnectionMgr* conn,
      DtLatencyReportCb cb, void* usr);

      
protected:

   virtual DtNetLatencyReportMsg* netLatencyReportMsg();
   virtual const DtNetLatencyReportMsg* netLatencyReportMsg() const;

   virtual DtRtiMsgKind internalDtRtiMsgKind();

   virtual int minSize() const;

   virtual int minSize(const DtAveragedLatencyTestReport& report) const;
};

#endif