interSendRecvXmlBlock.h

Go to the documentation of this file.

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

#include <rtiMsConfig.h>
#include "spyXmlBlock.h"
#include <mtl/env.h>
#include "webSpyUtils.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( DtInteractionSendRecvXmlTag );
DtDECLARE_SPY_XML_TAG( DtInteractionSendRecvClassXmlTag );
DtDECLARE_SPY_XML_TAG( DtInteractionSendRecvHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtInteractionSendRecvSendCountXmlTag );
DtDECLARE_SPY_XML_TAG( DtInteractionSendRecvReceiveCountXmlTag );
                      
class DtInteractionSendRecvXmlBlock;
class DtInteractionSendRecvClassXmlBlock;
typedef DtBoost::shared_ptr<DtInteractionSendRecvXmlBlock> DtInteractionSendRecvXmlBlockSP;
typedef DtBoost::weak_ptr<DtInteractionSendRecvXmlBlock>   DtInteractionSendRecvXmlBlockWP;
typedef DtBoost::shared_ptr<DtInteractionSendRecvClassXmlBlock> DtInteractionSendRecvClassXmlBlockSP;
typedef DtBoost::weak_ptr<DtInteractionSendRecvClassXmlBlock>   DtInteractionSendRecvClassXmlBlockWP;


// The DtInteractionSendRecvClassXmlBlock holds a single name/value pair for a WWW request message
// Helper class to DtInteractionSendRecvXmlBlock.
class DT_DLL_WWW DtInteractionSendRecvClassXmlBlock : public DtSpyXmlBlock
{
public:
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtInteractionSendRecvClassXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtInteractionSendRecvClassXmlBlock( unsigned long handle, DtEnvValueSP root );
   virtual ~DtInteractionSendRecvClassXmlBlock();

   virtual void interactionSent();
   virtual void interactionReceived();
   
   inline unsigned long handle() const;
   inline unsigned long sent() const;
   inline unsigned long received() const;
   
protected:

   DtSpyXmlBlockElement< unsigned long, true > myHandle;
   DtSpyXmlBlockElement< unsigned long, true > mySentCount;
   DtSpyXmlBlockElement< unsigned long, true > myReceivedCount;    
};


// The DtInteractionSendRecvXmlBlock holds a complete WWW request message
class DT_DLL_WWW DtInteractionSendRecvXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::map< unsigned long, DtInteractionSendRecvClassXmlBlockSP > InteractionSendRecvClassXmlBlocksByHandle;

   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

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

   // Increment the Send and Receive count for interactions
   virtual DtInteractionSendRecvClassXmlBlockSP interactionSent( unsigned long handle );
   virtual DtInteractionSendRecvClassXmlBlockSP interactionReceived( unsigned long handle );

   // List the request parameters
   inline const InteractionSendRecvClassXmlBlocksByHandle& interactions() const;

protected:

   // Cache for fast lookups
   InteractionSendRecvClassXmlBlocksByHandle myInteractions;
};

unsigned long DtInteractionSendRecvClassXmlBlock::handle() const { return myHandle; }
unsigned long DtInteractionSendRecvClassXmlBlock::sent() const { return mySentCount; }
unsigned long DtInteractionSendRecvClassXmlBlock::received() const { return myReceivedCount; }
const DtInteractionSendRecvXmlBlock::InteractionSendRecvClassXmlBlocksByHandle& DtInteractionSendRecvXmlBlock::interactions() const { return myInteractions; }

#endif // DtInteractionSendRecvXmlBlock_H_