MAK RTIspy API Documentation for HLA 1516
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
connectMgr.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1998 MaK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************/
5 /*********************************************************************
6 ** $RCSfile: connectMgr.h,v $ $Revision: 1.78 $ $State: Exp $
7 *********************************************************************/
8 
9 #ifndef connectMgr_H_
10 #define connectMgr_H_
11 
14 
15 
16 #include "rtiMsConfig.h"
17 #include <vlutil/vlFedTarget.h>
18 #include <vlutil/vlMutex.h>
19 #include <vlutil/vlStringUtil.h>
20 #include <vlutil/vlLockfreeMpmcQueue.h>
21 #include "RIDparams.h"
22 #include "rtiMsgCbMgr.h"
23 #include "rtiMsgFact.h"
24 #include "fedWrapChain.h"
25 #include "dfltMsgFact.h"
26 #include "connection.h"
27 #include "metadata.h"
28 
29 class DtRetractInfoList;
30 class DtRtiMsg;
31 class DtRtiConnection;
32 class DtFedAmbWrapper;
33 class DtRtiMsgQueue;
34 class DtLogicalTimeFactory;
35 class DtMessageThrottle;
36 class DtFederateMgr;
37 class DtMulticastEntry;
38 class DtRtiAssistantLrcClient;
39 class DtPartnerMgr;
40 
41 #ifdef DtIFSPEC1516E
42 namespace rti1516e
43 {
44  class FederateAmbassador;
45 }
46 #endif
47 
48 
49 typedef MAKRti::DtLockfreeMpmcQueue<DtRtiMsg*> DtMessageQueueType;
50 
60 class DT_DLL_LRC DtConnectionMgr
61 {
62 public:
64  typedef DtConnectionMgr*
65  (*DtConnectionMgrCreator)(DtRIDParameters* p, bool isFederate,
66  DtBoost::shared_ptr<DtRtiAssistantLrcClient> assistantClient);
67 
68 protected:
69 
71  DtConnectionMgr(DtRIDParameters* params, bool isFederate = false,
72  DtBoost::shared_ptr<DtRtiAssistantLrcClient> assistantClient =
73  DtBoost::shared_ptr<DtRtiAssistantLrcClient>());
74 
75 public:
76 
78  virtual ~DtConnectionMgr();
79 
80 private:
81 
83  DtConnectionMgr(DtConnectionMgr const& );
84 
86  DtConnectionMgr& operator= (DtConnectionMgr const& );
87 
88 public:
89 
93  virtual int init(DtRIDParameters* params);
94 
97  virtual void initParams(DtRIDParameters* params);
98 
100  virtual void enableSmartForwarding(bool enableSmartForwarding, bool enableInternalMessageSmartForwarding, int maxNumFederates);
101 
103  virtual DtRIDParameters* params();
104 
106  virtual void setFederateMgr( DtFederateMgr* fedMgrPtr );
107 
109  virtual void shutdown();
110 
112  virtual bool isShuttingDown();
113 
114 #ifdef DtIFSPEC1516E
115 
116  virtual void setFederateAmbassador( rti1516e::FederateAmbassador* fedAmb );
117 #endif
118 
120 
123  virtual int send(const DtRtiMsg& msg,
124  MAKRti::DtTransportType transport,
125  const MAKRti::DtInetAddr& addr = MAKRti::DtInetAddr::inaddrAny());
126 
129  virtual int sendStamped(const DtRtiMsg& msg,
130  MAKRti::DtTransportType transport,
131  const MAKRti::DtInetAddr& = MAKRti::DtInetAddr::inaddrAny());
132 
135  virtual int sendStampedAnonymous(const DtRtiMsg& msg,
136  MAKRti::DtTransportType transport,
137  const MAKRti::DtInetAddr& addr = MAKRti::DtInetAddr::inaddrAny());
138 
141  virtual int sendAndDelete(DtRtiMsg* msg,
142  MAKRti::DtTransportType transport,
143  const MAKRti::DtInetAddr& addr = MAKRti::DtInetAddr::inaddrAny());
144 
147  virtual int sendDirectedAndDelete(DtRtiMsg* msg,
148  MAKRti::DtTransportType transport, DtFederateHandle fedHandle,
149  const MAKRti::DtInetAddr& addr = MAKRti::DtInetAddr::inaddrAny());
150 
153  virtual int sendStampedAndDelete(DtRtiMsg* msg,
154  MAKRti::DtTransportType transport,
155  const MAKRti::DtInetAddr& = MAKRti::DtInetAddr::inaddrAny());
156 
161  virtual int sendDirectedStampedAndDelete(DtRtiMsg* msg,
162  MAKRti::DtTransportType transport, DtFederateHandle fedHandle,
163  const MAKRti::DtInetAddr& = MAKRti::DtInetAddr::inaddrAny());
164  virtual int sendDirectedStampedAndDelete(DtRtiMsg* msg,
165  MAKRti::DtTransportType transport, DtBitMask *sendMask,
166  const MAKRti::DtInetAddr& = MAKRti::DtInetAddr::inaddrAny());
168 
172  virtual int sendStampedAnonymousAndDelete(DtRtiMsg* msg,
173  MAKRti::DtTransportType transport,
174  const MAKRti::DtInetAddr& addr = MAKRti::DtInetAddr::inaddrAny());
175  virtual int sendDirectedStampedAnonymousAndDelete(DtRtiMsg* msg,
176  MAKRti::DtTransportType transport, DtFederateHandle fedHandle,
177  const MAKRti::DtInetAddr& addr = MAKRti::DtInetAddr::inaddrAny());
179 
184  virtual void sendLoopback(DtRtiMsg* msg);
185 
188  virtual bool flush();
189 
192  virtual bool drainBacklog( MAKRti::DtTime timeout = 0.0 );
193 
197  virtual void activateTransmitDelay();
198 
200  virtual bool delayTransmit() const;
201 
208  virtual void testTransmitDelay();
209 
213  virtual void activateAutoProvideDelay();
214 
216  virtual bool delayAutoProvide() const;
217 
219  bool allProvideUpdateRequestsDelayed() const;
220 
223  virtual void testAutoProvideDelay();
224 
226  virtual void processThrottledMessages();
227 
229  virtual void flushThrottledMessages();
230 
233  virtual unsigned long incrementServiceCallCount();
234 
236  virtual unsigned long serviceCallCount() const;
237 
239 
240  virtual void setProcessingTick(bool processingTick);
241  virtual bool processingTick() const;
243 
245 
246  virtual void setEvokingCallbacks(bool evokingCbs);
247  virtual bool evokingCallbacks() const;
249 
251 
254  virtual bool tick();
255 
256  virtual bool processConnectionsInCallback();
257 
260  virtual bool processConnection( DtRtiConnection* conn,
261  MAKRti::DtTransportType trans);
262 
265  virtual bool processConnections();
266 
269  virtual DtRtiMsg* getMessage();
270 
272 
273 
274  virtual void addPendingMsg(DtRtiMsg* msg);
275  virtual bool processPendingMsg();
276  virtual DtRtiMsg* nextPendingMsg();
277  virtual void emptyPendingMsgList();
278  inline bool isPendingMsgQueueEmpty()
279  {
280  return myPendingMessages.empty();
281  }
283 
285  virtual void updateBufferSizes();
286 
289  virtual DtNetReadStatus handleMsg( DtRtiMsg& msg );
290 
292  virtual DtNetReadStatus processMsg(const DtRtiMsg& msg);
294  virtual DtNetReadStatus momProcessMsg(const DtRtiMsg& msg);
295 
298  DtFederateMgr* fedMgr();
299 
301  DtPartnerMgr* partnerMgr();
302 
306 #ifdef DtIFSPEC1516
307  virtual int readFileDescriptor(rti1516::TransportationType transport);
308 #elif defined(DtIFSPEC1516E)
309  virtual int readFileDescriptor(rti1516e::TransportationType transport);
310 #else
311  virtual int readFileDescriptor(RTI::TransportType transport);
312 #endif
313 
314 #if defined(_WIN32)
315 
316 
317 #ifdef DtIFSPEC1516
318  virtual WSAEVENT readFileEvent(rti1516::TransportationType transport);
319 #elif defined(DtIFSPEC1516E)
320  virtual WSAEVENT readFileEvent(rti1516e::TransportationType transport);
321 #else
322  virtual WSAEVENT readFileEvent(RTI::TransportType transport);
323 #endif
324 #endif
325 
327 
328 
329 
330  virtual void addMsgCallback(DtRtiMsgKind msgKind, DtRtiMsgCbMgr::DtCallbackFcn fcn,
331  void *usr, bool isMomCallback=false);
332  virtual void removeMsgCallback(DtRtiMsgKind msgKind, DtRtiMsgCbMgr::DtCallbackFcn fcn,
333  void *usr, bool isMomCallback=false);
334  virtual void addWildcardMsgCallback(DtRtiMsgCbMgr::DtCallbackFcn fcn,
335  void *usr, bool isMomCallback=false);
336  virtual void removeWildcardMsgCallback(DtRtiMsgCbMgr::DtCallbackFcn fcn,
337  void *usr, bool isMomCallback=false);
339 
345 
346 
349  virtual DtRtiConnection* reliableConn() const;
350 
352  virtual DtRtiConnection* bestEffortConn() const;
354 
355 
357  virtual MAKRti::DtTransportType internalTransportType() const;
358 
363  virtual bool setupSelectParams(DtSelectParam* params);
364 
366  virtual bool hasTransport(MAKRti::DtTransportType trans);
367 
374  virtual DtRtiMsg* create(DtRtiMsgKind kind);
375 
377  virtual void setMsgFactory(DtRtiMsgFactory* fact);
378  virtual DtRtiMsgFactory* msgFactory() const;
379 
381 
382 
383 
384  virtual void listenToMulticastGroup(const MAKRti::DtInetAddr& addr, const MAKRti::DtInetAddr& netInterface = MAKRti::DtInetAddr::inaddrAny());
385  virtual void dropMulticastGroup(const MAKRti::DtInetAddr& addr, const MAKRti::DtInetAddr& netInterface = MAKRti::DtInetAddr::inaddrAny());
387 
390  virtual void forceDropMulticastGroup(const MAKRti::DtInetAddr& addr, const MAKRti::DtInetAddr& netInterface = MAKRti::DtInetAddr::inaddrAny());
391 
395  virtual void connectFederation(
396 #ifdef DtIFSPEC1516
397  rti1516::FederateAmbassador* fedAmb,
398 #elif defined(DtIFSPEC13)
399  RTI::FederateAmbassador* fedAmb,
400 #endif
401  DtLogicalTimeFactory* logicalTimeFactoryPtr,
402  MAKRti::DtString fedExName,
403  DtFederateHandle federateHandle,
404  int fedExHandle);
405 
408  virtual bool repairFederationConnection();
409 
411  virtual void prepareToDisconnect();
412 
416  virtual void disconnectFederation();
417 
427 
428 
431  virtual bool lockServiceCall();
432 
435  virtual void unlockServiceCall();
436 
439  virtual bool serviceCallLocked();
440 
444  virtual bool enterServiceCall();
445 
448  virtual void exitServiceCall();
449 
452  virtual bool inServiceCall();
454 
456 #ifdef DtIFSPEC1516
457  virtual rti1516::FederateAmbassador* fedAmb() const;
458 #elif defined(DtIFSPEC1516E)
459  virtual rti1516e::FederateAmbassador* fedAmb() const;
460 #else
461  virtual RTI::FederateAmbassador* fedAmb() const;
462 #endif
463 
464 
472  virtual void addFedAmbWrapper(MAKRti::DtString const& name, DtFedAmbWrapper* fedAmb);
473 
478  virtual bool addFedAmbWrapperAtFront( MAKRti::DtString const& name, DtFedAmbWrapper* fedAmb );
479 
481  virtual DtFedAmbWrapper* removeFedAmbWrapper(MAKRti::DtString const& name);
482 
484  virtual unsigned long connectionId() const;
485 
487  virtual DtFederateHandle fedHandle() const;
488 
490  virtual unsigned long fedExHandle() const;
491 
493  virtual const MAKRti::DtString& fedExName() const;
494 
497  virtual void setFederateHandle(DtFederateHandle handle);
498 
501  virtual DtLogicalTimeFactory* logicalTimeFactory(
502  DtFederationHandle federationHandle=0) const;
503 
506  virtual void addLogicalTimeFactory(DtFederationHandle federationHandle,
507  DtLogicalTimeFactory* timeFactory);
508 
511  virtual void removeLogicalTimeFactory(DtFederationHandle federationHandle);
512 
514  virtual DtRtiMsgQueue* msgQueue();
515  virtual void setMsgQueue(DtRtiMsgQueue* msgQueuePtr);
516 
518  virtual DtRetractInfoList* retractList();
519  virtual void setRetractList(DtRetractInfoList* listPtr);
520 
523  virtual bool wait(MAKRti::DtTime periodInSeconds, bool unlockWhileWaiting = false);
524 
526  virtual void yield();
527 
531  virtual bool saveInProgress() const;
532  virtual void setSaveInProgress(bool saveIsInProgress);
533 
537  virtual bool restoreInProgress() const;
538  virtual void setRestoreInProgress(bool saveIsInProgress);
539 
541  virtual bool saveRestoreInProgress() const;
542 
544  virtual void setMetadataControl( DtMetadataType type, bool onOff );
545  virtual bool isMetadataEnabled( DtMetadataType type );
546 
548  virtual void sendShutdownForwarderMsg();
549 
551  virtual unsigned long sequenceNumber() const;
552 
554  virtual void incrementSequenceNumber();
555 
556 protected:
557 
558 
560  virtual bool doWait(MAKRti::DtTime period);
561 
565  virtual int initConnections();
566 
569  virtual bool createBestEffortConn();
570 
572  virtual void destroyBestEffortConn();
573 
575  virtual bool createRelConn();
576 
578  virtual void destroyRelConn();
579 
582  virtual unsigned int createAncillaryRelConns();
583 
585  virtual void destroyAncillaryRelConn(DtRtiConnection* conn);
586 
588  virtual void destroyAncillaryRelConns();
589 
591  virtual unsigned int ancillaryReliableConnsCount() const;
592 
595  virtual bool checkRelConn();
596 
598  virtual void processReadResult(int readError);
599 
602  virtual int sendStampedUtilityFunction( DtRtiMsg* msg,
603  MAKRti::DtTransportType transport,
604  bool performDelete,
605  bool isAnonymous,
606  const MAKRti::DtInetAddr& addr );
607 
608 public:
609 
614  static DtConnectionMgr* create(DtRIDParameters* p, bool isFederate = false,
615  DtBoost::shared_ptr<DtRtiAssistantLrcClient> assistantClient =
616  DtBoost::shared_ptr<DtRtiAssistantLrcClient>());
617 
620  static void setCreatorFunction(DtConnectionMgrCreator fn);
621 
626  static void setInternalCreatorFunction(DtConnectionMgrCreator fn);
627 
628 protected:
629 
631  DtRtiMsgFactory* myMsgFactory;
632 
634  DtRtiConnection* myBestEffortConn;
635 
637  DtRtiConnection* myPrimaryReliableConn;
638 
640  typedef std::list< DtRtiConnection* > DtRtiConnectionList;
641  DtRtiConnectionList myReliableConns;
642 
644  DtRIDParameters* myParams;
645 
647  DtFederateMgr* myFedMgr;
648 
650  std::map<MAKRti::DtInetAddr, DtMulticastEntry*> myMulticastGroups;
651 
653  DtFedAmbWrapperChain myFedAmbChain;
654 
656  DtDfltMsgFactory myDfltMsgFactory;
657 
659  DtRtiMsgCbMgr myMsgCbMgr;
660 
662  DtRtiMsgCbMgr myMomMsgCbMgr;
663 
665  MAKRti::DtTransportType myInternalTransportType;
666 
668  bool myAddTransportTypeMetadata;
669  bool myAddMcastMetadata;
670 
672  std::map<DtFederationHandle, DtLogicalTimeFactory*> myLogicalTimeFactories;
673 
675  DtRtiMsgQueue* myMsgQueue;
676 
678  DtRetractInfoList* myRetractList;
679 
681  DtMessageQueueType myPendingMessages;
682 
684  bool mySaveInProgress;
685 
687  bool myRestoreInProgress;
688 
690  bool myDisconnectPending;
691 
694  unsigned long myConnectionId;
695 
697  MAKRti::DtString myFedExName;
698 
700  DtFederateHandle myFedExHandle;
701 
703  DtFederateHandle myFederateHandle;
704 
706  unsigned long myReceivedMsgCount;
707 
709  unsigned long mySentMsgCount;
710 
712  MAKRti::DtList myWorkingMsgId;
713 
715  DtMessageThrottle* myMessageThrottle;
716 
718  bool myAllProvideUpdateRequestsDelayed;
719 
721  DtMutex* myCallbackMutex;
722 
724  unsigned int myLockService;
725 
727  unsigned int myInService;
728 
730  MAKRti::DtClock myClock;
731 
733  DtBoost::shared_ptr<DtRtiAssistantLrcClient> myAssistantClient;
734 
736  bool myIsFederate;
737 
738 #if defined(_WIN32)
739 
740  WSAEVENT myBestEffortEvent;
741 
743  WSAEVENT myReliableEvent;
744 #endif
745 
747  unsigned long myVersionConflictCount;
748  MAKRti::DtTime myVersionConflictNoticationTimer;
749 
751  unsigned long mySizeMismatchCount;
752  MAKRti::DtTime mySizeMismatchNoticationTimer;
753 
754  DtPartnerMgr* myPartnerMgr;
755 
757  unsigned long myServiceCallCount;
758 
760  bool myProcessingTick;
761 
763  bool myEvokingCallbacks;
764 
766  bool myProcessingMessage;
767 
769  bool myShutdown;
770 
772  bool mySendShuttingDown;
774  bool myReceiveShuttingDown;
775 
776 protected:
778  static DtConnectionMgrCreator theCreator;
779 
781  static DtConnectionMgrCreator theInternalCreator;
782  unsigned long myTickCount;
783 };
784 
785 
788 class DtMulticastEntry
789 {
790 public:
791  DtMulticastEntry() :
792  addr(MAKRti::DtInetAddr::inaddrAny()),
793  netInterface(MAKRti::DtInetAddr::inaddrAny()),
794  count(0)
795  {};
796  DtMulticastEntry(
797  MAKRti::DtInetAddr addrVal,
798  MAKRti::DtInetAddr netInterfaceVal,
799  int countVal=0) :
800  addr(addrVal),
801  netInterface(netInterfaceVal),
802  count(countVal)
803  {};
804 
806  MAKRti::DtInetAddr addr;
807 
809  MAKRti::DtInetAddr netInterface;
810 
812  int count;
813 };
814 
815 #endif
816 
Document ID: Generated on Fri Sep 27 00:57:56 EDT 2019 from SVN revision 201708
Copyright © 2005-2018 VT MÄK Inc. All Rights Reserved (www.mak.com)