rtiAssistantServer.h

Go to the documentation of this file.

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

#ifndef rtiAssistantServer_H_
#define rtiAssistantServer_H_


#include <rtiMsConfig.h>

#include <map>

#include <vlutil/vlBaseMsg.h>
#include <vlutil/vlUtil.h>
#include <vlutil/vlTime.h>
#include <vlutil/vlPrint.h>

#include "assistantDefaultMsgFact.h"
#include "assistantMsgCbMgr.h"
#include "assistantConnectionInfo.h"
#include "assistantConnectionConfigurationInfo.h"
#include "assistantNetStatsStringReqMsg.h"
#include "assistantNetStatsEnums.h"

typedef void (*DtAssistantSocketAdditionCb)(int compId, void* usr);
typedef void (*DtAssistantSocketRemovalCb)(int compId, const MAKRti::DtString& reason, void* usr);
class DtAssistantSocketAdditionCbInfo;
class DtAssistantSocketRemovalCbInfo;
typedef std::list<DtAssistantSocketAdditionCbInfo*> DtAssistantSocketAdditionCallbackList;
typedef std::list<DtAssistantSocketRemovalCbInfo*> DtAssistantSocketRemovalCallbackList;

class DtTcpMsgSocketMgr;
class DtTcpMsgSocket;

class DT_DLL_ASSISTANT DtRtiAssistantServer
{

public:
   DtRtiAssistantServer( DtNotifyLevelType level , 
      int port = DtASSISTANT_DEFAULT_PORT, 
      const MAKRti::DtInetAddr& networkInterface = MAKRti::DtInetAddr() );

   virtual ~DtRtiAssistantServer();

public:

   bool isOk() const;

   virtual void addMsgCallback(DtAssistantMsgKind msgKind, DtAssistantMsgCbMgr::DtCallbackFcn fcn,
      void *usr );
   virtual void removeMsgCallback(DtAssistantMsgKind msgKind, DtAssistantMsgCbMgr::DtCallbackFcn fcn,
      void *usr );
   virtual void addWildcardMsgCallback(DtAssistantMsgCbMgr::DtCallbackFcn fcn,
      void *usr );
   virtual void removeWildcardMsgCallback(DtAssistantMsgCbMgr::DtCallbackFcn fcn,
      void *usr );

   virtual void addSocketAdditionCallback(DtAssistantSocketAdditionCb cb, void* usr);
   virtual void removeSocketAdditionCallback(DtAssistantSocketAdditionCb cb, void* usr);
   virtual void addSocketRemovalCallback(DtAssistantSocketRemovalCb cb, void* usr);
   virtual void removeSocketRemovalCallback(DtAssistantSocketRemovalCb cb, void* usr);

   virtual bool tick( double timeout = 0 );

   virtual unsigned int numConnections() const;

   virtual void sendMsgOnConn( int compId, const DtAssistantMsg& msg );

   virtual void sendBroadcast( const DtAssistantMsg& msg );

   virtual void sendConnMsg( int compId, bool disconnect = false, 
      const MAKRti::DtString& display = MAKRti::DtString::nullString() );

   virtual void sendConnRespMsg( int compId, const DtRtiConnectionInfoDataPair& conn,
      const DtRtiConnectionConfigurationInfo& config, bool accepted );

   virtual void sendLicRespMsg( int compId, bool runUnlicensed, 
      const MAKRti::DtString& server, int port, bool accepted );

   virtual void sendAssistantCommandResponseMsg( 
                     int compId, const MAKRti::DtString& formattedData );

   virtual void sendNtfyLvlUpdateMsg( int compId, DtNotifyLevelType notifyLevel );

   virtual void sendLatencyTestRequestMsg( int compId, bool runTest, bool continuous,
      bool shouldHalt, bool observing, unsigned int interactionPeriod, 
      unsigned int numInteractions, unsigned int payloadBytes, 
      unsigned long federationHandle = 0,
      unsigned long initFedHandle = 0 );

   virtual void sendNetworkTestEnableMsg( int compId, int federationHdl, bool enable );

   virtual void sendLogEnableMsg( int compId, bool enable );

   virtual void sendObserveRtiexecMsg( int compId, bool isObserved, 
      unsigned int timeStateIntervalMs );

   virtual void sendObserveRtiexecLogMsg( int connId, bool isObserved );

   virtual void sendObserveRtiForwarderMsg( int compId, bool isObserved, 
      unsigned int timeStateIntervalMs, int defunctRemovalTime );

   virtual void sendSingleObserveRtiExecMsg( int compId );

   virtual void sendSingleObserveForwarderMsg( int compId );

   virtual void sendFederateResignMsg( int compId, int federationHdl, int federateHdl );

   virtual void sendFederationDestroyMsg( int compId, int federationHdl );

   virtual void sendDeleteFederateMsg( int compId, DtU16 fedexHandle, DtU16 fedHandle );

   virtual void sendRidParamsRequestMsg( int compId );

   virtual void sendLogRequestMsg( int compId, unsigned maxLogSize );

   virtual void sendNetStatsObservationRequestMsg( DtAssistantObservationType observationType,
      int compId, bool observe = false, unsigned int interval = 0);

   virtual void sendExitMsg( int compId = -1 );

   virtual void sendDoNotWaitForForwardersMsg( int compId );

   virtual void forwardMsg( const DtAssistantMsg& msg );

   virtual void sendSignalTickIntervalMsg( int compId, float signalTickInterval );
   
   virtual int currentCompId() const;

   virtual void closeConn( int compId );

   virtual int port() const;

   virtual DtU32 maxMsgSize() const;

   static void tcpSocketAdditionCb( DtTcpMsgSocket* sock, void* usr );
   static void tcpSocketRemovalCb( DtTcpMsgSocket* sock, void* usr );

   virtual const DtInetAddr& getNetworkAddr();

#ifdef DtDIAGNOSTIC

   void enableMsgDiagnostics( bool enable );

#endif

protected:

   virtual void sendMsg( DtTcpMsgSocket* sock, const DtAssistantMsg& msg );

   virtual void testConnections();
   
   virtual bool readAndProcess( DtTime maxTimePerSocket );

   virtual void tcpSocketAdditionCb( DtTcpMsgSocket* sock );
   virtual void tcpSocketRemovalCb( DtTcpMsgSocket* sock );

   virtual std::auto_ptr<DtAssistantMsg> netRead( DtTcpMsgSocket* sock, int *retCode) const;

   virtual void setMsgFactory(DtAssistantMessageFactory* fact);
   virtual DtAssistantMessageFactory* msgFactory() const;

private:
   DtRtiAssistantServer( const DtRtiAssistantServer& );
   DtRtiAssistantServer& operator=( const DtRtiAssistantServer& );

protected:

   typedef std::map< int, DtTcpMsgSocket* > CompIdToSocketMap;
   typedef std::map< DtTcpMsgSocket*, int > SocketToCompIdMap;

   SocketToCompIdMap myIdsByConnection;

   CompIdToSocketMap myConnectionsById;

   int myNextCompId;

   DtAssistantMessageFactory* myMessageFactory;

   DtAssistantDfltMsgFactory myDefaultMessageFactory;

   DtTcpMsgSocket* myCurrentSocket;

   unsigned int myPort;

   DtClock myClock;

   DtTime myConnTestInterval;

   DtTime myTimeToTestConnections;

   std::auto_ptr<DtTcpMsgSocketMgr> mySocketMgr;

   MAKRti::DtInetAddr myNetworkInterface;

   std::list< DtTcpMsgSocket* > mySocketsToDisconnect;

   DtAssistantMsgCbMgr myMsgCbMgr;

   std::map<int, MAKRti::DtString> myDisconnectReasons;

   DtAssistantSocketAdditionCallbackList myAdditionCallbacks;
   DtAssistantSocketRemovalCallbackList myRemovalCallbacks;

   unsigned myNumMsgsSent;

   unsigned myNumMsgsReceived;

#ifdef DtDIAGNOSTIC
   bool myDiagnosticsEnabled;
#endif
};


#endif