 |
MAK RTIspy API Documentation for HLA 4
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
MAK RTIspy API Documentation for HLA 4
|
The client connection to the RTI Assistant for an LRC. More...
Inheritance diagram for DtRtiAssistantToAssistantClient: Collaboration diagram for DtRtiAssistantToAssistantClient:Public Member Functions | |
| DtRtiAssistantToAssistantClient (int port=0) | |
| virtual | ~DtRtiAssistantToAssistantClient () |
| virtual bool | sendShowDialogMsg (DtAssistantShowDialogMsg::DtAssistantShowDialogEnum dialog) |
| Instruct the assistant to show the rti connection dialog returns true if succesfull. More... | |
| virtual void | sendShutdownMessage (DtAssistantShutdownMsg::DtShutdownEnum shouldForce) |
| Instruct the assistant to shutdown. More... | |
| virtual void | sendCommandMessage (DtRtiAssistantCommand command) |
| Send a command to the connected Assistant. More... | |
| virtual MAKRti::DtString | sendInteractiveCommandMessage (DtRtiAssistantCommand command) |
| Query some information from the connected assistant. More... | |
| virtual void | sendClientInfo (bool isReconnect=false) override |
| We have no pertinent info, this fcn is a nop. More... | |
| Public Member Functions inherited from DtRtiAssistantClient | |
| DtRtiAssistantClient (DtAssistantComponentType type, int port=DtASSISTANT_DEFAULT_PORT) | |
| Constructor. More... | |
| virtual | ~DtRtiAssistantClient () |
| Destructor. More... | |
| virtual bool | tick (unsigned int timeout=0) |
| Do the actual message processing. More... | |
| virtual bool | isConnected () |
| Returns true if the socket is connected. More... | |
| virtual bool | isDisabled () |
| Returns true if the socket is disabled. More... | |
| virtual void | addMsgCallback (DtAssistantMsgKind msgKind, DtAssistantMsgCbMgr::DtCallbackFcn fcn, void *usr) |
| Message Callbacks These callback functions operate on all of the connections. More... | |
| 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) |
| These functions add callbacks for notification of a socket disconnect. More... | |
| virtual void | removeDisconnectCallback (DtAssistantDisconnectCb cb, void *usr) |
| virtual bool | sendLRCConnQueryMsg (bool error, MAKRti::DtString &connectionName, bool &ridIsPreconfigured, MAKRti::DtString &ridConfig, MAKRti::DtInetAddr &tcpAddr, int &tcpPort, MAKRti::DtInetAddr &tcpIntf, MAKRti::DtInetAddr &udpAddr, int &udpPort, MAKRti::DtInetAddr &udpIntf, int &forwarderPort, bool &useRtiexec, bool &forceFullCompliance) |
| Send a message querying for the connection parameters. More... | |
| virtual bool | sendForwardingComponentConnQueryMsg (bool error, MAKRti::DtString &connectionName, bool &ridIsPreconfigured, MAKRti::DtString &ridConfig, MAKRti::DtInetAddr &tcpAddr, int &tcpPort, MAKRti::DtInetAddr &tcpIntf, MAKRti::DtInetAddr &udpAddr, int &udpPort, MAKRti::DtInetAddr &udpIntf, MAKRti::DtInetAddr &forwarderToConnectTo, int &forwarderPort, bool &forceFullCompliance) |
| Send a message querying for the rtiexec connection parameters. More... | |
| virtual void | sendLatencyTestMsg (const DtAssistantLatencyReportMsg &msg) |
| Send a message to the assistant with latency test measurements. More... | |
| virtual void | sendLatencyTestStatusMsg (const DtAssistantTestMgrStatusMsg &msg) |
| Send an updated latency test status message to the assistant. More... | |
| virtual bool | getNewLicenseServerFromAssistant (bool allowUnlicensed, bool &runUnlicensed, MAKRti::DtString &serverName, const MAKRti::DtString &featToCheck) |
| Send a message to the assistant to query the user for an alternate license server. More... | |
| virtual void | sendNotifyMsg (const MAKRti::DtString &text, DtNotifyLevelType notifyLevel) |
| Send a message to display a pop up notification above the tray icon. More... | |
| virtual void | sendSignalTickedMsg () |
| Send a signal ticked message to the assistant. More... | |
| virtual void | sendDialogBoxMsg (const MAKRti::DtString &text, const MAKRti::DtString &advancedText) |
| Send a message to display a dialog notification. More... | |
| virtual void | sendClose () |
| Send connection closed message to Assistant. More... | |
| virtual void | sendRidParamsMsg (const MAKRti::DtString ¶ms, const MAKRti::DtFilename &filename, const MAKRti::DtString &federation=MAKRti::DtString::nullString(), unsigned federateHdl=0) |
| Send the RID parameters. More... | |
| virtual void | setMsgFactory (DtAssistantMessageFactory *fact) |
| Get/Set the message factory. More... | |
| virtual DtAssistantMessageFactory * | msgFactory () const |
| virtual void | shutDownConnection (const char *reason) |
| AssistantClientOwner should call this function with the shutdown reason when the Assistant instructs it to shut down (e.g. More... | |
| virtual MAKRti::DtString | getProcessName () const |
| get the process name More... | |
| virtual int | getPID () const |
| get the PID More... | |
| virtual MAKRti::DtString | getCommandArgs () const |
| get the command args More... | |
| bool | testConnectionStatus () |
| test the connection More... | |
| virtual int | componentId () const |
| Returns the component ID assigned by the assistant. More... | |
Protected Attributes | |
| MAKRti::DtString | myName |
| The name the Assistant uses to identify this LRC. More... | |
| Protected Attributes inherited from DtRtiAssistantClient | |
| bool | myAssistantDisabled |
| Set to true if the Assistant is disabled. More... | |
| MAKRti::DtInetAddr | myAssistantAddr |
| The IP address of the Assistant. More... | |
| unsigned int | myAssistantPort |
| The port on which the RTI Assistant listens for connections. More... | |
| DtTcpMsgSocket * | mySocket |
| The socket to the RTI Assistant. More... | |
| bool | myCreateIfConnectFails |
| Indicates whether an Assistant should be created if a connection cannot be established. More... | |
| DtAssistantConnectionStatus | myConnStatus |
| The current connection status. More... | |
| bool | myInitializingConnection |
| Is connection being initialized. More... | |
| MAKRti::DtU32 | mySockOpts |
| The socket options to be used when connecting to the Assistant. More... | |
| DtAssistantMessageFactory * | myMessageFactory |
| The message factory. More... | |
| DtAssistantDfltMsgFactory | myDefaultMessageFactory |
| Default message factory. More... | |
| DtAssistantComponentType | myComponentType |
| The component type. (LRC, rtiexec, etc.) More... | |
| MAKRti::DtClock | myClock |
| Clock for timeouts. More... | |
| MAKRti::DtTime | myConnTestInterval |
| Interval at which connection should be tested. More... | |
| MAKRti::DtTime | myTimeToTestConnection |
| Next time to test connection. More... | |
| DtAssistantMsgCbMgr | myMsgCbMgr |
| Message callback manager. More... | |
| DtUniquePtr< DtAssistantMsg > | myRespMsg |
| The last response message to be received. More... | |
| std::list < DtAssistantDisconnectCbInfo * > | myDisconnectCallbacks |
| Lists of pointers to socket disconnect callbacks. More... | |
| MAKRti::DtMutex * | mySocketMutex |
| locks access to the socket connection. More... | |
| const char * | myShouldShutdown |
| should be set with reason string when assistant exit msg has been received. More... | |
| int | myNumFailedAssistantConnects |
| How many assistant restarts have we attempted. More... | |
| int | myNumSuccessfulAssistantConnects |
| How many assistant reconnects occurred. More... | |
| int | myPID |
| the Process ID ( PID ) More... | |
| MAKRti::DtString | myProcessName |
| the Process Name More... | |
| MAKRti::DtString | myCommandArgs |
| the command line arguments More... | |
| int | myAssistantCompId |
| The assistant assigned component ID. More... | |
| unsigned long | mySequence |
| Message sequence number. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from DtRtiAssistantClient | |
| virtual bool | initialize () |
| Attempts to connect to the RTI Assistant. More... | |
| virtual DtAssistantConnectionStatus | connectToAssistant () |
| Attempt to open a connection and handshake with the Assistant. More... | |
| virtual DtAssistantConnectionStatus | makeSingleConnectionAttempt () |
| virtual bool | startAssistant () |
| Attempt to start a new Assistant. More... | |
| virtual bool | readAndProcess (MAKRti::DtTime maxTime) |
| Read and process any messages on the socket for up to the maxTime. More... | |
| virtual bool | sendMsg (const DtAssistantMsg &msg) |
| Send a message to the RTI Assistant. More... | |
| virtual DtAssistantMsg * | sendMsgAndWait (const DtAssistantMsg &msg, DtAssistantMsgKind respKind, unsigned int waitSecs=0) |
| Send a message to the RTI Assistant and wait for response of the specified kind. More... | |
| virtual DtAssistantConnectionStatus | sendConnectMsg () |
| Send basic component information to the Assistant for a new connection. More... | |
| virtual void | processRespMsg (const DtAssistantMsg &respMsg) |
| virtual void | processNtfyLvlUpdateMsg (const DtAssistantNtfyLvlUpdateMsg &updateMsg) |
| virtual void | processAssistantExitMsg (const DtAssistantExitMsg &inter) |
| virtual void | processDisconnect () |
| Process Assistant socket disconnect. More... | |
| virtual DtUniquePtr < DtAssistantMsg > | netRead (int *retCode) const |
| Attempt to read a new message from the socket. More... | |
| virtual bool | sendLicQueryMsg (bool allowUnlicensed, bool &runUnlicensed, MAKRti::DtString &licServer) |
| Send a message querying for the license server. More... | |
| Static Protected Member Functions inherited from DtRtiAssistantClient | |
| static void | processRespMsg (const DtAssistantMsg &respMsg, void *usr) |
| Response message callback. More... | |
| static void | processNtfyLvlUpdateMsg (const DtAssistantNtfyLvlUpdateMsg &updateMsg, void *usr) |
| Notify level update message callback. More... | |
| static void | processAssistantExitMsg (const DtAssistantExitMsg &inter, void *usr) |
| Process the assistant exit message. The assistant is commanding us to exit. More... | |
| Static Protected Attributes inherited from DtRtiAssistantClient | |
| static const int | theMaxNumberOfAssistantConnectAttempts |
| either starting up or reconnecting, how many assistant restarts do we tolerate before giving up. More... | |
| static const MAKRti::DtTime | theSleepBetweenAssistantConnectAttempts |
| When attempting to connect, this is the number of seconds. More... | |
| static const MAKRti::DtInetAddr | theFirstHostInetAddr |
| The first InetAddr when the federate was launched. More... | |
The client connection to the RTI Assistant for an LRC.
DtrtiAssistantToAssistantClient manages the client connection of an LRC to the RTI Assistant. Provides routines to create and send messages to the Assistant.
| DtRtiAssistantToAssistantClient::DtRtiAssistantToAssistantClient | ( | int | port = 0 | ) |
|
virtual |
|
inlineoverridevirtual |
We have no pertinent info, this fcn is a nop.
Indicate whether this is being sent after a reconnect or not (makes no sense here but used by other clients)
Reimplemented from DtRtiAssistantClient.
|
virtual |
Send a command to the connected Assistant.
|
virtual |
Query some information from the connected assistant.
|
virtual |
Instruct the assistant to show the rti connection dialog returns true if succesfull.
|
virtual |
Instruct the assistant to shutdown.
Either show a confirmation dialog or shutdown forcefully.
|
protected |
The name the Assistant uses to identify this LRC.
