rtiAssistantClient.h

Go to the documentation of this file.

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

#ifndef rtiAssistantClient_H_
#define rtiAssistantClient_H_


#include <vlutil/vlPrint.h>
#include <vlutil/vlMutex.h>
#include <vlutil/vlInetAddr.h>
#include <rtiMsConfig.h>

#include "assistantConnectionInfo.h"
#include "assistantMsgCbMgr.h"
#include "assistantDefaultMsgFact.h"

typedef void (*DtAssistantDisconnectCb)(void* usr);

class DtAssistantNtfyLvlUpdateMsg;
class DtAssistantLatencyReportMsg;
class DtAssistantTestMgrStatusMsg;
class DtAssistantExitMsg;
class DtAssistantSignalTickedMsg;
class DtAssistantDisconnectCbInfo;
class DtTcpMsgSocket;

enum DtAssistantComponentType
{
   DtAssistantNoComponentType,
   DtAssistantLrcComponent,
   DtAssistantForwarderComponent,
   DtAssistantRtiexecComponent,
   DtAssistantShmExecComponent,
   DtAssistantWwwComponent,
   DtAssistantToAssistantComponent

};

enum DtAssistantConnectionStatus
{
   DtAssistantConnected,
   DtAssistantConnectFailed,
   DtAssistantNoResponse,
   DtAssistantConnectRejected,
   DtAssistantWrongDisplay
};


class DT_DLL_ASSISTANT DtRtiAssistantClient
{
public:

   DtRtiAssistantClient( DtAssistantComponentType type, int port = DtASSISTANT_DEFAULT_PORT  );

   virtual ~DtRtiAssistantClient();

private:

   DtRtiAssistantClient( DtRtiAssistantClient const&);

   DtRtiAssistantClient& operator=(DtRtiAssistantClient const&);

public:

   virtual bool tick( unsigned int timeout = 0 );

   virtual bool isConnected();

   virtual bool isDisabled();

   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 addDisconnectCallback(DtAssistantDisconnectCb cb, void* usr);
   virtual void removeDisconnectCallback(DtAssistantDisconnectCb cb, void* usr);

   virtual bool sendLRCConnQueryMsg( bool error, MAKRti::DtInetAddr& relIpAddr,
      MAKRti::DtInetAddr& beIpAddr, MAKRti::DtInetAddr& interfaceAddr,
      int& udpPort, int& tcpPort, bool& useRtiexec, bool& forceFullCompliance,
      int& forwarderPort );

   virtual bool sendForwardingComponentConnQueryMsg( bool error, 
      MAKRti::DtInetAddr& relIpAddr, MAKRti::DtInetAddr& beIpAddr,
      MAKRti::DtInetAddr& interfaceAddr, int& udpPort, int& tcpPort, 
      bool& forceFullCompliance, int& forwarderPort,
      MAKRti::DtInetAddr& forwardrToConnectTo );

   virtual void sendLatencyTestMsg( const DtAssistantLatencyReportMsg& msg );

   virtual void sendLatencyTestStatusMsg( const DtAssistantTestMgrStatusMsg& msg );

   virtual bool getNewLicenseServerFromAssistant( bool allowUnlicensed,
      bool& runUnlicensed, MAKRti::DtString& serverName, const MAKRti::DtString& featToCheck );

   virtual void sendNotifyMsg( const MAKRti::DtString& text, DtNotifyLevelType notifyLevel );

   virtual void sendSignalTickedMsg();
   
   virtual void sendDialogBoxMsg( const MAKRti::DtString& text,
      const MAKRti::DtString& advancedText );

   virtual void sendClose();

   virtual void sendRidParamsMsg( const MAKRti::DtString& params,
      const MAKRti::DtFilename& filename,
      const MAKRti::DtString& federation = MAKRti::DtString::nullString(),
      unsigned federateHdl = 0 );

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

   virtual void shutDownConnection();

   virtual MAKRti::DtString getProcessName() const;

   virtual int getPID() const;

   virtual MAKRti::DtString getCommandArgs() const;

   bool testConnectionStatus();

   virtual int componentId() const;

protected:

   virtual bool initialize();

   virtual DtAssistantConnectionStatus connectToAssistant();

   virtual DtAssistantConnectionStatus makeSingleConnectionAttempt();

   virtual bool startAssistant();
   
   virtual bool readAndProcess( MAKRti::DtTime maxTime );

   virtual bool sendMsg( const DtAssistantMsg& msg );

   virtual DtAssistantMsg* sendMsgAndWait( const DtAssistantMsg& msg, 
      DtAssistantMsgKind respKind, unsigned int waitSecs = 0 );

   virtual DtAssistantConnectionStatus sendConnectMsg();

   static void processRespMsg(const DtAssistantMsg& respMsg, void* usr);
   virtual void processRespMsg(const DtAssistantMsg& respMsg);

   static void processNtfyLvlUpdateMsg(const DtAssistantNtfyLvlUpdateMsg& updateMsg, void* usr);
   virtual void processNtfyLvlUpdateMsg(const DtAssistantNtfyLvlUpdateMsg& updateMsg);

   static void processAssistantExitMsg( const DtAssistantExitMsg& inter, void* usr);
   virtual void processAssistantExitMsg( const DtAssistantExitMsg& inter);

   virtual void processDisconnect();

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

   virtual bool sendLicQueryMsg( bool allowUnlicensed, bool& runUnlicensed,
      MAKRti::DtString& licServer );

   virtual void sendClientInfo();

protected:

   bool myAssistantDisabled;

   MAKRti::DtInetAddr    myAssistantAddr;

   unsigned int  myAssistantPort;

   DtTcpMsgSocket* mySocket;

   bool myCreateIfConnectFails;

   DtAssistantConnectionStatus myConnStatus;

   bool myInitializingConnection;

   MAKRti::DtU32 mySockOpts;

   DtAssistantMessageFactory* myMessageFactory;

   DtAssistantDfltMsgFactory myDefaultMessageFactory;

   DtAssistantComponentType myComponentType;

   MAKRti::DtClock myClock;

   MAKRti::DtTime myConnTestInterval;

   MAKRti::DtTime myTimeToTestConnection;

   DtAssistantMsgCbMgr myMsgCbMgr;

   std::auto_ptr<DtAssistantMsg> myRespMsg;

   std::list<DtAssistantDisconnectCbInfo*> myDisconnectCallbacks;

   MAKRti::DtMutex* mySocketMutex;

   bool myShouldShutdown;

   static const int theMaxNumberOfAssistantConnectAttempts;

   int myNumFailedAssistantConnects;

   int myNumSuccessfulAssistantConnects;

   static const MAKRti::DtInetAddr theFirstHostInetAddr;

   int myPID;

   MAKRti::DtString myProcessName;

   MAKRti::DtString myCommandArgs;

   int myAssistantCompId;

};

#endif