![]() |
MAK Data Logger API Documentation for DIS
|
Primary interface to remote loggers. More...
Collaboration diagram for MAKLogger::DtRemoteControlInterface:Classes | |
| struct | DtPendingAcknowledge |
| Entry for pending acknowledgment. More... | |
Public Member Functions | |
| DtRemoteControlInterface (int numberOfLoggersToManage=0) | |
| Main constructor. More... | |
| virtual | ~DtRemoteControlInterface () |
| Destructor. More... | |
| virtual void | setConnection (DtExerciseConn *exconn, const DtEntityIdentifier &entityId) |
| Register callbacks with a newly created exconn. More... | |
| virtual void | setConnection (const DtEntityIdentifier &id, DtInetSocket *socket) |
| Use a back channel connection. More... | |
| virtual void | clearConnection () |
| Unregister callbacks. More... | |
| virtual void | disconnect (const DtEntityIdentifier &entityId) |
| Disconnect the logger with the given ID. More... | |
| virtual void | tick () |
| Called periodically to process control pdus to send and receive. More... | |
| virtual void | getConnectionIds (DtEntityIdSet &connectedLoggers) const |
| Get the set of connected loggers. More... | |
| virtual void | getConnectionIds (DtEntityIdSet &connectedLoggers, const DtEntityIdentifier &idFilter) const |
| Get the set of connected loggers that match the given ID that may contain wildcards. More... | |
| virtual int | numberConnections () const |
| Return the number of connected loggers. More... | |
| virtual DtRemoteLoggerConnection * | getConnection (const DtEntityIdentifier &id) |
| Get the connection info for the given ID. More... | |
| virtual DtTime | lowestTime () const |
| Get the time of the logger with the lowest current time. More... | |
| virtual DtTime | highestTime () const |
| Get the time of the logger with the highest current time. More... | |
| virtual DtSequenceNumber | sendCommandMessage (const DtCommand &command, const DtEntityIdentifier &target=theWildcardAddress) |
| Send a command message Return the message sequence number. More... | |
| virtual DtSequenceNumber | sendCommandMessage (const DtCommand &command, DtRemoteControlDomainInterface *domainInterface, const DtEntityIdentifier &target=theWildcardAddress) |
| Send a command message Return the message sequence number. More... | |
| virtual DtSequenceNumber | sendLoggerControlMessage (DtLgrControlPdu &lgrControl, const DtEntityIdentifier &target=theWildcardAddress) |
| Send a logger control message Return the message sequence number. More... | |
| virtual DtSequenceNumber | sendLoggerControlMessage (DtLgrControlPdu &lgrControl, DtRemoteControlDomainInterface *domainInterface, const DtEntityIdentifier &target=theWildcardAddress) |
| Send a logger control message Return the message sequence number. More... | |
| const DtRemoteLoggerMap & | getMyRemoteLoggerMap () const |
| virtual void | setId (const DtEntityIdentifier &id) |
| Set/Get our ID. More... | |
| virtual const DtEntityIdentifier & | id () const |
| Set/Get our ID. More... | |
| virtual void | setAcceptAnyId (bool acceptAny) |
| Set/Get control to accept any identifier. More... | |
| virtual bool | acceptAnyId () const |
| Set/Get control to accept any identifier. More... | |
| virtual DtTime | connectionTimeout () const |
| Set/Get connection timeout threashold. More... | |
| virtual void | setConnectionTimeout (DtTime val) |
| Set/Get connection timeout threashold. More... | |
| virtual DtTime | acknowledgeTimeout () const |
| Set/Get acknowledge timeout threshold. More... | |
| virtual void | setAcknowledgeTimeout (DtTime val) |
| Set/Get acknowledge timeout threshold. More... | |
| virtual void | setNumberOfLoggers (int numberOfLoggersToManage) |
| Set/Get number of loggers expected to connect. More... | |
| virtual int | numberOfLoggers () const |
| Set/Get number of loggers expected to connect. More... | |
| virtual void | setPassivelyAccepting (bool enablePassivelyAccept) |
| Set/Get control to passively accept all responses. More... | |
| virtual bool | isPassivelyAccepting () const |
| Set/Get control to passively accept all responses. More... | |
Get the command domain interfaces | |
| virtual DtRemoteControlSystemInterface * | systemInterface () |
| virtual DtRemoteControlPlaybackInterface * | playbackInterface () |
| virtual DtRemoteControlRecordInterface * | recordInterface () |
| virtual DtRemoteControlEditorInterface * | editorInterface () |
| virtual DtRemoteControlSimulationInterface * | simulationInterface () |
| virtual DtRemoteControlSharedInterface * | sharedInterface () |
Add/Remove callback for various logger control messages / events | |
| virtual void | addCallback (DtLgrConnectCb cb, void *user) |
| virtual void | removeCallback (DtLgrConnectCb) |
| virtual void | addCallback (DtLgrDisconnectCb cb, void *user) |
| virtual void | removeCallback (DtLgrDisconnectCb) |
| virtual void | addCallback (DtLgrLgrHeartbeatCb cb, void *user) |
| virtual void | removeCallback (DtLgrLgrHeartbeatCb) |
| virtual void | addCallback (DtLgrAcknowledgeCb cb, void *user) |
| virtual void | removeCallback (DtLgrAcknowledgeCb) |
| virtual void | addCallback (DtLgrResponseCb cb, void *user) |
| virtual void | removeCallback (DtLgrResponseCb) |
| virtual void | addCallback (DtLgrTotalStateCb cb, void *user) |
| virtual void | removeCallback (DtLgrTotalStateCb) |
| virtual void | addCallbackConnectionAdded (DtLgrConnectionAddedCb cb, void *user) |
| virtual void | removeCallbackConnectionAdded (DtLgrConnectionAddedCb) |
| virtual void | addCallbackConnectionRemoved (DtLgrConnectionRemovedCb cb, void *user) |
| virtual void | removeCallbackConnectionRemoved (DtLgrConnectionRemovedCb) |
| virtual void | addCallbackConnectionTimedOut (DtLgrConnectionTimedOutCb cb, void *user) |
| virtual void | removeCallbackConnectionTimedOut (DtLgrConnectionTimedOutCb) |
| virtual void | addCallbackCommandAccepted (DtLgrCommandAcceptedCb cb, void *user) |
| virtual void | removeCallbackCommandAccepted (DtLgrCommandAcceptedCb) |
| virtual void | addCallbackCommandRejected (DtLgrCommandRejectedCb cb, void *user) |
| virtual void | removeCallbackCommandRejected (DtLgrCommandRejectedCb) |
| virtual void | addCallbackCommandTimedOut (DtLgrCommandTimedOutCb cb, void *user) |
| virtual void | removeCallbackCommandTimedOut (DtLgrCommandTimedOutCb) |
Static Public Member Functions | |
| static const DtEntityIdentifier & | wildcardAddress () |
| The wildcard address. More... | |
| static const char * | commandToString (int domain, int command) |
| Return the string name for the command/response ID. More... | |
Protected Types | |
| typedef struct MAKLogger::DtRemoteControlInterface::DtPendingAcknowledge | DtPendingAcknowledge |
| Entry for pending acknowledgment. More... | |
| typedef std::map < DtSequenceNumber, DtPendingAcknowledge > | DtPendingAcknowledgeList |
| typedef std::map < DtSequenceNumber, DtTime > | DtRejectCommandList |
| typedef std::map < DtSequenceNumber, DtRemoteControlDomainInterface * > | DtAcknowledgeDomainMap |
| typedef std::list < DtLgrControlPdu * > | DtPduList |
Protected Member Functions | |
| virtual void | lgrCtrlCallback (DtInteraction *) |
| Implementation of callback. More... | |
| virtual void | processControlPdus () |
| Called periodically to process control pdus received. More... | |
| virtual void | processBackChannel () |
| Process back channel connection. More... | |
| virtual void | checkConnections () |
| Called periodically to check connection timeouts. More... | |
| virtual bool | isIdMatching (const DtEntityIdentifier &targetId, bool allowWildCard=true) |
| Does the given target ID match the interface ID? More... | |
| virtual DtSequenceNumber | nextSequenceNumber () |
| Get next sequence number. More... | |
| virtual void | commandAccepted (DtSequenceNumber sequenceNumber) |
| Command acknowledged. More... | |
| virtual void | commandRejected (const DtEntityIdentifier &source, DtSequenceNumber sequenceNumber) |
| Command rejected. More... | |
| virtual void | commandTimedOut (DtSequenceNumber sequenceNumber) |
| Command timed out. More... | |
| virtual void | sendMessage (const DtLgrControlPdu &message) |
| Send a message. More... | |
Process logger control PDUs | |
| virtual void | processTotalState (DtLgrTotalStatePdu *totalStatePdu) |
| virtual void | processConnect (DtLgrConnectPdu *connectPdu) |
| virtual void | processDisconnect (DtLgrDisconnectPdu *disconnectPdu) |
| virtual void | processLgrHeartbeat (DtLgrLgrHeartbeatPdu *lgrHeartbeatPdu) |
| virtual void | processAcknowledge (DtLgrAcknowledgePdu *acknowledgePdu) |
| virtual void | processResponse (DtLgrResponsePdu *responsePdu) |
Static Protected Member Functions | |
| static void | lgrCtrlCb (DtInteraction *, void *) |
| Static callback function. More... | |
Static Protected Attributes | |
| static const DtU16 | theAddressWildcard = ((1<<16)-1) |
| static const DtEntityIdentifier | theWildcardAddress |
Private Member Functions | |
| DtRemoteControlInterface (const DtRemoteControlInterface &) | |
| Not Implemented. More... | |
| DtRemoteControlInterface & | operator= (const DtRemoteControlInterface &) |
| Not Implemented. More... | |
Primary interface to remote loggers.
Responsible for sending and receiving logger messages and decoding them into commands.
|
protected |
|
protected |
|
protected |
Entry for pending acknowledgment.
|
protected |
|
protected |
| MAKLogger::DtRemoteControlInterface::DtRemoteControlInterface | ( | int | numberOfLoggersToManage = 0 | ) |
Main constructor.
Interface will permit the given number of loggers to connect. If 0, any number of loggers may connect.
|
virtual |
Destructor.
|
private |
Not Implemented.
|
virtual |
Set/Get control to accept any identifier.
|
virtual |
Set/Get acknowledge timeout threshold.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
protectedvirtual |
Called periodically to check connection timeouts.
|
virtual |
Unregister callbacks.
Thus should be called before deleting an exercise connection.
|
protectedvirtual |
Command acknowledged.
|
protectedvirtual |
Command rejected.
|
protectedvirtual |
Command timed out.
|
static |
Return the string name for the command/response ID.
|
virtual |
Set/Get connection timeout threashold.
|
virtual |
Disconnect the logger with the given ID.
|
virtual |
|
virtual |
Get the connection info for the given ID.
|
virtual |
Get the set of connected loggers.
|
virtual |
Get the set of connected loggers that match the given ID that may contain wildcards.
| const DtRemoteLoggerMap& MAKLogger::DtRemoteControlInterface::getMyRemoteLoggerMap | ( | ) | const |
|
virtual |
Get the time of the logger with the highest current time.
|
virtual |
Set/Get our ID.
|
protectedvirtual |
Does the given target ID match the interface ID?
|
virtual |
Set/Get control to passively accept all responses.
|
protectedvirtual |
Implementation of callback.
|
staticprotected |
Static callback function.
|
virtual |
Get the time of the logger with the lowest current time.
|
protectedvirtual |
Get next sequence number.
|
virtual |
Return the number of connected loggers.
|
virtual |
Set/Get number of loggers expected to connect.
|
private |
Not Implemented.
|
virtual |
|
protectedvirtual |
|
protectedvirtual |
Process back channel connection.
|
protectedvirtual |
|
protectedvirtual |
Called periodically to process control pdus received.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Send a command message Return the message sequence number.
A sequence number value of 0 indicates a message was not sent (i.e., no exercise connection).
|
virtual |
Send a command message Return the message sequence number.
A sequence number value of 0 indicates a message was not sent (i.e., no exercise connection). The provided domain interface is called when command accepted/rejected.
|
virtual |
Send a logger control message Return the message sequence number.
A sequence number value of 0 indicates a message was not sent (i.e., no exercise connection).
|
virtual |
Send a logger control message Return the message sequence number.
A sequence number value of 0 indicates a message was not sent (i.e., no exercise connection). The provided domain interface is called when command accepted/rejected.
|
protectedvirtual |
Send a message.
|
virtual |
Set/Get control to accept any identifier.
|
virtual |
Set/Get acknowledge timeout threshold.
|
virtual |
Register callbacks with a newly created exconn.
|
virtual |
Use a back channel connection.
|
virtual |
Set/Get connection timeout threashold.
|
virtual |
Set/Get our ID.
|
virtual |
Set/Get number of loggers expected to connect.
|
virtual |
Set/Get control to passively accept all responses.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Called periodically to process control pdus to send and receive.
|
static |
The wildcard address.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
staticprotected |
|
staticprotected |