MAK Data Logger API Documentation for HLA
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
remoteControlInterface.h
Go to the documentation of this file.
1 /******************************************************************************
2 ** Copyright (c) 1992-2010 VT MAK
3 ** All rights reserved.
4 ******************************************************************************/
5 
9 
10 
11 #pragma once
12 
13 #include "lgrRemoteControlInterface.h"
14 
15 #include <lcRemoteLoggerConnection.h>
16 
17 #include <vlutil/vlString.h>
18 #include <vlpi/entityIdentifier.h>
19 #include <vlutil/vlInetSocket.h>
20 
21 #include <list>
22 #include <map>
23 #include <set>
24 
25 class DtExerciseConn;
26 class DtInteraction;
27 class DtLgrControlPdu;
28 class DtEntityIdentifier;
29 class DtLgrAcknowledgePdu;
30 class DtLgrConnectPdu;
31 class DtLgrDisconnectPdu;
32 class DtLgrLgrHeartbeatPdu;
33 class DtLgrResponsePdu;
34 class DtLgrTotalStatePdu;
35 class DtInetSocket;
36 
37 namespace MAKLogger
38 {
39  class DtAbsoluteTime;
40  class DtRelativeTime;
41  class DtCommand;
42  class DtRemoteControlDomainInterface;
43  class DtRemoteControlSystemInterface;
44  class DtRemoteControlPlaybackInterface;
45  class DtRemoteControlRecordInterface;
46  class DtRemoteControlEditorInterface;
47  class DtRemoteControlSimulationInterface;
48  class DtRemoteControlSharedInterface;
49 
50  typedef DtU32 DtSequenceNumber;
51  typedef std::set<DtSequenceNumber> DtSequenceNumberSet;
52  typedef std::set<DtEntityIdentifier> DtEntityIdSet;
53 
54  typedef void (*DtLgrConnectCb)( DtLgrConnectPdu* connect, void* usr );
55  typedef void (*DtLgrDisconnectCb)( DtLgrDisconnectPdu* connect, void* usr );
56  typedef void (*DtLgrLgrHeartbeatCb)( DtLgrLgrHeartbeatPdu* connect, void* usr );
57  typedef void (*DtLgrAcknowledgeCb)( DtLgrAcknowledgePdu* connect, void* usr );
58  typedef void (*DtLgrResponseCb)( DtLgrResponsePdu* connect, void* usr );
59  typedef void (*DtLgrTotalStateCb)( DtLgrTotalStatePdu* connect, void* usr );
60  typedef void (*DtLgrConnectionAddedCb)( const DtRemoteLoggerConnection& loggerConnection, void* usr );
61  typedef void (*DtLgrConnectionRemovedCb)( const DtRemoteLoggerConnection& loggerConnection, void* usr );
62  typedef void (*DtLgrConnectionTimedOutCb)( const DtRemoteLoggerConnection& loggerConnection, void* usr );
63 
64  typedef void (*DtLgrCommandAcceptedCb)( DtSequenceNumber sequenceNumber, void* usr );
65  typedef void (*DtLgrCommandRejectedCb)(const DtEntityIdentifier& source, DtSequenceNumber sequenceNumber, void* usr );
66  typedef void (*DtLgrCommandTimedOutCb)( DtSequenceNumber sequenceNumber, void* usr );
67 
68 
73  class DT_DLL_LGR_RCI DtRemoteControlInterface
74  {
75  public:
79  DtRemoteControlInterface(int numberOfLoggersToManage=0);
80 
82  virtual ~DtRemoteControlInterface();
83 
84  private:
86  DtRemoteControlInterface(const DtRemoteControlInterface&);
88  DtRemoteControlInterface& operator=(const DtRemoteControlInterface&);
89 
90  public:
91 
93  virtual void setConnection(DtExerciseConn* exconn, const DtEntityIdentifier& entityId);
94 
96  virtual void setConnection(const DtEntityIdentifier& id, DtInetSocket* socket);
97 
100  virtual void clearConnection();
101 
103  virtual void disconnect(const DtEntityIdentifier& entityId);
104 
106  virtual void tick();
107 
109 
110  virtual void setId( const DtEntityIdentifier& id );
111  virtual const DtEntityIdentifier& id() const;
113 
115 
116  virtual void setAcceptAnyId( bool acceptAny);
117  virtual bool acceptAnyId() const;
119 
121 
122  virtual DtTime connectionTimeout() const;
123  virtual void setConnectionTimeout(DtTime val);
125 
127 
128  virtual DtTime acknowledgeTimeout() const;
129  virtual void setAcknowledgeTimeout(DtTime val);
131 
133 
134  virtual void setNumberOfLoggers(int numberOfLoggersToManage);
135  virtual int numberOfLoggers() const;
137 
139 
140  virtual void setPassivelyAccepting(bool enablePassivelyAccept);
141  virtual bool isPassivelyAccepting() const;
143 
145  virtual void getConnectionIds(DtEntityIdSet& connectedLoggers) const;
146 
148  virtual void getConnectionIds(DtEntityIdSet& connectedLoggers,
149  const DtEntityIdentifier& idFilter) const;
150 
152  virtual int numberConnections() const;
153 
155  virtual DtRemoteLoggerConnection* getConnection(const DtEntityIdentifier& id);
156 
158  virtual DtTime lowestTime() const;
159 
161  virtual DtTime highestTime() const;
162 
164 
165  virtual DtRemoteControlSystemInterface* systemInterface();
166  virtual DtRemoteControlPlaybackInterface* playbackInterface();
167  virtual DtRemoteControlRecordInterface* recordInterface();
168  virtual DtRemoteControlEditorInterface* editorInterface();
169  virtual DtRemoteControlSimulationInterface* simulationInterface();
170  virtual DtRemoteControlSharedInterface* sharedInterface();
172 
177  virtual DtSequenceNumber sendCommandMessage(const DtCommand& command,
178  const DtEntityIdentifier& target=theWildcardAddress);
179 
185  virtual DtSequenceNumber sendCommandMessage(const DtCommand& command,
186  DtRemoteControlDomainInterface* domainInterface,
187  const DtEntityIdentifier& target=theWildcardAddress);
188 
193  virtual DtSequenceNumber sendLoggerControlMessage(DtLgrControlPdu& lgrControl,
194  const DtEntityIdentifier& target=theWildcardAddress);
195 
201  virtual DtSequenceNumber sendLoggerControlMessage(DtLgrControlPdu& lgrControl,
202  DtRemoteControlDomainInterface* domainInterface,
203  const DtEntityIdentifier& target=theWildcardAddress);
204 
206 
207  virtual void addCallback( DtLgrConnectCb cb, void* user );
208  virtual void removeCallback( DtLgrConnectCb );
209 
210  virtual void addCallback( DtLgrDisconnectCb cb, void* user );
211  virtual void removeCallback( DtLgrDisconnectCb );
212 
213  virtual void addCallback( DtLgrLgrHeartbeatCb cb, void* user );
214  virtual void removeCallback( DtLgrLgrHeartbeatCb );
215 
216  virtual void addCallback( DtLgrAcknowledgeCb cb, void* user );
217  virtual void removeCallback( DtLgrAcknowledgeCb );
218 
219  virtual void addCallback( DtLgrResponseCb cb, void* user );
220  virtual void removeCallback( DtLgrResponseCb );
221 
222  virtual void addCallback( DtLgrTotalStateCb cb, void* user );
223  virtual void removeCallback( DtLgrTotalStateCb );
224 
225  virtual void addCallbackConnectionAdded( DtLgrConnectionAddedCb cb, void* user );
226  virtual void removeCallbackConnectionAdded( DtLgrConnectionAddedCb );
227 
228  virtual void addCallbackConnectionRemoved( DtLgrConnectionRemovedCb cb, void* user );
229  virtual void removeCallbackConnectionRemoved( DtLgrConnectionRemovedCb );
230 
231  virtual void addCallbackConnectionTimedOut( DtLgrConnectionTimedOutCb cb, void* user );
232  virtual void removeCallbackConnectionTimedOut( DtLgrConnectionTimedOutCb );
233 
234  virtual void addCallbackCommandAccepted( DtLgrCommandAcceptedCb cb, void* user );
235  virtual void removeCallbackCommandAccepted( DtLgrCommandAcceptedCb );
236 
237  virtual void addCallbackCommandRejected( DtLgrCommandRejectedCb cb, void* user );
238  virtual void removeCallbackCommandRejected( DtLgrCommandRejectedCb );
239 
240  virtual void addCallbackCommandTimedOut( DtLgrCommandTimedOutCb cb, void* user );
241  virtual void removeCallbackCommandTimedOut( DtLgrCommandTimedOutCb );
242 
244 
245  public:
246 
248  static const DtEntityIdentifier& wildcardAddress();
249 
251  static const char* commandToString(int domain, int command);
252 
253  const DtRemoteLoggerMap& getMyRemoteLoggerMap() const;
254 
255  protected:
256 
258  virtual void lgrCtrlCallback( DtInteraction* );
259 
261  virtual void processControlPdus();
262 
264  virtual void processBackChannel();
265 
267  virtual void checkConnections();
268 
270  virtual bool isIdMatching(const DtEntityIdentifier& targetId, bool allowWildCard=true);
271 
273  virtual DtSequenceNumber nextSequenceNumber();
274 
276 
277  virtual void processTotalState(DtLgrTotalStatePdu* totalStatePdu);
278  virtual void processConnect(DtLgrConnectPdu* connectPdu);
279  virtual void processDisconnect(DtLgrDisconnectPdu* disconnectPdu);
280  virtual void processLgrHeartbeat(DtLgrLgrHeartbeatPdu* lgrHeartbeatPdu);
281  virtual void processAcknowledge(DtLgrAcknowledgePdu* acknowledgePdu);
282  virtual void processResponse(DtLgrResponsePdu* responsePdu);
284 
286  virtual void commandAccepted(DtSequenceNumber sequenceNumber);
287 
289  virtual void commandRejected(const DtEntityIdentifier& source, DtSequenceNumber sequenceNumber);
290 
292  virtual void commandTimedOut(DtSequenceNumber sequenceNumber);
293 
295  virtual void sendMessage(const DtLgrControlPdu& message);
296 
297  protected:
298 
300  static void lgrCtrlCb( DtInteraction*, void* );
301 
302  protected:
303 
305  typedef struct DtPendingAcknowledge
306  {
307  DtTime timeout;
308  DtEntityIdSet pending;
309  } DtPendingAcknowledge;
310 
311  typedef std::map<DtSequenceNumber, DtPendingAcknowledge> DtPendingAcknowledgeList;
312  typedef std::map<DtSequenceNumber, DtTime> DtRejectCommandList;
313  typedef std::map<DtSequenceNumber, DtRemoteControlDomainInterface*> DtAcknowledgeDomainMap;
314 
315  typedef std::list<DtLgrControlPdu*> DtPduList;
316 
317  protected:
318 
319 
320  DtExerciseConn* myExerciseCon;
321  DtInetSocket* myBackChannelConnection;
322  DtInetBuffer myBackChannelBuffer;
323  DtEntityIdentifier myId;
324  DtSequenceNumber mySequenceNumber;
325  DtPduList myPduList;
326  DtRemoteLoggerMap myRemoteLoggers;
327  DtEntityIdSet myRemoteLoggerIds;
328  DtEntityIdSet myRejectedLoggerIds;
329  bool myAcceptAnyId;
330  DtTime myConnectionTimeout;
331  DtTime myNextTimeoutCheck;
332  DtPendingAcknowledgeList myPendingAcknowledgements;
333  DtRejectCommandList myRejectedCommands;
334  DtTime MyAcknowledgeTimeout;
335  int myNumberOfLoggers;
336  DtAcknowledgeDomainMap myAcknowledgeInterface;
337  DtClock myClock;
338  bool myPassivelyAccepting;
339 
340  std::map<DtLgrConnectCb, void*> myConnectCallbacks;
341  std::map<DtLgrDisconnectCb, void*> myDisconnectCallbacks;
342  std::map<DtLgrAcknowledgeCb, void*> myAcknowledgeCallbacks;
343  std::map<DtLgrResponseCb, void*> myResponseCallbacks;
344  std::map<DtLgrTotalStateCb, void*> myTotalStateCallbacks;
345  std::map<DtLgrLgrHeartbeatCb, void*> myHeartbeatCallbacks;
346  std::map<DtLgrConnectionAddedCb, void*> myConnectionAddedCallbacks;
347  std::map<DtLgrConnectionRemovedCb, void*> myConnectionRemovedCallbacks;
348  std::map<DtLgrConnectionTimedOutCb, void*> myConnectionTimedOutCallbacks;
349  std::map<DtLgrCommandAcceptedCb, void*> myCommandAcceptedCallbacks;
350  std::map<DtLgrCommandRejectedCb, void*> myCommandRejectedCallbacks;
351  std::map<DtLgrCommandTimedOutCb, void*> myCommandTimedOutCallbacks;
352 
353  DtRemoteControlSystemInterface* mySystemInterface;
354  DtRemoteControlPlaybackInterface* myPlaybackInterface;
355  DtRemoteControlRecordInterface* myRecordInterface;
356  DtRemoteControlEditorInterface* myEditorInterface;
357  DtRemoteControlSimulationInterface* mySimulationInterface;
358  DtRemoteControlSharedInterface* mySharedInterface;
359 
360  protected:
361  static const DtU16 theAddressWildcard = ((1<<16)-1); // 65535 or 0xFFFF
362  static const DtEntityIdentifier theWildcardAddress;
363 
364  };
365 }
Document ID: Generated on Thu Jul 23 15:05:27 EDT 2020 from SVN revision 215371
Copyright © 2020 MAK Technologies. All Rights Reserved (www.mak.com)