![]() |
MAK RTIspy API Documentation for HLA Evolved
|
Collaboration diagram for DtRtiExec:Public Member Functions | |
| virtual | ~DtRtiExec () |
| Destructor. More... | |
| virtual void | shutdownForwarderIfCreated () |
| virtual void | shutdownFederationShadow (DtHandle handle, const DtString &name) |
| virtual void | checkVersion (const DtString &version) const |
| Called by the exec application to make sure that the RTI Version matches. More... | |
| virtual DtFedExec * | createFedEx (DtConnectionMgr *connMgr, const std::vector< unsigned int > &crcs, const char *fedExName, std::string const &timeImplName, MAKRti::DtFomType fedType, const std::vector< DtString > &fedFileName, const DtString &momModuleName, int fedExHandle, DtRIDParameters *params, unsigned int momModuleCrc) |
| Returns a new fed ex instance, Override this function to replace the default federation execution object. More... | |
| DtConnectionMgr * | connectMgr () |
| Returns the connection manager Not virtual because referenced in both ctors and dtors. More... | |
| virtual bool | exists (const DtString &fedExName) |
| Returns true if the name fedex exists, false otherwise. More... | |
| virtual void | destroyFederationByName (const DtString &fullFedexName, bool sendDestroyResponse=true, bool forceDestroy=false) |
| Attempt to destroy a federation. More... | |
| int | processQuit () |
| User request to quit is processed. More... | |
| virtual void | listFederates () |
| Respond to a request to list federates through interactive input. More... | |
| virtual void | parseDeleteCommand (const DtString &command, unsigned int &handle, DtString &federationName) const |
| Respond to a request to delete a federate through interactive input. More... | |
| virtual int | deleteFederate (unsigned int handle, const DtString &federationName) |
| virtual void | processUpdateNotifyLevel (DtNotifyLevelType level) |
| Updates the rtiexec notify level. More... | |
| virtual void | exit () |
| Causes the rtiexec to exit. More... | |
| virtual void | enableLogging () |
| Enables logging. More... | |
| virtual RTI_API::Authorizer * | authorizer () |
| Get the authorizer. More... | |
| DtFedExec * | fedExec (const DtString &fedExName) |
| Search for a fed rtiexec by name. More... | |
| const DtFedExec * | fedExec (const DtString &fedExName) const |
| const std::map< DtString, DtFedExec * > & | fedExecs () const |
| Returns a reference to the entire map of federations. More... | |
| const DtRIDParameters & | params () const |
| Returns a handle to the current RID Params. More... | |
| virtual void | run () |
| main loop More... | |
| virtual bool | tick (bool noCallbacks=false) |
| Work performed here for each cycle in main loop. More... | |
| virtual void | wait (DtTime intervalInSeconds) |
| Wait for input or until the the given interval expires. More... | |
| virtual void | ridRequestCb (const DtRidTestRequestMsg &msg) |
| The RID request callback is processed by the RTI in response to a ridTestRequest. More... | |
| virtual void | processCreate (const DtCreateMsg &msg) |
| Message callback functions call these methods to process the message. More... | |
| virtual void | processDestroy (const DtDestroyMsg &msg) |
| Message callback functions call these methods to process the message. More... | |
| virtual void | processListFederations (const DtListFederationsMsg &msg) |
| Message callback functions call these methods to process the message. More... | |
| virtual void | processListFederationMembers (const DtListFederationMembersMsg &msg) |
| Message callback functions call these methods to process the message. More... | |
| virtual void | processJoin (const DtJoinMsg &msg) |
| Message callback functions call these methods to process the message. More... | |
| virtual void | processDisconnect (const DtDisconnectMsg &msg) |
| Used to capture broken connection. More... | |
| virtual void | processQueueFull (const DtQueueFullMsg &msg) |
| Message callback functions call these methods to process the message. More... | |
| virtual void | processReconnect (const DtReconnectMsg &msg) |
| Used to recover from a broken connection. More... | |
| virtual void | addFedExCreatedCallback (DtFedExCbFn fn, void *usr) |
| Register/remove a callback for specified events. More... | |
| virtual void | removeFedExCreatedCallback (DtFedExCbFn fn, void *usr) |
| Register/remove a callback for specified events. More... | |
| virtual void | addFedExDestroyedCallback (DtFedExCbFn fn, void *usr) |
| Register/remove a callback for specified events. More... | |
| virtual void | removeFedExDestroyedCallback (DtFedExCbFn fn, void *usr) |
| Register/remove a callback for specified events. More... | |
| virtual void | addLogFileNameUpdatedCallback (DtLogFileNameCbFn fn, void *usr) |
| Register/remove a callback for specified events. More... | |
| virtual void | removeLogFileNameUpdatedCallback (DtLogFileNameCbFn fn, void *usr) |
| Register/remove a callback for specified events. More... | |
| virtual void | addTickCallback (DtTickCbFn fn, void *usr, DtTime interval) |
| Called during tick, but only at the given interval. More... | |
| virtual void | removeTickCallback (DtTickCbFn fn, void *usr) |
| Register/remove a callback for specified events. More... | |
| virtual void | addTickCallback (DtTickWithExecCbFn fn, void *usr, DtTime interval) |
| Called during tick, but only at the given interval. More... | |
| virtual void | removeTickCallback (DtTickWithExecCbFn fn, void *usr) |
| Register/remove a callback for specified events. More... | |
| virtual void | sendCreateResponseMsg (const unsigned long destinationID, DtCreateResponseFlag flag, MAKRti::DtString const &errorString) |
| Send RTI messages. More... | |
| virtual void | sendDestroyResponseMsg (const char *fedExName, DtDestroyResponseFlag flag) |
| Send RTI messages. More... | |
| virtual void | sendReportFederationsMsg (unsigned long destId, const std::vector< DtString > &federationNames, const std::vector< DtString > &timeImplNames) |
| Send RTI messages. More... | |
| virtual void | sendReportFederationMembersMsg (unsigned long destId, DtString federationName, DtReportFederationMembersMsg::DtFederateList *federates) |
| Send RTI messages. More... | |
| virtual void | sendJoinResponseMsg (unsigned long destinationIDValue, unsigned short requestID, unsigned int crc, DtFederateHandle handle, const char *fedName, int fedExHandle, const char *fedExName, const DtString &momModule, const std::vector< DtString > &fedFileName, unsigned long flags, bool allowNetworkTesting, MAKRti::DtString const &errorString, DtJoinResponseMsg::errorCodes errorValue=DtJoinResponseMsg::DT_NO_ERROR) |
| Send RTI messages. More... | |
Static Public Member Functions | |
| static DtRtiExec * | create (DtRIDParameters *p, std::shared_ptr< DtFilePrinter > logPrinter, bool autoExit=false, const DtRtiConnectionInfoDataPair &connInfo=DtRtiConnectionInfoDataPair()) |
| Creates an instance of a DtRtiExec;. More... | |
| static void | setCreatorFunction (DtRtiExecCreator fn) |
| Call this function to set an alternate creator function With this function, users can replace this DtRtiExec with their own derived class. More... | |
| static bool | shutdownSignalCaught () |
| static void | caughtShutdownSignal () |
| static void | processRtiExecHandshakeMsg (const DtRtiExecHandshakeMsg &msg, void *usr) |
| Message callback function used to register callbacks. More... | |
| static void | processCreate (const DtCreateMsg &msg, void *usr) |
| Message callback function used to register callbacks. More... | |
| static void | processDestroy (const DtDestroyMsg &msg, void *usr) |
| Message callback function used to register callbacks. More... | |
| static void | processListFederations (const DtListFederationsMsg &msg, void *usr) |
| Message callback function used to register callbacks. More... | |
| static void | processListFederationMembers (const DtListFederationMembersMsg &msg, void *usr) |
| Message callback function used to register callbacks. More... | |
| static void | processJoin (const DtJoinMsg &msg, void *usr) |
| Message callback function used to register callbacks. More... | |
| static void | processDisconnect (const DtDisconnectMsg &msg, void *usr) |
| Message callback function used to register callbacks. More... | |
| static void | processQueueFull (const DtQueueFullMsg &msg, void *usr) |
| Message callback function used to register callbacks. More... | |
| static void | processReconnect (const DtReconnectMsg &msg, void *usr) |
| Message callback function used to register callbacks. More... | |
| static void | ridRequestCb (const DtRidTestRequestMsg &msg, void *usr) |
| Message callback function used to register callbacks. More... | |
Protected Types | |
| enum | DtStartRtiForwarderResult { ForwarderSuccessfullyStarted, RetryStartingForwarder, ForwarderStartupFailed } |
| typedef std::map< unsigned long, DtTime > | DtConnIdToTimeMap |
Protected Member Functions | |
| DtRtiExec (DtRIDParameters *p, std::shared_ptr< DtFilePrinter > logPrinter, bool autoExit, const DtRtiConnectionInfoDataPair &connInfo) | |
| Constructor. More... | |
| void | cleanupConstructorException () |
| Clean up before constructor throws an exception Not virtual since it is called by constructor. More... | |
| virtual void | rtiExecToForwarderHandshake () |
| Inform RTI Forwarder that Exec is connected, and verify that this is the ONLY Exec connected. More... | |
| virtual void | sendRtiExecHandshakeMsg (DtHandle destId, DtRtiExecHandshakeMsg::DtHandshakeStatus status) |
| Send RTI Forwarder connection response msg. More... | |
| virtual void | processRtiExecHandshakeMsg (const DtRtiExecHandshakeMsg &msg) |
| Process the RTI Forwarder's Handshake response. More... | |
| virtual void | performMulticastDiscovery (bool reliableTransportDisabled) |
| Attempt to discover either the RTI Forwarder or other rtiexecs. More... | |
| virtual void | removeDroppedFederateConnections () |
| Force resign a federate. More... | |
| virtual DtStartRtiForwarderResult | startRtiForwarder (const DtRIDParameters *params) |
| Starts forwarder if the exec is configured to do so. More... | |
| virtual bool | startFederationShadow (DtHandle federationHandle, const DtString &federationName) |
| Start a federation shadow process for the given federation. More... | |
| virtual bool | authorizeFederationOperation (const DtCreateMsg &msg, DtString &errorMessage) |
| Process authorization of the given credentials for create federation service. More... | |
Static Protected Attributes | |
| static bool | theShutdownSignalCaught |
| static DtRtiExecCreator | theCreator |
|
protected |
|
protected |
|
protected |
Constructor.
|
virtual |
Destructor.
|
virtual |
Register/remove a callback for specified events.
|
virtual |
Register/remove a callback for specified events.
|
virtual |
Register/remove a callback for specified events.
|
virtual |
Called during tick, but only at the given interval.
|
virtual |
Called during tick, but only at the given interval.
For callbacks which will be passed a reference to the calling DtRtiExec.
|
protectedvirtual |
Process authorization of the given credentials for create federation service.
|
virtual |
Get the authorizer.
|
static |
|
virtual |
Called by the exec application to make sure that the RTI Version matches.
|
protected |
Clean up before constructor throws an exception Not virtual since it is called by constructor.
|
inline |
Returns the connection manager Not virtual because referenced in both ctors and dtors.
References myConnectionMgr.
|
static |
Creates an instance of a DtRtiExec;.
|
virtual |
Returns a new fed ex instance, Override this function to replace the default federation execution object.
|
virtual |
|
virtual |
Attempt to destroy a federation.
By default, if destruction fails, a destroy response is sent. If this is being called in response to a command at the rtiexec GUI, then no response needs to be sent. If forceDestroy is set, federation is destroyed regardless of whether it has joined federates.
|
virtual |
Enables logging.
|
virtual |
Returns true if the name fedex exists, false otherwise.
|
virtual |
Causes the rtiexec to exit.
| DtFedExec* DtRtiExec::fedExec | ( | const DtString & | fedExName | ) |
Search for a fed rtiexec by name.
Returns NULL if none are found.
| const DtFedExec* DtRtiExec::fedExec | ( | const DtString & | fedExName | ) | const |
| const std::map<DtString, DtFedExec*>& DtRtiExec::fedExecs | ( | ) | const |
Returns a reference to the entire map of federations.
|
virtual |
Respond to a request to list federates through interactive input.
|
inline |
Returns a handle to the current RID Params.
References myParams.
|
virtual |
Respond to a request to delete a federate through interactive input.
|
protectedvirtual |
Attempt to discover either the RTI Forwarder or other rtiexecs.
|
virtual |
Message callback functions call these methods to process the message.
|
static |
Message callback function used to register callbacks.
|
virtual |
Message callback functions call these methods to process the message.
|
static |
Message callback function used to register callbacks.
|
virtual |
Used to capture broken connection.
|
static |
Message callback function used to register callbacks.
|
virtual |
Message callback functions call these methods to process the message.
|
static |
Message callback function used to register callbacks.
|
virtual |
Message callback functions call these methods to process the message.
|
static |
Message callback function used to register callbacks.
|
virtual |
Message callback functions call these methods to process the message.
|
static |
Message callback function used to register callbacks.
|
virtual |
Message callback functions call these methods to process the message.
|
static |
Message callback function used to register callbacks.
| int DtRtiExec::processQuit | ( | ) |
User request to quit is processed.
If there are no federations, quit is granted immediately. Otherwise, a pending quit status is set to true and the user is prompted to confirm the quit request. Return -1 if quit should be granted immediately.
|
virtual |
Used to recover from a broken connection.
|
static |
Message callback function used to register callbacks.
|
static |
Message callback function used to register callbacks.
|
protectedvirtual |
Process the RTI Forwarder's Handshake response.
|
virtual |
Updates the rtiexec notify level.
|
protectedvirtual |
Force resign a federate.
|
virtual |
Register/remove a callback for specified events.
|
virtual |
Register/remove a callback for specified events.
|
virtual |
Register/remove a callback for specified events.
|
virtual |
Register/remove a callback for specified events.
|
virtual |
Register/remove a callback for specified events.
|
virtual |
The RID request callback is processed by the RTI in response to a ridTestRequest.
It fills up a ridResponse with the number of RID parameters that it wants consistent and sends the response back to the federate that requested it.
|
static |
Message callback function used to register callbacks.
|
protectedvirtual |
Inform RTI Forwarder that Exec is connected, and verify that this is the ONLY Exec connected.
|
virtual |
main loop
|
virtual |
Send RTI messages.
|
virtual |
Send RTI messages.
|
virtual |
Send RTI messages.
|
virtual |
Send RTI messages.
|
virtual |
Send RTI messages.
|
protectedvirtual |
Send RTI Forwarder connection response msg.
|
static |
Call this function to set an alternate creator function With this function, users can replace this DtRtiExec with their own derived class.
|
virtual |
|
virtual |
|
static |
|
protectedvirtual |
Start a federation shadow process for the given federation.
|
protectedvirtual |
Starts forwarder if the exec is configured to do so.
return zero on error.
|
virtual |
Work performed here for each cycle in main loop.
Primarily processing messages and ticking each federation execution. Returns boolean: tick processed a message? If noCallbacks is true, no tick callbacks will be called
|
virtual |
Wait for input or until the the given interval expires.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Referenced by connectMgr().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Map of dropped Federate to timestamp of drop.
|
protected |
|
protected |
|
protected |
Flag indicating that an exit command was received.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
List of log file name update callbacks.
|
protected |
Printer which prints output to a log file.
|
protected |
|
protected |
|
protected |
Referenced by params().
|
protected |
|
protected |
|
protected |
|
protected |
List of tick callbacks.
|
protected |
List of tick callbacks with DtRtiExec reference.
|
staticprotected |
|
staticprotected |