MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
assistantConnQueryMsg.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (c) 2016 VT MAK
3  * All rights reserved.
4  ****************************************************************************/
5 
9 
10 #pragma once
11 
12 #include "assistantMsg.h"
14 
19 
20 typedef void (*DtAssistantConnQueryCb)( const DtAssistantConnQueryMsg& inter, void* usr );
21 
22 
28 {
29 public:
30 
32  DtAssistantConnQueryMsg( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );
33 
36  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );
37 
39  virtual ~DtAssistantConnQueryMsg();
40 
42  virtual DtAssistantMsg* clone( bool copy = true ) const;
43 
45  virtual MAKRti::DtInetAddr tcpAddress() const;
46 
48  virtual int tcpPort() const;
49 
51  virtual MAKRti::DtInetAddr tcpInterfaceAddress() const;
52 
54  virtual MAKRti::DtInetAddr udpAddress() const;
55 
57  virtual int udpPort() const;
58 
60  virtual MAKRti::DtInetAddr udpInterfaceAddress() const;
61 
64  virtual MAKRti::DtInetAddr additionalForwarderConnectionAddr() const;
65 
68  virtual int forwarderPort() const;
69 
71  virtual const char* connectionName() const;
72 
74  virtual bool ridIsPreconfigured() const;
75 
77  virtual const char* ridConfiguration() const;
78 
80  virtual MAKRti::DtInetUtils::DtInetAddrFamily addressFamily() const;
81 
83  virtual bool useRtiexec() const;
84 
86  virtual void setIsAssistantToAssistant( bool yesNo );
87 
89  virtual bool isAssistantToAssistant() const;
90 
92  virtual bool forceFullCompliance() const;
93 
95  virtual bool isAccepted() const;
96 
98  virtual bool isError() const;
99 
101  virtual void printData() const;
102 
103  virtual void setLRCParameters(
104  const DtString& connectionName, bool isRidPreconfigured, const DtString& ridConfig,
105  const DtInetAddr& tcpAddr, int tcpPort, const DtInetAddr& tcpIntfAddr,
106  const DtInetAddr& udpAddr, int udpPort, const DtInetAddr& udpIntfAddr,
107  int forwarderPort, bool useRtiExec, bool isForceFullCompliance, bool isAccepted );
108 
109  virtual void setForwardingParameters(
110  const DtString& connectionName, bool isRidPreconfigured, const DtString& ridConfig,
111  const DtInetAddr& tcpAddr, int tcpPort, const DtInetAddr& tcpIntfAddr,
112  const DtInetAddr& udpAddr, int udpPort, const DtInetAddr& udpIntfAddr,
113  const DtInetAddr& additionalForwarder, int forwarderPort,
114  bool isFullyCompliant, bool isAccepted );
115 
117  virtual void setConnectionName( const MAKRti::DtString& name, bool adjustBufferSize = true );
118 
120  virtual void setRidIsPreconfigured( bool val );
121 
123  virtual void setRidConfiguration( const MAKRti::DtString& ridConfig, bool adjustBufferSize = true);
124 
126  virtual void setError( bool val );
127 
128 protected:
129 
131  virtual void setTcpAddress( const MAKRti::DtInetAddr& ipAddress );
132 
134  virtual void setTcpPort( int port );
135 
137  virtual void setTcpInterfaceAddress( const MAKRti::DtInetAddr& address );
138 
140  virtual void setUdpAddress( const MAKRti::DtInetAddr& ipAddress );
141 
143  virtual void setUdpPort( int port );
144 
146  virtual void setUdpInterfaceAddress( const MAKRti::DtInetAddr& address );
147 
150  virtual void setAdditionalForwarderConnectionAddr( const MAKRti::DtInetAddr& addr, bool adjustBufferSize = true);
151 
154  virtual void setForwarderPort( int port );
155 
157  virtual void setAddressFamily( MAKRti::DtInetUtils::DtInetAddrFamily addrFamily );
158 
160  virtual void setUseRtiexec( bool val );
161 
163  virtual void setForceFullCompliance( bool val );
164 
166  virtual void setAccepted( bool val );
167 
168 public:
169 
171  static DtAssistantMsg* create( const DtNetAssistantMsgHeader* initial,
172  DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );
173 
175  static DtAssistantMsg* create( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );
176 
178  static void addCallback( DtRtiAssistantServer* conn, DtAssistantConnQueryCb cb, void* usr );
179  static void removeCallback( DtRtiAssistantServer* conn, DtAssistantConnQueryCb cb, void* usr );
180  static void addCallback( DtAssistantMsgQueue* queue, DtAssistantConnQueryCb cb, void* usr );
181  static void removeCallback( DtAssistantMsgQueue* queue, DtAssistantConnQueryCb cb, void* usr );
182 
183 protected:
184 
186  virtual DtNetAssistantConnQueryMsg* netAssistantConnQueryMsg();
187 
189  virtual const DtNetAssistantConnQueryMsg* netAssistantConnQueryMsg() const;
190 
193 
195  virtual int minSize() const;
196 
198  virtual int minSize(DtString const& connectionName, DtString const& ridConfig,
199  DtInetAddr const* additionalForwarder=nullptr) const;
200 
203  virtual void setAdditionalForwarderSize( unsigned long size );
204 
206  virtual unsigned long additionalForwarderSize() const;
207 
209  virtual const char* additionalForwarderPtr() const;
210 
212  virtual char* additionalForwarderPtr();
213 
216  virtual void setConnectionNameSize( unsigned long size );
217 
219  virtual unsigned long connectionNameSize() const;
220 
222  virtual const char* connectionNamePtr() const;
223 
225  virtual char* connectionNamePtr();
226 
229  virtual void setRidConfigurationSize( unsigned long size );
230 
232  virtual unsigned long ridConfigurationSize() const;
233 
235  virtual const char* ridConfigurationPtr() const;
236 
238  virtual char* ridConfigurationPtr();
239 
240 };
Definition: netAssistantConnQueryMsg.h:16
Definition: netAssistantMsgHdr.h:26
This file contains the declaration of DtRtiConnectionInfo.
void(* DtAssistantConnQueryCb)(const DtAssistantConnQueryMsg &inter, void *usr)
Definition: assistantConnQueryMsg.h:20
The DtAssistantConnQueryMsg defines a wrapper for the messages sent to and from the Assistant to quer...
Definition: assistantConnQueryMsg.h:27
DtAssistantMsgKind
Definition: assistantMsg.h:53
Base class for assistant Messages.
Definition: assistantMsg.h:153
virtual DtAssistantMsgKind internalMsgKind()=0
#define DT_DLL_ASSISTANT
Default – Unix or Win32 static.
Definition: rtiMsConfig.h:150
Manages the server connections of the RTI Assistant.
Definition: rtiAssistantServer.h:45
virtual DtAssistantMsg * clone(bool copy=true) const =0
Return a copy/empty object of the same type as this.
virtual void printData() const
Maintains a queue of RTI Assistant messages.
Definition: assistantMsgQueue.h:27

Document ID: Generated on Sun Jul 20 16:15:30 EDT 2025 from SVN revision 277985
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)