10 - Configuring the Remote Control Interface

The remote control interface is configured through several methods provide by the core remote control interface class.

The number of Loggers can be specified by the constructor.

You can configure the number of Loggers in the constructor, as follows:

DtRemoteControlInterface(int numberOfLoggersToManage=0)

The following methods provide further configuration:

• setConnection(). This method provides the interface with an exercise connection and specifies the remote control identifier. This method must be called after the remote control interface is instantiated and before any Logger commands are invoked.

  void DtRemoteControlInterface::setConnection(DtExerciseConn* exconn, const DtEntityIdentifier& id)

• setID(). Change the remote control identifier to the given value.

  void DtRemoteControlInterface::setId( const DtEntityIdentifier& id )

• setAcceptAnyId(). By default, the remote control interface will only accept messages whose receiver ID matches its ID. Setting this parameter to true will allow the remote control interface to accept any Logger control message.

  void DtRemoteControlInterface::setAcceptAnyId( bool acceptAny)

• setConnectionTimeout(). Set the interval used to determine that a connected Logger is no longer alive. The remote control interface will remove a Logger connection if it has not received a heartbeat message from the Logger for a time greater than the given interval.

  void DtRemoteControlInterface::setConnectionTimeout(DtTime val)

• setNumberOfLoggers(). Change the number of Loggers that are expected to connect.

  void DtRemoteControlInterface::setNumberOfLoggers(int numberOfLoggersToManage )

• addCallback() and removeCallback(). Add or remove a callback for when a given message type is received for processing (*** represents the message type, for example, LgrConnect, LgrHeartbeat, and so on).

  void DtRemoteControlInterface::addCallback( DtLgr***Cb cb, void* user )
  void DtRemoteControlInterface::removeCallback( DtLgr***Cb cb)

• addCallbackConnectionAdded(), addCallbackConnectionRemoved(), addCallbackConnectionTimedOut(), and removeCallbackConnectionAdded(), removeCallbackConnectionRemoved(), removeCallbackConnectionTimedOut(). Add or remove a callback for when a Logger connection is added, removed, or timed out. The callbacks for adding and removing a connection are somewhat redundant to the callbacks for the DtLgrConnectPdu and DtLgrDisconnectPdu. However, the callback for connection added is called only when the connection is added. It may happen that the remote control interface receives multiple DtLgrConnectPdus from a single Logger. Since the connect message does not contain the Logger total state information, the connection info is initialized with default values. The callback is called after the connection is added to the list. The connection removed callback is included for symmetry and a convenience. It is called before the connection is removed from the list.

  void DtRemoteControlInterface::addCallbackConnectionAdded(DtLgrConnectionAddedCb cb, void* user )
  void DtRemoteControlInterface::
  removeCallbackConnectionAdded(DtLgrConnectionAddedCb cb)

  Note

  You would use the same syntax for addCallbackConnectionRemoved(), addCallbackConnectionTimedOut(), removeCallbackConnectionRemoved(), and removeCallbackConnectionTimedOut().

[<< Configuring the Logger to use the Remote Control API] [Home] [Top of Page] [The C# Remote Control API >>]