netMapForwarderXmlBlock.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2006 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: netMapForwarderXmlBlock.h,v $ $Revision: 1.6 $ $State: Exp $
 *******************************************************************************/
#ifndef DtNetMapForwarderXmlBlock_H_
#define DtNetMapForwarderXmlBlock_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>
#include <vector>

// Define the XML tags used by this block
DtDECLARE_SPY_XML_TAG( DtNetMapForwarderXmlTag );
DtDECLARE_SPY_XML_TAG( DtNetMapNodeXmlTag );
DtDECLARE_SPY_XML_TAG( DtNodeTypeXmlTag );
DtDECLARE_SPY_XML_TAG( DtMapNodeConnIdXmlTag );
DtDECLARE_SPY_XML_TAG( DtMapNodeIpXmlTag );
DtDECLARE_SPY_XML_TAG( DtMapNodeHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtMapNodeFederationNameXmlTag );
DtDECLARE_SPY_XML_TAG( DtMapNodeSiblingsXmlTag );
DtDECLARE_SPY_XML_TAG( DtMapNodeWebServerIpXmlTag );
DtDECLARE_SPY_XML_TAG( DtMapNodeWebServerPortXmlTag );
                      
class DtNetMapForwarderXmlBlock;
class DtNetMapNodeXmlBlock;
typedef DtBoost::shared_ptr<DtNetMapForwarderXmlBlock> DtNetMapForwarderXmlBlockSP;
typedef DtBoost::weak_ptr<DtNetMapForwarderXmlBlock>   DtNetMapForwarderXmlBlockWP;
typedef DtBoost::shared_ptr<DtNetMapNodeXmlBlock> DtNetMapNodeXmlBlockSP;
typedef DtBoost::weak_ptr<DtNetMapNodeXmlBlock>   DtNetMapNodeXmlBlockWP;


// The DtNetMapNodeXmlBlock holds information about a Network Map leaf node ( ie -
// an RTI Exec or LRC, not a forwarder )
// Helper class to DtNetMapForwarderXmlBlock.
class DT_DLL_WWW DtNetMapNodeXmlBlock : public DtSpyXmlBlock
{
public:
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtNetMapNodeXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtNetMapNodeXmlBlock( const DtString& name, const DtString& nodeType, unsigned long connId,
      const DtString& ip,  unsigned long handle, const DtString& fedexName, 
      const DtString& webServerIp, int webServerPort, DtEnvValueSP root );
   virtual ~DtNetMapNodeXmlBlock();

   virtual inline void setType( const DtString& type );
   virtual inline DtString type() const;
   virtual inline void setConnId( unsigned long connId );
   virtual inline unsigned long connId() const;
   virtual inline void setIp( const DtString& ip );
   virtual inline DtString ip() const;
   virtual inline void setHandle( unsigned long handle );
   virtual inline unsigned long handle() const;
   virtual inline void setFederationName( const DtString& fedexName );
   virtual inline DtString federationName() const;
   virtual inline void setWebServerIp( const DtString& ip );
   virtual inline DtString webServerIp() const;
   virtual inline void setWebServerPort( int port );
   virtual inline int webServerPort() const;
   
protected:

   DtSpyXmlBlockElement< DtString, true > myType;    
   DtSpyXmlBlockElement< unsigned long, true > myConnId;    
   DtSpyXmlBlockElement< DtString, true > myIp;  
   DtSpyXmlBlockElement< DtString, true > myWebServerIp;
   DtSpyXmlBlockElement< int, true > myWebServerPort;

   // Federation Name and Federate Handle only valid if available for this node type
   DtSpyXmlBlockElement< unsigned long, true > myHandle;    
   DtSpyXmlBlockElement< DtString, true > myFederationName;
};


// The DtNetMapForwarderXmlBlock holds the network map rooted a this forwarder
// - it may have other DtNetMapForwarderXmlBlocks or DtNetMapNodeXmlBlocks as
//   children
class DT_DLL_WWW DtNetMapForwarderXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::set<DtString> SiblingList;
   typedef std::set< DtNetMapNodeXmlBlockSP > NetMapNodeXmlBlockSet;
   typedef std::set< DtNetMapForwarderXmlBlockSP > NetMapForwarderXmlBlockSet;

   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtNetMapForwarderXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtNetMapForwarderXmlBlock( const DtString& name, unsigned long connId, const DtString& ip, DtEnvValueSP root );
   virtual ~DtNetMapForwarderXmlBlock();

   // Add a new forwarder as a child of this forwarder
   // (convenience function to avoid creating child node and parenting it manually)
   virtual void addChildForwarder( DtNetMapForwarderXmlBlockSP forwarder );
   virtual DtNetMapForwarderXmlBlockSP addChildForwarder( const DtString& name, 
      unsigned long connId, const DtString& ip );

   // Get the list of child forwarders
   virtual NetMapForwarderXmlBlockSet childForwarders() const;

   // Add a new non-Forwarder node as a child of this forwarder
   // (convenience function to avoid creating child node and parenting it manually)
   virtual void addChildNode( DtNetMapNodeXmlBlockSP node );
   virtual DtNetMapNodeXmlBlockSP addChildNode( const DtString& name, 
      const DtString& nodeType, unsigned long connId, const DtString& ip,
      const DtString& webServerIp = "0", int webServerPort = 0,
      unsigned long handle = 0, const DtString& fedexName = "" );

   // Get the list of non-Forwarder children 
   virtual NetMapNodeXmlBlockSet childNodes() const;


   // Add a sibling relationship between this forwarder and the rhs forwarder node
   // (Siblings are directly connected, but NOT downstream)
   // NOTE: adds this node to sibling's list and adds sibling to this forwarder's list
   virtual void addSiblingRelationship( DtNetMapForwarderXmlBlockSP sibling );

   // Add a sibling to this forwarder's sibling list by name
   // (Siblings are directly connected, but NOT downstream)
   // (Often we may not have a complete DtNetMapForwarderXmlBlockSP for each sibling)
   virtual void addSibling( const DtString& siblingName );


   // Returns the current sibling list in JSON format (this is currently the only format used by clients)
   virtual inline DtString siblings() const;
   
   virtual inline void setConnId( unsigned long connId );
   virtual inline unsigned long connId() const;
   virtual inline void setIp( const DtString& ip );
   virtual inline DtString ip() const;

protected:

   // Update the list of sibling forwarder names in JSON format
   virtual void updateSiblings();

   // List of sibling names in C++ usable form
   SiblingList mySiblingNames;

   // Stores the sibling list in JSON form for use by client
   DtSpyXmlBlockElement< DtString, true > mySiblings;
   
   DtSpyXmlBlockElement< unsigned long, true > myConnId;    
   DtSpyXmlBlockElement< DtString, true > myIp;
};

inline DtString DtNetMapForwarderXmlBlock::siblings() const { return mySiblings; }
inline void DtNetMapForwarderXmlBlock::setConnId( unsigned long connId ) { myConnId = connId; }
inline unsigned long DtNetMapForwarderXmlBlock::connId() const { return myConnId; }
inline void DtNetMapForwarderXmlBlock::setIp( const DtString& ip ) { myIp = ip; }
inline DtString DtNetMapForwarderXmlBlock::ip() const { return myIp; }
inline void DtNetMapNodeXmlBlock::setType( const DtString& type ) { myType = type; }
inline DtString DtNetMapNodeXmlBlock::type() const { return myType; }
inline void DtNetMapNodeXmlBlock::setConnId( unsigned long connId ) { myConnId = connId; }
inline unsigned long DtNetMapNodeXmlBlock::connId() const { return myConnId; }
inline void DtNetMapNodeXmlBlock::setIp( const DtString& ip ) { myIp = ip; }
inline DtString DtNetMapNodeXmlBlock::ip() const { return myIp; }
inline void DtNetMapNodeXmlBlock::setHandle( unsigned long handle ) { myHandle = handle; }
inline unsigned long DtNetMapNodeXmlBlock::handle() const { return myHandle; }
inline void DtNetMapNodeXmlBlock::setFederationName( const DtString& fedexName ) { myFederationName = fedexName; }
inline DtString DtNetMapNodeXmlBlock::federationName() const { return myFederationName; }
inline void DtNetMapNodeXmlBlock::setWebServerIp( const DtString& ip ) { myWebServerIp = ip; }
inline DtString DtNetMapNodeXmlBlock::webServerIp() const { return myWebServerIp; }
inline void DtNetMapNodeXmlBlock::setWebServerPort( int port ) { myWebServerPort = port; }
inline int DtNetMapNodeXmlBlock::webServerPort() const { return myWebServerPort; }


#endif // DtNetMapForwarderXmlBlock_H_