diff --git a/Resources/XPMP2.example.prf b/Resources/XPMP2.example.prf index b342328..4dfebee 100644 --- a/Resources/XPMP2.example.prf +++ b/Resources/XPMP2.example.prf @@ -89,6 +89,15 @@ remoteMCGroup 239.255.1.1 # Port used for communication between XPMP2 masters and the Remote Client. remotePort 49788 +# Interface to _send_ multicast on. +# Auto-discovery is used if option is not defined (commented out). +# Define an interface by numeric interface index or its interface name. +# If the defined interface name cannot be resolved you'll find a list +# of available interface names output to Log.txt after the respective ERROR line. +# Examples: +# remoteSendIntf Ethernet +# remoteSendIntf en0 + # TTL (Time-to-live) for multicast packets, ie. max number of hops they across routers they take remoteTTL 8 diff --git a/docs/html/Network_8cpp.html b/docs/html/Network_8cpp.html index cc5043a..ec41531 100644 --- a/docs/html/Network_8cpp.html +++ b/docs/html/Network_8cpp.html @@ -84,6 +84,12 @@ std::string XPMP2::_NetwGetIntfName (uint32_t idx, uint8_t family)  Get an interface's name. More...
  +LocalIntfAddrTy XPMP2::_NetwFindLocalIntf (const std::string &intf, uint8_t family) + Find a matching local interface based on name and family. More...
+  +std::string XPMP2::_NetwGetInterfaceNames (uint8_t family) + Return list of interface names of given family. More...
+  void XPMP2::_NetwGetLocalAddresses (bool bForceRefresh=false)  Fetch all local addresses and cache locally. More...
  diff --git a/docs/html/Network_8h_source.html b/docs/html/Network_8h_source.html index 36bd968..09f3637 100644 --- a/docs/html/Network_8h_source.html +++ b/docs/html/Network_8h_source.html @@ -81,7 +81,7 @@
58  sockaddr_in6 sa_in6; // AF_INET6 / IPv6
59  };
60 
-
62  SockAddrTy() { memset(this, 0, sizeof(SockAddrTy)); }
+
62  SockAddrTy() { memset((void*)this, 0, sizeof(SockAddrTy)); }
64  SockAddrTy (const sockaddr* pSa);
65 
67  bool operator< (const SockAddrTy& o) const
@@ -190,178 +190,180 @@
205 
206 public:
208  UDPMulticast() : SocketNetworking() {}
-
210  UDPMulticast(const std::string& _multicastAddr, int _port, int _ttl=8,
-
211  size_t _bufSize = 512, unsigned _timeOut_ms = 0);
-
213  virtual ~UDPMulticast();
-
214 
-
216  const std::string& GetMCAddr() const { return multicastAddr; }
-
217 
-
220  void Join (const std::string& _multicastAddr, int _port, int _ttl=8,
-
221  size_t _bufSize = 512, unsigned _timeOut_ms = 0);
-
222 
-
224  uint8_t GetFamily () const { return pMCAddr ? (uint8_t)pMCAddr->ai_family : AF_UNSPEC; }
-
225  bool IsIPv4 () const { return GetFamily() == AF_INET; }
-
226  bool IsIPv6 () const { return GetFamily() == AF_INET6; }
-
227 
-
229  void SendToDefault ();
-
231  void SendToAll ();
-
233  void SendToIntf (uint32_t idx);
-
234 
-
239  size_t SendMC (const void* _bufSend, size_t _bufSendSize);
-
240 
-
247  size_t RecvMC (bool bSwitchToRecvIntf,
-
248  std::string* _pFromAddr = nullptr,
-
249  SockAddrTy* _pFromSockAddr = nullptr,
-
250  bool* _pbIntfChanged = nullptr);
-
251 
-
252 protected:
-
253  void Cleanup ();
-
255  void GetAddrHints (struct addrinfo& hints) override;
-
257  void SetSendInterface (const in_addr& addr);
-
259  void SetSendInterface (uint32_t ifIdx);
-
260 };
-
261 
-
262 
-
264 class TCPConnection : public SocketNetworking
-
265 {
-
266 protected:
-
267  SOCKET f_session_socket = INVALID_SOCKET;
-
268  struct sockaddr_in f_session_addr = {};
-
269 #if APL == 1 || LIN == 1
-
271  SOCKET selfPipe[2] = { INVALID_SOCKET, INVALID_SOCKET };
-
272 #endif
-
273 
-
274 public:
-
276  TCPConnection() : SocketNetworking() {}
-
278  TCPConnection(const std::string& _addr, int _port, size_t _bufSize = 512,
-
279  unsigned _timeOut_ms = 0) :
-
280  SocketNetworking(_addr,_port,_bufSize,_timeOut_ms) {}
-
281 
-
282  virtual void Close();
-
283  void CloseListenerOnly();
-
284 
-
285  void listen (int numConnections = 1);
-
286  bool accept (bool bUnlisten = false);
-
287  bool listenAccept (int numConnections = 1);
-
288 
-
290  bool IsConnected () const { return f_session_socket != INVALID_SOCKET; };
-
291 
-
293  bool send(const char* msg);
-
294 
-
295 protected:
-
296  virtual void GetAddrHints (struct addrinfo& hints);
-
297 };
-
298 
-
299 
-
301 struct InetAddrTy {
-
302  union {
-
303  std::uint32_t addr[4] = {0,0,0,0};
-
304  struct in_addr in_addr;
-
305  struct in6_addr in6_addr;
-
306  };
-
307 
-
309  InetAddrTy () {}
-
311  InetAddrTy (const SockAddrTy& sa) { CopyFrom(sa); }
-
313  InetAddrTy (const sockaddr* pSa) { CopyFrom(SockAddrTy(pSa)); }
-
314 
-
316  void CopyFrom (const SockAddrTy& sa);
-
317 
-
319  bool operator==(const InetAddrTy& o) const
-
320  { return std::memcmp(this, &o, sizeof(*this)) == 0; }
-
321 
-
323  bool operator<(const InetAddrTy& o) const
-
324  { return std::memcmp(this, &o, sizeof(*this)) < 0; }
-
325 
-
326 };
+
210  UDPMulticast(const std::string& _multicastAddr, int _port,
+
211  const std::string& _sendIntf,
+
212  int _ttl=8, size_t _bufSize = 512, unsigned _timeOut_ms = 0);
+
214  virtual ~UDPMulticast();
+
215 
+
217  const std::string& GetMCAddr() const { return multicastAddr; }
+
218 
+
221  void Join (const std::string& _multicastAddr, int _port,
+
222  const std::string& _sendIntf,
+
223  int _ttl=8, size_t _bufSize = 512, unsigned _timeOut_ms = 0);
+
224 
+
226  uint8_t GetFamily () const { return pMCAddr ? (uint8_t)pMCAddr->ai_family : AF_UNSPEC; }
+
227  bool IsIPv4 () const { return GetFamily() == AF_INET; }
+
228  bool IsIPv6 () const { return GetFamily() == AF_INET6; }
+
229 
+
231  void SendToDefault ();
+
233  void SendToAll ();
+
235  void SendToIntf (uint32_t idx);
+
236 
+
241  size_t SendMC (const void* _bufSend, size_t _bufSendSize);
+
242 
+
249  size_t RecvMC (bool bSwitchToRecvIntf,
+
250  std::string* _pFromAddr = nullptr,
+
251  SockAddrTy* _pFromSockAddr = nullptr,
+
252  bool* _pbIntfChanged = nullptr);
+
253 
+
254 protected:
+
255  void Cleanup ();
+
257  void GetAddrHints (struct addrinfo& hints) override;
+
259  void SetSendInterface (const in_addr& addr);
+
261  void SetSendInterface (uint32_t ifIdx);
+
262 };
+
263 
+
264 
+
266 class TCPConnection : public SocketNetworking
+
267 {
+
268 protected:
+
269  SOCKET f_session_socket = INVALID_SOCKET;
+
270  struct sockaddr_in f_session_addr = {};
+
271 #if APL == 1 || LIN == 1
+
273  SOCKET selfPipe[2] = { INVALID_SOCKET, INVALID_SOCKET };
+
274 #endif
+
275 
+
276 public:
+
278  TCPConnection() : SocketNetworking() {}
+
280  TCPConnection(const std::string& _addr, int _port, size_t _bufSize = 512,
+
281  unsigned _timeOut_ms = 0) :
+
282  SocketNetworking(_addr,_port,_bufSize,_timeOut_ms) {}
+
283 
+
284  virtual void Close();
+
285  void CloseListenerOnly();
+
286 
+
287  void listen (int numConnections = 1);
+
288  bool accept (bool bUnlisten = false);
+
289  bool listenAccept (int numConnections = 1);
+
290 
+
292  bool IsConnected () const { return f_session_socket != INVALID_SOCKET; };
+
293 
+
295  bool send(const char* msg);
+
296 
+
297 protected:
+
298  virtual void GetAddrHints (struct addrinfo& hints);
+
299 };
+
300 
+
301 
+
303 struct InetAddrTy {
+
304  union {
+
305  std::uint32_t addr[4] = {0,0,0,0};
+
306  struct in_addr in_addr;
+
307  struct in6_addr in6_addr;
+
308  };
+
309 
+
311  InetAddrTy () {}
+
313  InetAddrTy (const SockAddrTy& sa) { CopyFrom(sa); }
+
315  InetAddrTy (const sockaddr* pSa) { CopyFrom(SockAddrTy(pSa)); }
+
316 
+
318  void CopyFrom (const SockAddrTy& sa);
+
319 
+
321  bool operator==(const InetAddrTy& o) const
+
322  { return std::memcmp(this, &o, sizeof(*this)) == 0; }
+
323 
+
325  bool operator<(const InetAddrTy& o) const
+
326  { return std::memcmp(this, &o, sizeof(*this)) < 0; }
327 
-
329 bool NetwIsLocalAddr (const InetAddrTy& addr);
-
331 inline bool NetwIsLocalAddr (const SockAddrTy& sa)
-
332 { return NetwIsLocalAddr(InetAddrTy(sa)); }
-
334 inline bool NetwIsLocalAddr (const sockaddr* pSa)
-
335 { return NetwIsLocalAddr(InetAddrTy(pSa)); }
-
336 
-
337 
-
338 } // namespace XPMP2
+
328 };
+
329 
+
331 bool NetwIsLocalAddr (const InetAddrTy& addr);
+
333 inline bool NetwIsLocalAddr (const SockAddrTy& sa)
+
334 { return NetwIsLocalAddr(InetAddrTy(sa)); }
+
336 inline bool NetwIsLocalAddr (const sockaddr* pSa)
+
337 { return NetwIsLocalAddr(InetAddrTy(pSa)); }
+
338 
339 
-
340 #endif /* Network_h */
+
340 } // namespace XPMP2
+
341 
+
342 #endif /* Network_h */
XPMP2::NetRuntimeError
Exception raised by XPMP2::SocketNetworking objects.
Definition: Network.h:87
XPMP2::NetRuntimeError::errTxt
std::string errTxt
OS text for what errno says, output of strerror_s()
Definition: Network.h:89
XPMP2::NetRuntimeError::fullWhat
std::string fullWhat
combines w and errTxt
Definition: Network.h:90
-
XPMP2::NetRuntimeError::NetRuntimeError
NetRuntimeError(const std::string &w)
Definition: Network.cpp:302
+
XPMP2::NetRuntimeError::NetRuntimeError
NetRuntimeError(const std::string &w)
Definition: Network.cpp:345
XPMP2::NetRuntimeError::what
const char * what() const noexcept override
Return the full message, ie. fullWhat
Definition: Network.h:93
XPMP2::SocketNetworking
Base class for any socket-based networking.
Definition: Network.h:99
-
XPMP2::SocketNetworking::~SocketNetworking
virtual ~SocketNetworking()
Destructor makes sure the socket is closed.
Definition: Network.cpp:324
+
XPMP2::SocketNetworking::~SocketNetworking
virtual ~SocketNetworking()
Destructor makes sure the socket is closed.
Definition: Network.cpp:367
XPMP2::SocketNetworking::getSocket
SOCKET getSocket() const
the socket
Definition: Network.h:138
XPMP2::SocketNetworking::isOpen
bool isOpen() const
Is a socket open?
Definition: Network.h:131
XPMP2::SocketNetworking::getBuf
const char * getBuf() const
return the buffer
Definition: Network.h:143
-
XPMP2::SocketNetworking::GetAddrString
static std::string GetAddrString(const SockAddrTy &sa, bool withPort=true)
Convert addresses to string.
Definition: Network.cpp:681
-
XPMP2::SocketNetworking::Close
virtual void Close()
Thread-safely close the connection(s) and frees the buffer.
Definition: Network.cpp:489
+
XPMP2::SocketNetworking::GetAddrString
static std::string GetAddrString(const SockAddrTy &sa, bool withPort=true)
Convert addresses to string.
Definition: Network.cpp:724
+
XPMP2::SocketNetworking::Close
virtual void Close()
Thread-safely close the connection(s) and frees the buffer.
Definition: Network.cpp:532
XPMP2::SocketNetworking::f_socket
SOCKET f_socket
Definition: Network.h:101
XPMP2::SocketNetworking::bufSize
size_t bufSize
Definition: Network.h:107
-
XPMP2::SocketNetworking::Open
virtual void Open(const std::string &_addr, int _port, size_t _bufSize=512, unsigned _timeOut_ms=0, bool _bBroadcast=false)
Creates a socket and binds it to the given local address.
Definition: Network.cpp:329
+
XPMP2::SocketNetworking::Open
virtual void Open(const std::string &_addr, int _port, size_t _bufSize=512, unsigned _timeOut_ms=0, bool _bBroadcast=false)
Creates a socket and binds it to the given local address.
Definition: Network.cpp:372
XPMP2::SocketNetworking::f_addr
std::string f_addr
Definition: Network.h:103
XPMP2::SocketNetworking::SocketNetworking
SocketNetworking()
Default constructor is not doing anything.
Definition: Network.h:115
XPMP2::SocketNetworking::f_port
int f_port
Definition: Network.h:102
-
XPMP2::SocketNetworking::Connect
virtual void Connect(const std::string &_addr, int _port, size_t _bufSize, unsigned _timeOut_ms=0)
Creates a socket and connects it to the given remote server.
Definition: Network.cpp:422
-
XPMP2::SocketNetworking::SetBufSize
void SetBufSize(size_t _bufSize)
(Re)Sets the buffer size (or clears it if _bufSize==0)
Definition: Network.cpp:503
-
XPMP2::SocketNetworking::recv
long recv()
Waits to receive a message, ensures zero-termination in the buffer.
Definition: Network.cpp:573
-
XPMP2::SocketNetworking::GetLastErr
static std::string GetLastErr()
Returns a human-readable text for the last error.
Definition: Network.cpp:521
-
XPMP2::SocketNetworking::setBlocking
void setBlocking(bool bBlock)
Set blocking mode.
Definition: Network.cpp:540
+
XPMP2::SocketNetworking::Connect
virtual void Connect(const std::string &_addr, int _port, size_t _bufSize, unsigned _timeOut_ms=0)
Creates a socket and connects it to the given remote server.
Definition: Network.cpp:465
+
XPMP2::SocketNetworking::SetBufSize
void SetBufSize(size_t _bufSize)
(Re)Sets the buffer size (or clears it if _bufSize==0)
Definition: Network.cpp:546
+
XPMP2::SocketNetworking::recv
long recv()
Waits to receive a message, ensures zero-termination in the buffer.
Definition: Network.cpp:616
+
XPMP2::SocketNetworking::GetLastErr
static std::string GetLastErr()
Returns a human-readable text for the last error.
Definition: Network.cpp:564
+
XPMP2::SocketNetworking::setBlocking
void setBlocking(bool bBlock)
Set blocking mode.
Definition: Network.cpp:583
XPMP2::SocketNetworking::GetAddrHints
virtual void GetAddrHints(struct addrinfo &hints)=0
Subclass to tell which addresses to look for.
XPMP2::SocketNetworking::buf
char * buf
Definition: Network.h:106
XPMP2::SocketNetworking::getAddr
std::string getAddr() const
the interface address
Definition: Network.h:140
-
XPMP2::SocketNetworking::broadcast
bool broadcast(const char *msg)
Sends a broadcast message.
Definition: Network.cpp:652
-
XPMP2::SocketNetworking::timedRecv
long timedRecv(int max_wait_ms)
Waits to receive a message with timeout, ensures zero-termination in the buffer.
Definition: Network.cpp:610
+
XPMP2::SocketNetworking::broadcast
bool broadcast(const char *msg)
Sends a broadcast message.
Definition: Network.cpp:695
+
XPMP2::SocketNetworking::timedRecv
long timedRecv(int max_wait_ms)
Waits to receive a message with timeout, ensures zero-termination in the buffer.
Definition: Network.cpp:653
XPMP2::SocketNetworking::getPort
int getPort() const
the port
Definition: Network.h:139
-
XPMP2::TCPConnection
Listens to TCP connections and opens a session socket upon connect.
Definition: Network.h:265
-
XPMP2::TCPConnection::IsConnected
bool IsConnected() const
Connected to a counterparty?
Definition: Network.h:290
-
XPMP2::TCPConnection::listen
void listen(int numConnections=1)
listen for incoming connections
Definition: Network.cpp:1187
-
XPMP2::TCPConnection::Close
virtual void Close()
also close session connection
Definition: Network.cpp:1157
-
XPMP2::TCPConnection::accept
bool accept(bool bUnlisten=false)
accept an incoming connections, optinally stop listening
Definition: Network.cpp:1193
-
XPMP2::TCPConnection::send
bool send(const char *msg)
send messages on session connection
Definition: Network.cpp:1265
-
XPMP2::TCPConnection::GetAddrHints
virtual void GetAddrHints(struct addrinfo &hints)
Subclass to tell which addresses to look for.
Definition: Network.cpp:1289
-
XPMP2::TCPConnection::CloseListenerOnly
void CloseListenerOnly()
only closes the listening socket, but not a connected session
Definition: Network.cpp:1170
-
XPMP2::TCPConnection::TCPConnection
TCPConnection(const std::string &_addr, int _port, size_t _bufSize=512, unsigned _timeOut_ms=0)
Constructor creates a socket and binds it to the given address.
Definition: Network.h:278
-
XPMP2::TCPConnection::f_session_socket
SOCKET f_session_socket
session socket, ie. the socket opened when a counterparty connects
Definition: Network.h:267
-
XPMP2::TCPConnection::TCPConnection
TCPConnection()
Default constructor is not doing anything.
Definition: Network.h:276
-
XPMP2::TCPConnection::f_session_addr
struct sockaddr_in f_session_addr
address of the connecting counterparty
Definition: Network.h:268
-
XPMP2::TCPConnection::listenAccept
bool listenAccept(int numConnections=1)
combines listening and accepting
Definition: Network.cpp:1212
+
XPMP2::TCPConnection
Listens to TCP connections and opens a session socket upon connect.
Definition: Network.h:267
+
XPMP2::TCPConnection::IsConnected
bool IsConnected() const
Connected to a counterparty?
Definition: Network.h:292
+
XPMP2::TCPConnection::listen
void listen(int numConnections=1)
listen for incoming connections
Definition: Network.cpp:1241
+
XPMP2::TCPConnection::Close
virtual void Close()
also close session connection
Definition: Network.cpp:1211
+
XPMP2::TCPConnection::accept
bool accept(bool bUnlisten=false)
accept an incoming connections, optinally stop listening
Definition: Network.cpp:1247
+
XPMP2::TCPConnection::send
bool send(const char *msg)
send messages on session connection
Definition: Network.cpp:1319
+
XPMP2::TCPConnection::GetAddrHints
virtual void GetAddrHints(struct addrinfo &hints)
Subclass to tell which addresses to look for.
Definition: Network.cpp:1343
+
XPMP2::TCPConnection::CloseListenerOnly
void CloseListenerOnly()
only closes the listening socket, but not a connected session
Definition: Network.cpp:1224
+
XPMP2::TCPConnection::TCPConnection
TCPConnection(const std::string &_addr, int _port, size_t _bufSize=512, unsigned _timeOut_ms=0)
Constructor creates a socket and binds it to the given address.
Definition: Network.h:280
+
XPMP2::TCPConnection::f_session_socket
SOCKET f_session_socket
session socket, ie. the socket opened when a counterparty connects
Definition: Network.h:269
+
XPMP2::TCPConnection::TCPConnection
TCPConnection()
Default constructor is not doing anything.
Definition: Network.h:278
+
XPMP2::TCPConnection::f_session_addr
struct sockaddr_in f_session_addr
address of the connecting counterparty
Definition: Network.h:270
+
XPMP2::TCPConnection::listenAccept
bool listenAccept(int numConnections=1)
combines listening and accepting
Definition: Network.cpp:1266
XPMP2::UDPMulticast
UDP Multicast, always binding to INADDR_ANY.
Definition: Network.h:195
-
XPMP2::UDPMulticast::GetMCAddr
const std::string & GetMCAddr() const
Return formatted multicast address, including port.
Definition: Network.h:216
-
XPMP2::UDPMulticast::SendToIntf
void SendToIntf(uint32_t idx)
Send future datagrams on this particular interface only.
Definition: Network.cpp:889
-
XPMP2::UDPMulticast::SendToAll
void SendToAll()
Send future datagrams on all interfaces.
Definition: Network.cpp:878
-
XPMP2::UDPMulticast::RecvMC
size_t RecvMC(bool bSwitchToRecvIntf, std::string *_pFromAddr=nullptr, SockAddrTy *_pFromSockAddr=nullptr, bool *_pbIntfChanged=nullptr)
Receive a multicast, received message is in XPMP2::SocketNetworking::GetBuf()
Definition: Network.cpp:966
-
XPMP2::UDPMulticast::SendToDefault
void SendToDefault()
Send future datagrams on default interfaces only (default)
Definition: Network.cpp:855
-
XPMP2::UDPMulticast::IsIPv6
bool IsIPv6() const
IPv6?
Definition: Network.h:226
-
XPMP2::UDPMulticast::SetSendInterface
void SetSendInterface(const in_addr &addr)
Set multicast send interface (IPv4 only)
Definition: Network.cpp:1120
+
XPMP2::UDPMulticast::GetMCAddr
const std::string & GetMCAddr() const
Return formatted multicast address, including port.
Definition: Network.h:217
+
XPMP2::UDPMulticast::Join
void Join(const std::string &_multicastAddr, int _port, const std::string &_sendIntf, int _ttl=8, size_t _bufSize=512, unsigned _timeOut_ms=0)
Connect to the multicast group.
Definition: Network.cpp:803
+
XPMP2::UDPMulticast::SendToIntf
void SendToIntf(uint32_t idx)
Send future datagrams on this particular interface only.
Definition: Network.cpp:943
+
XPMP2::UDPMulticast::SendToAll
void SendToAll()
Send future datagrams on all interfaces.
Definition: Network.cpp:932
+
XPMP2::UDPMulticast::RecvMC
size_t RecvMC(bool bSwitchToRecvIntf, std::string *_pFromAddr=nullptr, SockAddrTy *_pFromSockAddr=nullptr, bool *_pbIntfChanged=nullptr)
Receive a multicast, received message is in XPMP2::SocketNetworking::GetBuf()
Definition: Network.cpp:1020
+
XPMP2::UDPMulticast::SendToDefault
void SendToDefault()
Send future datagrams on default interfaces only (default)
Definition: Network.cpp:909
+
XPMP2::UDPMulticast::IsIPv6
bool IsIPv6() const
IPv6?
Definition: Network.h:228
+
XPMP2::UDPMulticast::SetSendInterface
void SetSendInterface(const in_addr &addr)
Set multicast send interface (IPv4 only)
Definition: Network.cpp:1174
XPMP2::UDPMulticast::oneIntfIdx
uint32_t oneIntfIdx
When sending to one interface only, which one?
Definition: Network.h:201
XPMP2::UDPMulticast::pMCAddr
struct addrinfo * pMCAddr
the multicast address
Definition: Network.h:198
-
XPMP2::UDPMulticast::SendMC
size_t SendMC(const void *_bufSend, size_t _bufSendSize)
Send a multicast.
Definition: Network.cpp:909
+
XPMP2::UDPMulticast::SendMC
size_t SendMC(const void *_bufSend, size_t _bufSendSize)
Send a multicast.
Definition: Network.cpp:963
XPMP2::UDPMulticast::mapSender
std::map< SockAddrTy, std::chrono::time_point< std::chrono::steady_clock > > mapSender
Keep a list of sources we received data from to be able to identify new sources.
Definition: Network.h:204
XPMP2::UDPMulticast::multicastAddr
std::string multicastAddr
the multicast address
Definition: Network.h:197
XPMP2::UDPMulticast::UDPMulticast
UDPMulticast()
Default constructor is not doing anything.
Definition: Network.h:208
-
XPMP2::UDPMulticast::GetFamily
uint8_t GetFamily() const
Protocol family.
Definition: Network.h:224
-
XPMP2::UDPMulticast::IsIPv4
bool IsIPv4() const
IPv4?
Definition: Network.h:225
-
XPMP2::UDPMulticast::GetAddrHints
void GetAddrHints(struct addrinfo &hints) override
returns information from *pMCAddr
Definition: Network.cpp:1109
-
XPMP2::UDPMulticast::Cleanup
void Cleanup()
Definition: Network.cpp:1098
-
XPMP2::UDPMulticast::Join
void Join(const std::string &_multicastAddr, int _port, int _ttl=8, size_t _bufSize=512, unsigned _timeOut_ms=0)
Connect to the multicast group.
Definition: Network.cpp:759
-
XPMP2::UDPMulticast::~UDPMulticast
virtual ~UDPMulticast()
makes sure pMCAddr is cleared up
Definition: Network.cpp:753
+
XPMP2::UDPMulticast::GetFamily
uint8_t GetFamily() const
Protocol family.
Definition: Network.h:226
+
XPMP2::UDPMulticast::IsIPv4
bool IsIPv4() const
IPv4?
Definition: Network.h:227
+
XPMP2::UDPMulticast::GetAddrHints
void GetAddrHints(struct addrinfo &hints) override
returns information from *pMCAddr
Definition: Network.cpp:1163
+
XPMP2::UDPMulticast::Cleanup
void Cleanup()
Definition: Network.cpp:1152
+
XPMP2::UDPMulticast::~UDPMulticast
virtual ~UDPMulticast()
makes sure pMCAddr is cleared up
Definition: Network.cpp:797
XPMP2::UDPMulticast::bSendToAll
bool bSendToAll
Send out multicast datagrams to all interfaces.
Definition: Network.h:200
XPMP2::UDPReceiver
Receives UDP messages.
Definition: Network.h:177
-
XPMP2::UDPReceiver::GetAddrHints
virtual void GetAddrHints(struct addrinfo &hints)
Sets flags to AI_PASSIVE, AF_INET, SOCK_DGRAM, IPPROTO_UDP.
Definition: Network.cpp:732
+
XPMP2::UDPReceiver::GetAddrHints
virtual void GetAddrHints(struct addrinfo &hints)
Sets flags to AI_PASSIVE, AF_INET, SOCK_DGRAM, IPPROTO_UDP.
Definition: Network.cpp:775
XPMP2::UDPReceiver::UDPReceiver
UDPReceiver(const std::string &_addr, int _port, size_t _bufSize=512, unsigned _timeOut_ms=0)
Constructor creates a socket and binds it to the given address.
Definition: Network.h:182
XPMP2::UDPReceiver::UDPReceiver
UDPReceiver()
Default constructor is not doing anything.
Definition: Network.h:180
XPMP2
Definition: XPMPAircraft.h:70
-
XPMP2::NetwIsLocalAddr
bool NetwIsLocalAddr(const InetAddrTy &addr)
Is given address a local one?
Definition: Network.cpp:1325
+
XPMP2::NetwIsLocalAddr
bool NetwIsLocalAddr(const InetAddrTy &addr)
Is given address a local one?
Definition: Network.cpp:1379
XPMP2::INVALID_SOCKET
constexpr SOCKET INVALID_SOCKET
Definition: Network.h:49
XPMP2::SOCKET
int SOCKET
Windows defines SOCKET, so we define it for non-Windows manually.
Definition: Network.h:48
-
XPMP2::InetAddrTy
Numerical IP address, used for both ipv4 and ipv6, for ease of handling.
Definition: Network.h:301
-
XPMP2::InetAddrTy::InetAddrTy
InetAddrTy(const sockaddr *pSa)
Take over from structure.
Definition: Network.h:313
-
XPMP2::InetAddrTy::CopyFrom
void CopyFrom(const SockAddrTy &sa)
Take over address from structure.
Definition: Network.cpp:1302
-
XPMP2::InetAddrTy::operator<
bool operator<(const InetAddrTy &o) const
Comparison also uses memcmp for defined order.
Definition: Network.h:323
-
XPMP2::InetAddrTy::operator==
bool operator==(const InetAddrTy &o) const
Equality means: all elements are equal.
Definition: Network.h:319
-
XPMP2::InetAddrTy::InetAddrTy
InetAddrTy()
Default does nothing.
Definition: Network.h:309
-
XPMP2::InetAddrTy::InetAddrTy
InetAddrTy(const SockAddrTy &sa)
Take over from structure.
Definition: Network.h:311
+
XPMP2::InetAddrTy
Numerical IP address, used for both ipv4 and ipv6, for ease of handling.
Definition: Network.h:303
+
XPMP2::InetAddrTy::InetAddrTy
InetAddrTy(const sockaddr *pSa)
Take over from structure.
Definition: Network.h:315
+
XPMP2::InetAddrTy::CopyFrom
void CopyFrom(const SockAddrTy &sa)
Take over address from structure.
Definition: Network.cpp:1356
+
XPMP2::InetAddrTy::operator<
bool operator<(const InetAddrTy &o) const
Comparison also uses memcmp for defined order.
Definition: Network.h:325
+
XPMP2::InetAddrTy::operator==
bool operator==(const InetAddrTy &o) const
Equality means: all elements are equal.
Definition: Network.h:321
+
XPMP2::InetAddrTy::InetAddrTy
InetAddrTy()
Default does nothing.
Definition: Network.h:311
+
XPMP2::InetAddrTy::InetAddrTy
InetAddrTy(const SockAddrTy &sa)
Take over from structure.
Definition: Network.h:313
XPMP2::SockAddrTy
Helper definition for all these IPv4/6 differences.
Definition: Network.h:54
XPMP2::SockAddrTy::operator<
bool operator<(const SockAddrTy &o) const
Comparison bases solely on memory compare, order isn't important, just that there is order.
Definition: Network.h:67
XPMP2::SockAddrTy::isIp4
bool isIp4() const
is this an IPv4 address?
Definition: Network.h:74
diff --git a/docs/html/Remote_8h_source.html b/docs/html/Remote_8h_source.html index c9c1caf..9cf20a2 100644 --- a/docs/html/Remote_8h_source.html +++ b/docs/html/Remote_8h_source.html @@ -197,24 +197,24 @@
XPMP2::UDPMulticast
UDP Multicast, always binding to INADDR_ANY.
Definition: Network.h:195
XPMP2
Definition: XPMPAircraft.h:70
XPMP2::mapRmtAcCacheTy
std::map< XPMPPlaneID, RmtAcCacheTy > mapRmtAcCacheTy
Defines a map with the plane id as key and the aboce cache structure as payload.
Definition: Remote.h:63
-
XPMP2::RemoteAcClearAll
void RemoteAcClearAll()
Informs us that there are no more aircraft, clear our caches!
Definition: Remote.cpp:1376
-
XPMP2::RemoteAcEnqueueDone
void RemoteAcEnqueueDone()
Informs us that all a/c have been processed: All pending messages to be sent now.
Definition: Remote.cpp:1315
-
XPMP2::RemoteAcRemove
void RemoteAcRemove(const Aircraft &ac)
Informs us about an aircraft deletion.
Definition: Remote.cpp:1348
-
XPMP2::RemoteAcEnqueueStarts
void RemoteAcEnqueueStarts(float now)
Definition: Remote.cpp:1190
+
XPMP2::RemoteAcClearAll
void RemoteAcClearAll()
Informs us that there are no more aircraft, clear our caches!
Definition: Remote.cpp:1378
+
XPMP2::RemoteAcEnqueueDone
void RemoteAcEnqueueDone()
Informs us that all a/c have been processed: All pending messages to be sent now.
Definition: Remote.cpp:1317
+
XPMP2::RemoteAcRemove
void RemoteAcRemove(const Aircraft &ac)
Informs us about an aircraft deletion.
Definition: Remote.cpp:1350
+
XPMP2::RemoteAcEnqueueStarts
void RemoteAcEnqueueStarts(float now)
Definition: Remote.cpp:1192
XPMP2::RemoteMsgTy
RemoteMsgTy
Message type.
Definition: XPMPRemote.h:77
XPMP2::RMT_MSG_AC_ANIM
@ RMT_MSG_AC_ANIM
aircraft animation values (dataRef values) only
Definition: XPMPRemote.h:83
-
XPMP2::RemoteSenderUpdateStatus
void RemoteSenderUpdateStatus()
Compares current vs. expected status and takes appropriate action.
Definition: Remote.cpp:1153
+
XPMP2::RemoteSenderUpdateStatus
void RemoteSenderUpdateStatus()
Compares current vs. expected status and takes appropriate action.
Definition: Remote.cpp:1155
XPMP2::RemoteCfgTy
RemoteCfgTy
Configuration for remote communications support.
Definition: Remote.h:32
XPMP2::REMOTE_CFG_ON
@ REMOTE_CFG_ON
config: force on
Definition: Remote.h:35
XPMP2::REMOTE_CFG_OFF
@ REMOTE_CFG_OFF
config: force off
Definition: Remote.h:33
XPMP2::REMOTE_CFG_AUTO
@ REMOTE_CFG_AUTO
config: on if in a netwoked/multiplayer setup
Definition: Remote.h:34
XPMP2::ptrRmtDataBaseTy
std::unique_ptr< RmtDataBaseTy > ptrRmtDataBaseTy
Smart pointer to XPMP2::RmtDataBaseTy by which we manage objects of this and derived types.
Definition: Remote.h:79
XPMP2::RmtDataAcRemoveTy
RmtDataEnqeueTy< RemoteAcRemoveTy, RMT_MSG_AC_REMOVE > RmtDataAcRemoveTy
A/C Removal queue type.
Definition: Remote.h:100
-
XPMP2::RemoteCleanup
void RemoteCleanup()
Grace cleanup, stops all threads.
Definition: Remote.cpp:1130
-
XPMP2::RemoteAcEnqueue
void RemoteAcEnqueue(const Aircraft &ac)
Regularly called from the flight loop callback to send a/c date onto the network.
Definition: Remote.cpp:1221
+
XPMP2::RemoteCleanup
void RemoteCleanup()
Grace cleanup, stops all threads.
Definition: Remote.cpp:1132
+
XPMP2::RemoteAcEnqueue
void RemoteAcEnqueue(const Aircraft &ac)
Regularly called from the flight loop callback to send a/c date onto the network.
Definition: Remote.cpp:1223
XPMP2::queueRmtDataTy
std::queue< ptrRmtDataBaseTy, std::list< ptrRmtDataBaseTy > > queueRmtDataTy
A queue managing the information objects, used to transfer data between main thread and network threa...
Definition: Remote.h:81
XPMP2::ptrRmtDataAcAnimTy
std::unique_ptr< RmtDataAcAnimTy > ptrRmtDataAcAnimTy
Smart pointer to XPMP2::RmtDataAcAnimTy.
Definition: Remote.h:122
-
XPMP2::RemoteInit
void RemoteInit()
Initialize the module.
Definition: Remote.cpp:1121
+
XPMP2::RemoteInit
void RemoteInit()
Initialize the module.
Definition: Remote.cpp:1123
XPMP2::RmtDataAcPosUpdateTy
RmtDataEnqeueTy< RemoteAcPosUpdateTy, RMT_MSG_AC_POS_UPDATE > RmtDataAcPosUpdateTy
A/C Position Update queue type.
Definition: Remote.h:99
XPMP2::DR_VALS
DR_VALS
The dataRefs provided by XPMP2 to the CSL models.
Definition: XPMPAircraft.h:87
XPMP2::V_COUNT
@ V_COUNT
always last, number of dataRefs XPMP2 pre-defines
Definition: XPMPAircraft.h:137
diff --git a/docs/html/Sound_8h_source.html b/docs/html/Sound_8h_source.html index 768cae8..459753d 100644 --- a/docs/html/Sound_8h_source.html +++ b/docs/html/Sound_8h_source.html @@ -358,7 +358,7 @@
XPMP2::logERR
@ logERR
errors mean, aircraft can potentially not be displayed
Definition: Utilities.h:253
XPMP2::leftOf
std::string leftOf(const std::string &s, const std::string &terminators)
Returns everything left of any of terminators.
Definition: Utilities.h:118
XPMP2::mapSoundPtrTy
std::map< std::string, SoundFilePtr > mapSoundPtrTy
Map of all sounds, indexed by a sound name (type)
Definition: Sound.h:146
-
XPMP2::LogMsg
void LogMsg(const char *szPath, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg,...)
Log Text to log file.
Definition: Utilities.cpp:848
+
XPMP2::LogMsg
void LogMsg(const char *szPath, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg,...)
Log Text to log file.
Definition: Utilities.cpp:849
XPMP2::gpSndSys
SoundSystem * gpSndSys
The sound system in use.
Definition: Sound.cpp:39
XPMP2::SoundInit
void SoundInit()
Initialize the sound module and load the sounds.
Definition: Sound.cpp:973
XPMP2::FmodHeadPitchRoll2Normal
void FmodHeadPitchRoll2Normal(const float head, const float pitch, const float roll, FMOD_VECTOR &vecDir, FMOD_VECTOR &vecNorm)
Convert heading/pitch to normal x/y/z vector.
Definition: Sound.cpp:682
diff --git a/docs/html/Utilities_8h.html b/docs/html/Utilities_8h.html index 809c271..af245ec 100644 --- a/docs/html/Utilities_8h.html +++ b/docs/html/Utilities_8h.html @@ -377,7 +377,7 @@

if (XPMP2::glob.bLogMdlMatch && lvl >= glob.logLvl) \
{LogMsg(__FILE__, __LINE__, __func__, lvl, __VA_ARGS__);} \
}
-
XPMP2::LogMsg
void LogMsg(const char *szPath, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg,...)
Log Text to log file.
Definition: Utilities.cpp:848
+
XPMP2::LogMsg
void LogMsg(const char *szPath, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg,...)
Log Text to log file.
Definition: Utilities.cpp:849
XPMP2::glob
GlobVars glob
The one and only global variable structure.
Definition: Utilities.cpp:29
XPMP2::GlobVars::logLvl
logLevelTy logLvl
Logging level.
Definition: XPMP2.h:132
diff --git a/docs/html/Utilities_8h_source.html b/docs/html/Utilities_8h_source.html index 33b0ea0..e505810 100644 --- a/docs/html/Utilities_8h_source.html +++ b/docs/html/Utilities_8h_source.html @@ -322,7 +322,7 @@
WHITESPACE
#define WHITESPACE
Definition: Utilities.h:89
XPMP2_FMTARGS
#define XPMP2_FMTARGS(FMT)
To apply printf-style warnings to our functions.
Definition: Utilities.h:245
XPMP2
Definition: XPMPAircraft.h:70
-
XPMP2::HeadPitch2Vec
std::valarray< float > HeadPitch2Vec(const float head, const float pitch)
Convert heading/pitch to normalized x/y/z vector.
Definition: Utilities.cpp:657
+
XPMP2::HeadPitch2Vec
std::valarray< float > HeadPitch2Vec(const float head, const float pitch)
Convert heading/pitch to normalized x/y/z vector.
Definition: Utilities.cpp:658
XPMP2::rad2deg
T rad2deg(const T _rad)
Convert radians to degrees, normalized to [0..360)
Definition: Utilities.h:145
XPMP2::logLevelTy
logLevelTy
Logging level.
Definition: Utilities.h:249
XPMP2::logFATAL
@ logFATAL
fatal is shortly before a crash
Definition: Utilities.h:254
@@ -332,47 +332,47 @@
XPMP2::logERR
@ logERR
errors mean, aircraft can potentially not be displayed
Definition: Utilities.h:253
XPMP2::logINFO
@ logINFO
regular info messages
Definition: Utilities.h:251
XPMP2::leftOf
std::string leftOf(const std::string &s, const std::string &terminators)
Returns everything left of any of terminators.
Definition: Utilities.h:118
-
XPMP2::LogGetString
const char * LogGetString(const char *szPath, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg, va_list args)
Returns ptr to static buffer filled with formatted log string.
Definition: Utilities.cpp:808
+
XPMP2::LogGetString
const char * LogGetString(const char *szPath, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg, va_list args)
Returns ptr to static buffer filled with formatted log string.
Definition: Utilities.cpp:809
XPMP2::RSRC_OBJ8DATAREFS
constexpr const char * RSRC_OBJ8DATAREFS
Definition: Utilities.h:38
XPMP2::TOPOSIX
std::string TOPOSIX(const std::string &p)
On Lin/Win there is no need for a conversion, but we do treat p now as std::string
Definition: Utilities.h:349
XPMP2::PI
constexpr double PI
Pi.
Definition: Utilities.h:133
-
XPMP2::LogMsg
void LogMsg(const char *szPath, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg,...)
Log Text to log file.
Definition: Utilities.cpp:848
-
XPMP2::CheckEverySoOften
bool CheckEverySoOften(float &_lastCheck, float _interval, float _now)
Convenience function to check on something at most every x seconds.
Definition: Utilities.cpp:764
+
XPMP2::LogMsg
void LogMsg(const char *szPath, int ln, const char *szFunc, logLevelTy lvl, const char *szMsg,...)
Log Text to log file.
Definition: Utilities.cpp:849
+
XPMP2::CheckEverySoOften
bool CheckEverySoOften(float &_lastCheck, float _interval, float _now)
Convenience function to check on something at most every x seconds.
Definition: Utilities.cpp:765
XPMP2::ltrim
std::string & ltrim(std::string &s, const char *t=WHITESPACE)
trimming of string (from left)
Definition: Utilities.h:104
-
XPMP2::GetMiscNetwTimeStr
std::string GetMiscNetwTimeStr(float _time)
Return the network time as a string like used in the XP's Log.txt.
Definition: Utilities.cpp:720
+
XPMP2::GetMiscNetwTimeStr
std::string GetMiscNetwTimeStr(float _time)
Return the network time as a string like used in the XP's Log.txt.
Definition: Utilities.cpp:721
XPMP2::FROMPOSIX
std::string FROMPOSIX(const std::string &p)
On Lin/Win there is no need for a conversion, but we do treat p now as std::string
Definition: Utilities.h:351
XPMP2::angleLocCoord
float angleLocCoord(float x1, float z1, float x2, float z2)
Angle of line from point (x1|z1) to point (x2|z2)
Definition: Utilities.h:176
-
XPMP2::RemoveExtension
void RemoveExtension(std::string &path)
Removes everything after the last dot, the dot including.
Definition: Utilities.cpp:472
-
XPMP2::GetDirContents
std::list< std::string > GetDirContents(const std::string &path)
List of files in a directory (wrapper around XPLMGetDirectoryContents)
Definition: Utilities.cpp:403
+
XPMP2::RemoveExtension
void RemoveExtension(std::string &path)
Removes everything after the last dot, the dot including.
Definition: Utilities.cpp:473
+
XPMP2::GetDirContents
std::list< std::string > GetDirContents(const std::string &path)
List of files in a directory (wrapper around XPLMGetDirectoryContents)
Definition: Utilities.cpp:404
XPMP2::RSRC_RELATED
constexpr const char * RSRC_RELATED
Definition: Utilities.h:34
-
XPMP2::HeadPitchRoll2Normal
std::valarray< float > HeadPitchRoll2Normal(const float head, const float pitch, const float roll)
Convert heading/pitch/roll to unit and normal vector, ie. returns 6 values, first 3 like HeadPitch2Ve...
Definition: Utilities.cpp:678
+
XPMP2::HeadPitchRoll2Normal
std::valarray< float > HeadPitchRoll2Normal(const float head, const float pitch, const float roll)
Convert heading/pitch/roll to unit and normal vector, ie. returns 6 values, first 3 like HeadPitch2Ve...
Definition: Utilities.cpp:679
XPMP2::sqr
T sqr(const T a)
Square.
Definition: Utilities.h:155
-
XPMP2::GetMiscNetwTime
float GetMiscNetwTime()
Get synched network time from X-Plane (sim/network/misc/network_time_sec) as used in Log....
Definition: Utilities.cpp:711
+
XPMP2::GetMiscNetwTime
float GetMiscNetwTime()
Get synched network time from X-Plane (sim/network/misc/network_time_sec) as used in Log....
Definition: Utilities.cpp:712
XPMP2::fequal
bool fequal(float a, float b)
Are these two float near-equal? (to avoid trying something like a == b)
Definition: Utilities.h:139
-
XPMP2::GetXPSystemPath
const std::string & GetXPSystemPath()
Returns XP's system directory, including a trailing slash.
Definition: Utilities.cpp:449
+
XPMP2::GetXPSystemPath
const std::string & GetXPSystemPath()
Returns XP's system directory, including a trailing slash.
Definition: Utilities.cpp:450
XPMP2::headNormalize
numT headNormalize(numT _head)
Normalize a heading value to [0..360), works for both float and double values.
Definition: Utilities.h:184
XPMP2::EPSILON_F
constexpr float EPSILON_F
Epsilon, a small number.
Definition: Utilities.h:136
-
XPMP2::GetGraphicsDriverTxt
const char * GetGraphicsDriverTxt()
Text string for current graphics driver in use.
Definition: Utilities.cpp:737
-
XPMP2::headDiff
float headDiff(float head1, float head2)
(Shortest) difference between 2 angles: How much to turn to go from h1 to h2?
Definition: Utilities.cpp:637
-
XPMP2::ExistsFile
bool ExistsFile(const std::string &filename)
Does a file path exist?
Definition: Utilities.cpp:319
-
XPMP2::CreateDir
bool CreateDir(const std::string &path)
Create directory if it does not exist.
Definition: Utilities.cpp:335
-
XPMP2::str_tolower
std::string & str_tolower(std::string &s)
change a std::string to uppercase
Definition: Utilities.cpp:583
-
XPMP2::CopyFileIfNewer
bool CopyFileIfNewer(const std::string &source, const std::string &destDir)
Copy file if source is newer or destination missing.
Definition: Utilities.cpp:350
+
XPMP2::GetGraphicsDriverTxt
const char * GetGraphicsDriverTxt()
Text string for current graphics driver in use.
Definition: Utilities.cpp:738
+
XPMP2::headDiff
float headDiff(float head1, float head2)
(Shortest) difference between 2 angles: How much to turn to go from h1 to h2?
Definition: Utilities.cpp:638
+
XPMP2::ExistsFile
bool ExistsFile(const std::string &filename)
Does a file path exist?
Definition: Utilities.cpp:320
+
XPMP2::CreateDir
bool CreateDir(const std::string &path)
Create directory if it does not exist.
Definition: Utilities.cpp:336
+
XPMP2::str_tolower
std::string & str_tolower(std::string &s)
change a std::string to uppercase
Definition: Utilities.cpp:584
+
XPMP2::CopyFileIfNewer
bool CopyFileIfNewer(const std::string &source, const std::string &destDir)
Copy file if source is newer or destination missing.
Definition: Utilities.cpp:351
XPMP2::RSRC_MAP_ICONS
constexpr const char * RSRC_MAP_ICONS
Definition: Utilities.h:37
-
XPMP2::IsPaused
bool IsPaused()
X-Plane in a Pause state?
Definition: Utilities.cpp:750
-
XPMP2::IsViewExternal
bool IsViewExternal()
Is current X-Plane view an external view (outside a cockpit)?
Definition: Utilities.cpp:757
+
XPMP2::IsPaused
bool IsPaused()
X-Plane in a Pause state?
Definition: Utilities.cpp:751
+
XPMP2::IsViewExternal
bool IsViewExternal()
Is current X-Plane view an external view (outside a cockpit)?
Definition: Utilities.cpp:758
XPMP2::dist
T dist(const T x1, const T y1, const T z1, const T x2, const T y2, const T z2)
Pythagorean distance between two points in a 3-D world.
Definition: Utilities.h:159
XPMP2::trim
std::string & trim(std::string &s, const char *t=WHITESPACE)
trimming of string (from both ends)
Definition: Utilities.h:112
-
XPMP2::StripXPSysDir
std::string StripXPSysDir(const std::string &path)
If a path starts with X-Plane's system directory it is stripped.
Definition: Utilities.cpp:462
+
XPMP2::StripXPSysDir
std::string StripXPSysDir(const std::string &path)
If a path starts with X-Plane's system directory it is stripped.
Definition: Utilities.cpp:463
XPMP2::deg2rad
T deg2rad(const T _deg)
Convert degree to radians.
Definition: Utilities.h:150
XPMP2::RSRC_REL_OP
constexpr const char * RSRC_REL_OP
Definition: Utilities.h:35
XPMP2::rtrim
std::string & rtrim(std::string &s, const char *t=WHITESPACE)
trimming of string (from right)
Definition: Utilities.h:96
-
XPMP2::IsDir
bool IsDir(const std::string &path)
Is path a directory?
Definition: Utilities.cpp:326
+
XPMP2::IsDir
bool IsDir(const std::string &path)
Is path a directory?
Definition: Utilities.cpp:327
XPMP2::atan2deg
float atan2deg(float x, float y)
atan2 converted to degrees: the angle between (0|0) and the given point
Definition: Utilities.h:166
-
XPMP2::PrefsFuncIntDefault
int PrefsFuncIntDefault(const char *, const char *, int _default)
Default config function just always returns the provided default value.
Definition: Utilities.cpp:161
+
XPMP2::PrefsFuncIntDefault
int PrefsFuncIntDefault(const char *, const char *, int _default)
Default config function just always returns the provided default value.
Definition: Utilities.cpp:162
XPMP2::RSRC_DOC8643
constexpr const char * RSRC_DOC8643
Definition: Utilities.h:36
-
XPMP2::str_tokenize
std::vector< std::string > str_tokenize(const std::string s, const std::string tokens, bool bSkipEmpty)
separates string into tokens
Definition: Utilities.cpp:590
-
XPMP2::safeGetline
std::istream & safeGetline(std::istream &is, std::string &t)
Read a line from a text file, no matter if ending on CRLF or LF.
Definition: Utilities.cpp:436
+
XPMP2::str_tokenize
std::vector< std::string > str_tokenize(const std::string s, const std::string tokens, bool bSkipEmpty)
separates string into tokens
Definition: Utilities.cpp:591
+
XPMP2::safeGetline
std::istream & safeGetline(std::istream &is, std::string &t)
Read a line from a text file, no matter if ending on CRLF or LF.
Definition: Utilities.cpp:437
diff --git a/docs/html/XPMP2_8h_source.html b/docs/html/XPMP2_8h_source.html index f48c32c..1860d4a 100644 --- a/docs/html/XPMP2_8h_source.html +++ b/docs/html/XPMP2_8h_source.html @@ -197,68 +197,70 @@
201 
204  std::string remoteMCGroup = "239.255.1.1"; // for IPv6 try "FF02::1"
206  int remotePort = 49788;
-
208  int remoteTTL = 8;
-
210  size_t remoteBufSize = 8192;
-
212  int remoteTxfFrequ = 5;
-
214  RemoteCfgTy remoteCfg = REMOTE_CFG_AUTO;
-
216  RemoteCfgTy remoteCfgFromIni= REMOTE_CFG_AUTO;
-
218  RemoteStatusTy remoteStatus = REMOTE_OFF;
-
220  bool RemoteIsListener() const { return remoteStatus == REMOTE_RECEIVING || remoteStatus == REMOTE_RECV_WAITING; }
-
222  bool RemoteIsSender() const { return remoteStatus == REMOTE_SENDING || remoteStatus == REMOTE_SEND_WAITING; }
-
223 
-
224  // Contrails
-
225  int contrailAltMin_ft = 25000;
-
226  int contrailAltMax_ft = 45000;
-
227  int contrailLifeTime = 25;
-
228  bool contrailMulti = false;
-
229 
-
231  bool bSoundOnStartup = true;
-
233  bool bSoundForceFmodInstance = false;
-
235  bool bSoundMuteOnPause = true;
-
237  bool bSoundAvail = false;
-
239  float sndMasterVol = 1.0f;
-
241  bool bSoundAutoMuted = false;
-
242 
-
244  int verXPlane = -1;
-
246  int verXPLM = -1;
-
248  bool bXPUsingModernGraphicsDriver = false;
-
250  bool bXPNetworkedSetup = false;
-
252  XPLMPluginID pluginId = 0;
-
254  std::thread::id xpThread;
-
255 
-
257  XPLMCameraPosition_t posCamera = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f };
-
259  XPLMCameraPosition_t prevCamera = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f };
-
261  float vCam_x = 0.0f, vCam_y = 0.0f, vCam_z = 0.0f;
-
263  float prevCamera_ts = 0.0f;
-
264 
-
266  int xpCycleNum = 0;
-
267 
-
268 protected:
-
270  XPMPPlaneID planeId = 0;
-
271 public:
-
273  XPMPPlaneID NextPlaneId ();
-
274 
+
208  std::string remoteSendIntf;
+
210  bool remoteAutoDiscovery() const { return remoteSendIntf.empty(); }
+
212  int remoteTTL = 8;
+
214  size_t remoteBufSize = 8192;
+
216  int remoteTxfFrequ = 5;
+
218  RemoteCfgTy remoteCfg = REMOTE_CFG_AUTO;
+
220  RemoteCfgTy remoteCfgFromIni= REMOTE_CFG_AUTO;
+
222  RemoteStatusTy remoteStatus = REMOTE_OFF;
+
224  bool RemoteIsListener() const { return remoteStatus == REMOTE_RECEIVING || remoteStatus == REMOTE_RECV_WAITING; }
+
226  bool RemoteIsSender() const { return remoteStatus == REMOTE_SENDING || remoteStatus == REMOTE_SEND_WAITING; }
+
227 
+
228  // Contrails
+
229  int contrailAltMin_ft = 25000;
+
230  int contrailAltMax_ft = 45000;
+
231  int contrailLifeTime = 25;
+
232  bool contrailMulti = false;
+
233 
+
235  bool bSoundOnStartup = true;
+
237  bool bSoundForceFmodInstance = false;
+
239  bool bSoundMuteOnPause = true;
+
241  bool bSoundAvail = false;
+
243  float sndMasterVol = 1.0f;
+
245  bool bSoundAutoMuted = false;
+
246 
+
248  int verXPlane = -1;
+
250  int verXPLM = -1;
+
252  bool bXPUsingModernGraphicsDriver = false;
+
254  bool bXPNetworkedSetup = false;
+
256  XPLMPluginID pluginId = 0;
+
258  std::thread::id xpThread;
+
259 
+
261  XPLMCameraPosition_t posCamera = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f };
+
263  XPLMCameraPosition_t prevCamera = { 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f, 0.0f };
+
265  float vCam_x = 0.0f, vCam_y = 0.0f, vCam_z = 0.0f;
+
267  float prevCamera_ts = 0.0f;
+
268 
+
270  int xpCycleNum = 0;
+
271 
+
272 protected:
+
274  XPMPPlaneID planeId = 0;
275 public:
-
277  GlobVars (logLevelTy _logLvl = logINFO, bool _logMdlMatch = false) :
-
278  logLvl(_logLvl), bLogMdlMatch(_logMdlMatch) {}
-
280  void ReadConfigFile ();
-
282  void UpdateCfgVals ();
-
284  void ReadVersions ();
-
286  bool UsingModernGraphicsDriver() const { return bXPUsingModernGraphicsDriver; }
-
288  void ThisThreadIsXP()
-
289  { xpThread = std::this_thread::get_id(); pluginId = XPLMGetMyID(); }
-
291  bool IsXPThread() const { return std::this_thread::get_id() == xpThread; }
-
292 
-
294  void UpdateCameraPos ();
-
295 };
+
277  XPMPPlaneID NextPlaneId ();
+
278 
+
279 public:
+
281  GlobVars (logLevelTy _logLvl = logINFO, bool _logMdlMatch = false) :
+
282  logLvl(_logLvl), bLogMdlMatch(_logMdlMatch) {}
+
284  void ReadConfigFile ();
+
286  void UpdateCfgVals ();
+
288  void ReadVersions ();
+
290  bool UsingModernGraphicsDriver() const { return bXPUsingModernGraphicsDriver; }
+
292  void ThisThreadIsXP()
+
293  { xpThread = std::this_thread::get_id(); pluginId = XPLMGetMyID(); }
+
295  bool IsXPThread() const { return std::this_thread::get_id() == xpThread; }
296 
-
298 extern GlobVars glob;
-
299 
-
300 } // namespace XPMP2
-
301 
-
302 
+
298  void UpdateCameraPos ();
+
299 };
+
300 
+
302 extern GlobVars glob;
303 
-
304 #endif
+
304 } // namespace XPMP2
+
305 
+
306 
+
307 
+
308 #endif
2D.h
Definitions of 2-D routines, like drawing aircraft labels.
AIMultiplayer.h
Definitions for serving TCAS target dataRef updates.
Aircraft.h
Additional definitions beyond what public XPCAircraft defines.
@@ -301,82 +303,84 @@
XPMP2::mapMapLayerIDTy
std::map< std::string, XPLMMapLayerID > mapMapLayerIDTy
A map holding our layer identifier, indexed by the map's name.
Definition: Map.h:27
XPMP2::XPMPSendNotification
void XPMPSendNotification(const Aircraft &plane, XPMPPlaneNotification _notification)
Send a notification to all observers.
Definition: XPMPMultiplayer.cpp:572
XPMP2::mapCSLPackageTy
std::map< std::string, std::string > mapCSLPackageTy
Map of CSLPackages: Maps an id to the base path (path ends on forward slash)
Definition: CSLModels.h:27
-
XPMP2::PrefsFuncIntDefault
int PrefsFuncIntDefault(const char *, const char *, int _default)
Default config function just always returns the provided default value.
Definition: Utilities.cpp:161
+
XPMP2::PrefsFuncIntDefault
int PrefsFuncIntDefault(const char *, const char *, int _default)
Default config function just always returns the provided default value.
Definition: Utilities.cpp:162
XPMP2::GlobVars
All global config settings and variables are kept in one structure for convenient access and central ...
Definition: XPMP2.h:128
XPMP2::GlobVars::defaultICAO
std::string defaultICAO
Default ICAO aircraft type designator if no match can be found.
Definition: XPMP2.h:173
XPMP2::GlobVars::listObj8DataRefs
listObj8DataRefsTy listObj8DataRefs
List of dataRef replacement in .obj files.
Definition: XPMP2.h:147
-
XPMP2::GlobVars::pluginId
XPLMPluginID pluginId
This plugin's id.
Definition: XPMP2.h:252
+
XPMP2::GlobVars::pluginId
XPLMPluginID pluginId
This plugin's id.
Definition: XPMP2.h:256
XPMP2::GlobVars::bHasControlOfAIAircraft
bool bHasControlOfAIAircraft
Do we control X-Plane's AI/Multiplayer planes?
Definition: XPMP2.h:191
-
XPMP2::GlobVars::vCam_z
float vCam_z
Definition: XPMP2.h:261
-
XPMP2::GlobVars::bSoundMuteOnPause
bool bSoundMuteOnPause
Config: Mute on Pause?
Definition: XPMP2.h:235
-
XPMP2::GlobVars::bXPUsingModernGraphicsDriver
bool bXPUsingModernGraphicsDriver
Using a modern graphics driver, ie. Vulkan/Metal?
Definition: XPMP2.h:248
+
XPMP2::GlobVars::vCam_z
float vCam_z
Definition: XPMP2.h:265
+
XPMP2::GlobVars::bSoundMuteOnPause
bool bSoundMuteOnPause
Config: Mute on Pause?
Definition: XPMP2.h:239
+
XPMP2::GlobVars::bXPUsingModernGraphicsDriver
bool bXPUsingModernGraphicsDriver
Using a modern graphics driver, ie. Vulkan/Metal?
Definition: XPMP2.h:252
XPMP2::GlobVars::listObservers
listXPMPPlaneNotifierTy listObservers
List of notifier functions registered for being notified of creation/destruction/model change.
Definition: XPMP2.h:157
-
XPMP2::GlobVars::remoteStatus
RemoteStatusTy remoteStatus
Status of remote connections to networked clients.
Definition: XPMP2.h:218
-
XPMP2::GlobVars::posCamera
XPLMCameraPosition_t posCamera
Current camera location, updated every flight loop.
Definition: XPMP2.h:257
+
XPMP2::GlobVars::remoteStatus
RemoteStatusTy remoteStatus
Status of remote connections to networked clients.
Definition: XPMP2.h:222
+
XPMP2::GlobVars::posCamera
XPLMCameraPosition_t posCamera
Current camera location, updated every flight loop.
Definition: XPMP2.h:261
XPMP2::GlobVars::mapMapLayers
mapMapLayerIDTy mapMapLayers
Map of map layer ids, i.e. for each map this is the id of the corresponding layer of ours.
Definition: XPMP2.h:198
XPMP2::GlobVars::mapRelated
std::array< mapRelatedTy, REL_TXT_NUM > mapRelated
Content of related.txt and similar files as a map of keys to group id.
Definition: XPMP2.h:166
XPMP2::GlobVars::pathRelated
std::array< std::string, REL_TXT_NUM > pathRelated
Paths to related.txt, relOp.txt... files.
Definition: XPMP2.h:164
XPMP2::GlobVars::bDrawLabels
bool bDrawLabels
Shall we draw aircraft labels?
Definition: XPMP2.h:182
XPMP2::GlobVars::pathMapIcons
std::string pathMapIcons
path to file containing plane icons for map display
Definition: XPMP2.h:200
-
XPMP2::GlobVars::contrailAltMax_ft
int contrailAltMax_ft
[ft] Auto Contrails: Maximum altitude
Definition: XPMP2.h:226
+
XPMP2::GlobVars::contrailAltMax_ft
int contrailAltMax_ft
[ft] Auto Contrails: Maximum altitude
Definition: XPMP2.h:230
XPMP2::GlobVars::mapAc
mapAcTy mapAc
Global map of all created planes.
Definition: XPMP2.h:180
XPMP2::GlobVars::remotePort
int remotePort
The port we use is different from the port the X-Plane BEACON uses, so we don't get into conflict.
Definition: XPMP2.h:206
-
XPMP2::GlobVars::prevCamera_ts
float prevCamera_ts
When has prevCamera been updated last?
Definition: XPMP2.h:263
+
XPMP2::GlobVars::prevCamera_ts
float prevCamera_ts
When has prevCamera been updated last?
Definition: XPMP2.h:267
XPMP2::GlobVars::bLabelCutOffAtVisibility
bool bLabelCutOffAtVisibility
Cut off labels at XP's reported visibility mit?
Definition: XPMP2.h:186
XPMP2::GlobVars::pluginName
std::string pluginName
Name of the plugin we are serving (used as map layer name or for folders)
Definition: XPMP2.h:150
XPMP2::GlobVars::pathObj8DataRefs
std::string pathObj8DataRefs
Path to the Obj8DataRefs.txt file.
Definition: XPMP2.h:145
-
XPMP2::GlobVars::xpThread
std::thread::id xpThread
id of X-Plane's thread (when it is OK to use XP API calls)
Definition: XPMP2.h:254
-
XPMP2::GlobVars::UpdateCfgVals
void UpdateCfgVals()
Update all settings, e.g. for logging level, by calling prefsFuncInt.
Definition: Utilities.cpp:167
+
XPMP2::GlobVars::xpThread
std::thread::id xpThread
id of X-Plane's thread (when it is OK to use XP API calls)
Definition: XPMP2.h:258
+
XPMP2::GlobVars::UpdateCfgVals
void UpdateCfgVals()
Update all settings, e.g. for logging level, by calling prefsFuncInt.
Definition: Utilities.cpp:168
XPMP2::GlobVars::logAcronym
std::string logAcronym
Plugin acronym used in log output.
Definition: XPMP2.h:152
XPMP2::GlobVars::prefsFuncInt
int(* prefsFuncInt)(const char *, const char *, int)
Configuration callback for integer values.
Definition: XPMP2.h:155
-
XPMP2::GlobVars::vCam_x
float vCam_x
Camera velocity.
Definition: XPMP2.h:261
-
XPMP2::GlobVars::sndMasterVol
float sndMasterVol
Sound master volume.
Definition: XPMP2.h:239
-
XPMP2::GlobVars::verXPLM
int verXPLM
XPLM's SDK version number (XPLMGetVersions)
Definition: XPMP2.h:246
-
XPMP2::GlobVars::ThisThreadIsXP
void ThisThreadIsXP()
Set current thread as main xp Thread.
Definition: XPMP2.h:288
+
XPMP2::GlobVars::vCam_x
float vCam_x
Camera velocity.
Definition: XPMP2.h:265
+
XPMP2::GlobVars::sndMasterVol
float sndMasterVol
Sound master volume.
Definition: XPMP2.h:243
+
XPMP2::GlobVars::verXPLM
int verXPLM
XPLM's SDK version number (XPLMGetVersions)
Definition: XPMP2.h:250
+
XPMP2::GlobVars::ThisThreadIsXP
void ThisThreadIsXP()
Set current thread as main xp Thread.
Definition: XPMP2.h:292
XPMP2::GlobVars::maxLabelDist
float maxLabelDist
Maximum distance for drawing labels? [m], defaults to 3nm.
Definition: XPMP2.h:184
-
XPMP2::GlobVars::contrailAltMin_ft
int contrailAltMin_ft
[ft] Auto Contrails: Minimum altitude
Definition: XPMP2.h:225
+
XPMP2::GlobVars::contrailAltMin_ft
int contrailAltMin_ft
[ft] Auto Contrails: Minimum altitude
Definition: XPMP2.h:229
XPMP2::GlobVars::carIcaoType
std::string carIcaoType
Ground vehicle type identifier (map decides icon based on this)
Definition: XPMP2.h:175
-
XPMP2::GlobVars::remoteBufSize
size_t remoteBufSize
Buffer size, ie. max message length we send over multicast.
Definition: XPMP2.h:210
-
XPMP2::GlobVars::ReadVersions
void ReadVersions()
Read version numbers into verXplane/verXPLM.
Definition: Utilities.cpp:262
+
XPMP2::GlobVars::remoteBufSize
size_t remoteBufSize
Buffer size, ie. max message length we send over multicast.
Definition: XPMP2.h:214
+
XPMP2::GlobVars::ReadVersions
void ReadVersions()
Read version numbers into verXplane/verXPLM.
Definition: Utilities.cpp:263
XPMP2::GlobVars::resourceDir
std::string resourceDir
Resource directory, to store local definitions of vertical offsets (clamping)
Definition: XPMP2.h:177
XPMP2::GlobVars::bLogMdlMatch
bool bLogMdlMatch
Debug model matching?
Definition: XPMP2.h:134
-
XPMP2::GlobVars::RemoteIsSender
bool RemoteIsSender() const
Are we a sender?
Definition: XPMP2.h:222
+
XPMP2::GlobVars::remoteAutoDiscovery
bool remoteAutoDiscovery() const
Use auto-discovery for the MC send interface?
Definition: XPMP2.h:210
+
XPMP2::GlobVars::RemoteIsSender
bool RemoteIsSender() const
Are we a sender?
Definition: XPMP2.h:226
XPMP2::GlobVars::NextPlaneId
XPMPPlaneID NextPlaneId()
Get the next unique artifical plane id.
Definition: Utilities.cpp:37
XPMP2::GlobVars::mapCSLModels
mapCSLModelTy mapCSLModels
Global map of all CSL Models, indexed by related group, aircraft type, and model id.
Definition: XPMP2.h:171
-
XPMP2::GlobVars::verXPlane
int verXPlane
X-Plane's version number (XPLMGetVersions)
Definition: XPMP2.h:244
+
XPMP2::GlobVars::verXPlane
int verXPlane
X-Plane's version number (XPLMGetVersions)
Definition: XPMP2.h:248
XPMP2::GlobVars::logLvl
logLevelTy logLvl
Logging level.
Definition: XPMP2.h:132
XPMP2::GlobVars::bObjReplDataRefs
bool bObjReplDataRefs
Replace dataRefs in .obj files on load? (defaults to OFF!)
Definition: XPMP2.h:141
XPMP2::GlobVars::bHandleDupId
bool bHandleDupId
Handle duplicate XPMP2::Aircraft::modeS_id by overwriting with unique id.
Definition: XPMP2.h:138
XPMP2::GlobVars::bMapLabels
bool bMapLabels
Do we show labels with the aircraft icons?
Definition: XPMP2.h:196
XPMP2::GlobVars::ReadConfigFile
void ReadConfigFile()
Read from a generic XPMP2.prf or XPMP2.<logAcronym>.prf config file.
Definition: Utilities.cpp:63
XPMP2::GlobVars::bClampAll
bool bClampAll
Clamp all planes to the ground? Default is false as clamping is kinda expensive due to Y-Testing.
Definition: XPMP2.h:136
-
XPMP2::GlobVars::prevCamera
XPLMCameraPosition_t prevCamera
Previous camera location of about a second ago.
Definition: XPMP2.h:259
-
XPMP2::GlobVars::bXPNetworkedSetup
bool bXPNetworkedSetup
Is X-Plane configured for networked multi-computer or multiplayer setup?
Definition: XPMP2.h:250
-
XPMP2::GlobVars::contrailMulti
bool contrailMulti
Auto-create multiple or just a single contrail?
Definition: XPMP2.h:228
-
XPMP2::GlobVars::RemoteIsListener
bool RemoteIsListener() const
Are we a listener?
Definition: XPMP2.h:220
+
XPMP2::GlobVars::prevCamera
XPLMCameraPosition_t prevCamera
Previous camera location of about a second ago.
Definition: XPMP2.h:263
+
XPMP2::GlobVars::bXPNetworkedSetup
bool bXPNetworkedSetup
Is X-Plane configured for networked multi-computer or multiplayer setup?
Definition: XPMP2.h:254
+
XPMP2::GlobVars::contrailMulti
bool contrailMulti
Auto-create multiple or just a single contrail?
Definition: XPMP2.h:232
+
XPMP2::GlobVars::RemoteIsListener
bool RemoteIsListener() const
Are we a listener?
Definition: XPMP2.h:224
XPMP2::GlobVars::labelFontScaling
float labelFontScaling
Label font scaling factor.
Definition: XPMP2.h:188
XPMP2::GlobVars::remoteMCGroup
std::string remoteMCGroup
The multicast group that we use, which is the same X-Plane is using itself for its BEACON.
Definition: XPMP2.h:204
-
XPMP2::GlobVars::remoteCfg
RemoteCfgTy remoteCfg
Configuration: Are we to support remote connections?
Definition: XPMP2.h:214
-
XPMP2::GlobVars::remoteTxfFrequ
int remoteTxfFrequ
Max transfer frequency per second.
Definition: XPMP2.h:212
-
XPMP2::GlobVars::bSoundForceFmodInstance
bool bSoundForceFmodInstance
Config: Force own FMOD instance?
Definition: XPMP2.h:233
-
XPMP2::GlobVars::UpdateCameraPos
void UpdateCameraPos()
Update the stored camera position and velocity values.
Definition: Utilities.cpp:277
+
XPMP2::GlobVars::remoteCfg
RemoteCfgTy remoteCfg
Configuration: Are we to support remote connections?
Definition: XPMP2.h:218
+
XPMP2::GlobVars::remoteTxfFrequ
int remoteTxfFrequ
Max transfer frequency per second.
Definition: XPMP2.h:216
+
XPMP2::GlobVars::bSoundForceFmodInstance
bool bSoundForceFmodInstance
Config: Force own FMOD instance?
Definition: XPMP2.h:237
+
XPMP2::GlobVars::remoteSendIntf
std::string remoteSendIntf
The interface used to send multicast on. (Empty == auto-discovery)
Definition: XPMP2.h:208
+
XPMP2::GlobVars::UpdateCameraPos
void UpdateCameraPos()
Update the stored camera position and velocity values.
Definition: Utilities.cpp:278
XPMP2::GlobVars::mapDoc8643
mapDoc8643Ty mapDoc8643
Content of Doc8643.txt file.
Definition: XPMP2.h:162
-
XPMP2::GlobVars::vCam_y
float vCam_y
Definition: XPMP2.h:261
-
XPMP2::GlobVars::bSoundAutoMuted
bool bSoundAutoMuted
Is sound currently being auto-muted?
Definition: XPMP2.h:241
-
XPMP2::GlobVars::remoteCfgFromIni
RemoteCfgTy remoteCfgFromIni
Configuration file entry: Are we to support remote connections?
Definition: XPMP2.h:216
-
XPMP2::GlobVars::UsingModernGraphicsDriver
bool UsingModernGraphicsDriver() const
Using a modern graphics driver, ie. Vulkan/Metal?
Definition: XPMP2.h:286
-
XPMP2::GlobVars::xpCycleNum
int xpCycleNum
Current XP cycle number (see XPLMGetCycleNumber())
Definition: XPMP2.h:266
-
XPMP2::GlobVars::bSoundAvail
bool bSoundAvail
Is the sound system available?
Definition: XPMP2.h:237
+
XPMP2::GlobVars::vCam_y
float vCam_y
Definition: XPMP2.h:265
+
XPMP2::GlobVars::bSoundAutoMuted
bool bSoundAutoMuted
Is sound currently being auto-muted?
Definition: XPMP2.h:245
+
XPMP2::GlobVars::remoteCfgFromIni
RemoteCfgTy remoteCfgFromIni
Configuration file entry: Are we to support remote connections?
Definition: XPMP2.h:220
+
XPMP2::GlobVars::UsingModernGraphicsDriver
bool UsingModernGraphicsDriver() const
Using a modern graphics driver, ie. Vulkan/Metal?
Definition: XPMP2.h:290
+
XPMP2::GlobVars::xpCycleNum
int xpCycleNum
Current XP cycle number (see XPLMGetCycleNumber())
Definition: XPMP2.h:270
+
XPMP2::GlobVars::bSoundAvail
bool bSoundAvail
Is the sound system available?
Definition: XPMP2.h:241
XPMP2::GlobVars::bMapEnabled
bool bMapEnabled
Do we feed X-Plane's maps with our aircraft positions?
Definition: XPMP2.h:194
-
XPMP2::GlobVars::IsXPThread
bool IsXPThread() const
Is this thread XP's main thread?
Definition: XPMP2.h:291
-
XPMP2::GlobVars::contrailLifeTime
int contrailLifeTime
[s] Contrail default time to live
Definition: XPMP2.h:227
-
XPMP2::GlobVars::planeId
XPMPPlaneID planeId
Current plane ID counter.
Definition: XPMP2.h:270
-
XPMP2::GlobVars::GlobVars
GlobVars(logLevelTy _logLvl=logINFO, bool _logMdlMatch=false)
Constructor.
Definition: XPMP2.h:277
+
XPMP2::GlobVars::IsXPThread
bool IsXPThread() const
Is this thread XP's main thread?
Definition: XPMP2.h:295
+
XPMP2::GlobVars::contrailLifeTime
int contrailLifeTime
[s] Contrail default time to live
Definition: XPMP2.h:231
+
XPMP2::GlobVars::planeId
XPMPPlaneID planeId
Current plane ID counter.
Definition: XPMP2.h:274
+
XPMP2::GlobVars::GlobVars
GlobVars(logLevelTy _logLvl=logINFO, bool _logMdlMatch=false)
Constructor.
Definition: XPMP2.h:281
XPMP2::GlobVars::mapCSLPkgs
mapCSLPackageTy mapCSLPkgs
Global map of all CSL Packages, indexed by xsb_aircraft.txt::EXPORT_NAME
Definition: XPMP2.h:169
-
XPMP2::GlobVars::bSoundOnStartup
bool bSoundOnStartup
Config: Start Sound on startup?
Definition: XPMP2.h:231
+
XPMP2::GlobVars::bSoundOnStartup
bool bSoundOnStartup
Config: Start Sound on startup?
Definition: XPMP2.h:235
XPMP2::GlobVars::pathDoc8643
std::string pathDoc8643
Path to Doc8643.txt file.
Definition: XPMP2.h:160
XPMP2::GlobVars::bObjReplTextures
bool bObjReplTextures
Replace textures in .obj files on load if needed?
Definition: XPMP2.h:143
-
XPMP2::GlobVars::remoteTTL
int remoteTTL
Time-to-live, or mumber of hops for a multicast message.
Definition: XPMP2.h:208
+
XPMP2::GlobVars::remoteTTL
int remoteTTL
Time-to-live, or mumber of hops for a multicast message.
Definition: XPMP2.h:212
XPMP2::XPMPPlaneNotifierTy
Stores the function and refcon pointer for plane creation/destrcution notifications.
Definition: XPMP2.h:111
XPMP2::XPMPPlaneNotifierTy::operator==
bool operator==(const XPMPPlaneNotifierTy &o)
Definition: XPMP2.h:118
XPMP2::XPMPPlaneNotifierTy::func
XPMPPlaneNotifier_f func
Definition: XPMP2.h:112
diff --git a/docs/html/XPMPAircraft_8h_source.html b/docs/html/XPMPAircraft_8h_source.html index 624de5c..3cc718a 100644 --- a/docs/html/XPMPAircraft_8h_source.html +++ b/docs/html/XPMPAircraft_8h_source.html @@ -780,9 +780,9 @@
XPMP2::CSLModel
Represents a CSL model as it is saved on disk.
Definition: CSLModels.h:113
XPMP2::XPMP2Error
XPMP2 Exception class, e.g. thrown if there are no CSL models or duplicate modeS_ids when creating an...
Definition: XPMPAircraft.h:803
XPMP2::XPMP2Error::fileName
std::string fileName
filename of the line of code where exception occurred
Definition: XPMPAircraft.h:805
-
XPMP2::XPMP2Error::what
virtual const char * what() const noexcept
returns msg.c_str()
Definition: Utilities.cpp:794
+
XPMP2::XPMP2Error::what
virtual const char * what() const noexcept
returns msg.c_str()
Definition: Utilities.cpp:795
XPMP2::XPMP2Error::msg
std::string msg
additional text message
Definition: XPMPAircraft.h:808
-
XPMP2::XPMP2Error::XPMP2Error
XPMP2Error(const char *szFile, int ln, const char *szFunc, const char *szMsg,...)
Constructor puts together a formatted exception text.
Definition: Utilities.cpp:779
+
XPMP2::XPMP2Error::XPMP2Error
XPMP2Error(const char *szFile, int ln, const char *szFunc, const char *szMsg,...)
Constructor puts together a formatted exception text.
Definition: Utilities.cpp:780
XPMP2::XPMP2Error::funcName
std::string funcName
function of the line of code where exception occurred
Definition: XPMPAircraft.h:807
XPMP2::XPMP2Error::ln
int ln
line number of the line of code where exception occurred
Definition: XPMPAircraft.h:806
XPMP2
Definition: XPMPAircraft.h:70
diff --git a/docs/html/XPMPRemote_8h_source.html b/docs/html/XPMPRemote_8h_source.html index bf8655a..3c6cc27 100644 --- a/docs/html/XPMPRemote_8h_source.html +++ b/docs/html/XPMPRemote_8h_source.html @@ -405,8 +405,8 @@
XPMP2::RMT_VER_SETTINGS
constexpr std::uint8_t RMT_VER_SETTINGS
Setttings message version number.
Definition: XPMPRemote.h:152
XPMP2::RMT_VER_AC_ANIM
constexpr std::uint8_t RMT_VER_AC_ANIM
A/C Position update message version number.
Definition: XPMPRemote.h:326
XPMP2::RMT_VER_AC_REMOVE
constexpr std::uint8_t RMT_VER_AC_REMOVE
A/C removal message version number.
Definition: XPMPRemote.h:372
-
XPMP2::RemoteGetStatus
RemoteStatusTy RemoteGetStatus()
Returns the current Remote status.
Definition: Remote.cpp:1143
-
XPMP2::RemoteRecvStop
void RemoteRecvStop()
Stops the receiver.
Definition: Remote.cpp:1408
+
XPMP2::RemoteGetStatus
RemoteStatusTy RemoteGetStatus()
Returns the current Remote status.
Definition: Remote.cpp:1145
+
XPMP2::RemoteRecvStop
void RemoteRecvStop()
Stops the receiver.
Definition: Remote.cpp:1410
XPMP2::RemoteMsgTy
RemoteMsgTy
Message type.
Definition: XPMPRemote.h:77
XPMP2::RMT_MSG_AC_REMOVE
@ RMT_MSG_AC_REMOVE
aircraft is removed
Definition: XPMPRemote.h:84
XPMP2::RMT_MSG_AC_ANIM
@ RMT_MSG_AC_ANIM
aircraft animation values (dataRef values) only
Definition: XPMPRemote.h:83
@@ -430,7 +430,7 @@
XPMP2::REMOTE_TIME_RES
constexpr float REMOTE_TIME_RES
resolution of time difference
Definition: XPMPRemote.h:271
XPMP2::REMOTE_MAX_DIFF_ALT_FT
constexpr double REMOTE_MAX_DIFF_ALT_FT
maximum altitude[ft] difference that can be represented in a pos update msg
Definition: XPMPRemote.h:270
XPMP2::REMOTE_SEND_SETTINGS_INTVL
constexpr int REMOTE_SEND_SETTINGS_INTVL
How often to send settings? [s].
Definition: XPMPRemote.h:149
-
XPMP2::PJWHash16
std::uint16_t PJWHash16(const char *s)
Produces a reproducible(!) hash value for strings.
Definition: Utilities.cpp:616
+
XPMP2::PJWHash16
std::uint16_t PJWHash16(const char *s)
Produces a reproducible(!) hash value for strings.
Definition: Utilities.cpp:617
XPMP2::RMT_VER_AC_DETAIL_2
constexpr std::uint8_t RMT_VER_AC_DETAIL_2
Definition: XPMPRemote.h:180
XPMP2::PACKED
struct XPMP2::RemoteMsgBaseTy PACKED
XPMP2::DR_VALS
DR_VALS
The dataRefs provided by XPMP2 to the CSL models.
Definition: XPMPAircraft.h:87
@@ -440,7 +440,7 @@
XPMP2::REMOTE_SIGNATURE
constexpr const char * REMOTE_SIGNATURE
The signature of the XPMP2 Remote Client.
Definition: XPMPRemote.h:42
XPMP2::REMOTE_MAX_DIFF_DEGREE
constexpr double REMOTE_MAX_DIFF_DEGREE
maximum degree difference that can be represented in a pos update msg
Definition: XPMPRemote.h:268
XPMP2::RMT_VER_AC_POS_UPDATE
constexpr std::uint8_t RMT_VER_AC_POS_UPDATE
A/C Position update message version number.
Definition: XPMPRemote.h:264
-
XPMP2::RemoteRecvStart
void RemoteRecvStart(const RemoteCBFctTy &_rmtCBFcts)
Starts the listener, will call provided callback functions with received messages.
Definition: Remote.cpp:1401
+
XPMP2::RemoteRecvStart
void RemoteRecvStart(const RemoteCBFctTy &_rmtCBFcts)
Starts the listener, will call provided callback functions with received messages.
Definition: Remote.cpp:1403
XPMP2::RemoteAcAnimTy
A/C animation dataRef changes.
Definition: XPMPRemote.h:333
XPMP2::RemoteAcAnimTy::DataRefValTy::idx
DR_VALS idx
index into XPMP2::Aircraft::v
Definition: XPMPRemote.h:340
XPMP2::RemoteAcAnimTy::DataRefValTy::v
std::uint8_t v
dataRef animation value
Definition: XPMPRemote.h:341
diff --git a/docs/html/classXPMP2_1_1UDPMulticast-members.html b/docs/html/classXPMP2_1_1UDPMulticast-members.html index 51ae10e..3d77733 100644 --- a/docs/html/classXPMP2_1_1UDPMulticast-members.html +++ b/docs/html/classXPMP2_1_1UDPMulticast-members.html @@ -72,7 +72,7 @@ IsIPv4() constXPMP2::UDPMulticastinline IsIPv6() constXPMP2::UDPMulticastinline isOpen() constXPMP2::SocketNetworkinginline - Join(const std::string &_multicastAddr, int _port, int _ttl=8, size_t _bufSize=512, unsigned _timeOut_ms=0)XPMP2::UDPMulticast + Join(const std::string &_multicastAddr, int _port, const std::string &_sendIntf, int _ttl=8, size_t _bufSize=512, unsigned _timeOut_ms=0)XPMP2::UDPMulticast mapSenderXPMP2::UDPMulticastprotected multicastAddrXPMP2::UDPMulticastprotected oneIntfIdxXPMP2::UDPMulticastprotected @@ -92,7 +92,7 @@ SocketNetworking(const std::string &_addr, int _port, size_t _bufSize=512, unsigned _timeOut_ms=0, bool _bBroadcast=false)XPMP2::SocketNetworking timedRecv(int max_wait_ms)XPMP2::SocketNetworking UDPMulticast()XPMP2::UDPMulticastinline - UDPMulticast(const std::string &_multicastAddr, int _port, int _ttl=8, size_t _bufSize=512, unsigned _timeOut_ms=0)XPMP2::UDPMulticast + UDPMulticast(const std::string &_multicastAddr, int _port, const std::string &_sendIntf, int _ttl=8, size_t _bufSize=512, unsigned _timeOut_ms=0)XPMP2::UDPMulticast ~SocketNetworking()XPMP2::SocketNetworkingvirtual ~UDPMulticast()XPMP2::UDPMulticastvirtual diff --git a/docs/html/classXPMP2_1_1UDPMulticast.html b/docs/html/classXPMP2_1_1UDPMulticast.html index e5f5663..06f3df4 100644 --- a/docs/html/classXPMP2_1_1UDPMulticast.html +++ b/docs/html/classXPMP2_1_1UDPMulticast.html @@ -74,18 +74,18 @@  UDPMulticast ()  Default constructor is not doing anything. More...
  - UDPMulticast (const std::string &_multicastAddr, int _port, int _ttl=8, size_t _bufSize=512, unsigned _timeOut_ms=0) - Constructor creates a socket and binds it to INADDR_ANY and connects to the given multicast address. More...
-  + UDPMulticast (const std::string &_multicastAddr, int _port, const std::string &_sendIntf, int _ttl=8, size_t _bufSize=512, unsigned _timeOut_ms=0) + Constructor creates a socket and binds it to INADDR_ANY and connects to the given multicast address. More...
+  virtual ~UDPMulticast ()  makes sure pMCAddr is cleared up More...
  const std::string & GetMCAddr () const  Return formatted multicast address, including port. More...
  -void Join (const std::string &_multicastAddr, int _port, int _ttl=8, size_t _bufSize=512, unsigned _timeOut_ms=0) - Connect to the multicast group. More...
-  +void Join (const std::string &_multicastAddr, int _port, const std::string &_sendIntf, int _ttl=8, size_t _bufSize=512, unsigned _timeOut_ms=0) + Connect to the multicast group. More...
+  uint8_t GetFamily () const  Protocol family. More...
  @@ -249,8 +249,8 @@

-

◆ UDPMulticast() [2/2]

+ +

◆ UDPMulticast() [2/2]

@@ -267,6 +267,12 @@

int  _port, + + + + const std::string &  + _sendIntf, + @@ -489,8 +495,8 @@

-

◆ Join()

+ +

◆ Join()

@@ -507,6 +513,12 @@

int  _port, + + + + const std::string &  + _sendIntf, + diff --git a/docs/html/functions_func_j.html b/docs/html/functions_func_j.html index fea2bc6..23013d5 100644 --- a/docs/html/functions_func_j.html +++ b/docs/html/functions_func_j.html @@ -43,7 +43,7 @@

- j -

diff --git a/docs/html/functions_func_l.html b/docs/html/functions_func_l.html index 52e7093..4531416 100644 --- a/docs/html/functions_func_l.html +++ b/docs/html/functions_func_l.html @@ -60,7 +60,7 @@

- l -

diff --git a/docs/html/functions_l.html b/docs/html/functions_l.html index e251fe4..680238b 100644 --- a/docs/html/functions_l.html +++ b/docs/html/functions_l.html @@ -123,7 +123,7 @@

- l -

+ +

Use auto-discovery for the MC send interface?

+
@@ -1386,6 +1419,22 @@

+

◆ remoteSendIntf

+ +
+
+ + + + +
std::string XPMP2::GlobVars::remoteSendIntf
+
+ +

The interface used to send multicast on. (Empty == auto-discovery)

+
diff --git a/docs/html/structXPMP2_1_1LocalIntfAddrTy-members.html b/docs/html/structXPMP2_1_1LocalIntfAddrTy-members.html index 1b2475f..f7d0de9 100644 --- a/docs/html/structXPMP2_1_1LocalIntfAddrTy-members.html +++ b/docs/html/structXPMP2_1_1LocalIntfAddrTy-members.html @@ -55,11 +55,12 @@ flagsXPMP2::LocalIntfAddrTy intfIdxXPMP2::LocalIntfAddrTy intfNameXPMP2::LocalIntfAddrTy - LocalIntfAddrTy(const char *_intfName, const sockaddr *sa, uint32_t _flags)XPMP2::LocalIntfAddrTyinline - LocalIntfAddrTy(const char *_intfName, uint32_t _idx, const sockaddr *sa, uint32_t _flags)XPMP2::LocalIntfAddrTyinline - operator<(const LocalIntfAddrTy &o) constXPMP2::LocalIntfAddrTyinline - operator==(const LocalIntfAddrTy &o) constXPMP2::LocalIntfAddrTyinline - operator==(const InetAddrTy &ia) constXPMP2::LocalIntfAddrTyinline + LocalIntfAddrTy()XPMP2::LocalIntfAddrTyinline + LocalIntfAddrTy(const char *_intfName, const sockaddr *sa, uint32_t _flags)XPMP2::LocalIntfAddrTyinline + LocalIntfAddrTy(const char *_intfName, uint32_t _idx, const sockaddr *sa, uint32_t _flags)XPMP2::LocalIntfAddrTyinline + operator<(const LocalIntfAddrTy &o) constXPMP2::LocalIntfAddrTyinline + operator==(const LocalIntfAddrTy &o) constXPMP2::LocalIntfAddrTyinline + operator==(const InetAddrTy &ia) constXPMP2::LocalIntfAddrTyinline
diff --git a/docs/html/structXPMP2_1_1LocalIntfAddrTy.html b/docs/html/structXPMP2_1_1LocalIntfAddrTy.html index 213357b..a2166c8 100644 --- a/docs/html/structXPMP2_1_1LocalIntfAddrTy.html +++ b/docs/html/structXPMP2_1_1LocalIntfAddrTy.html @@ -57,6 +57,9 @@ + + + @@ -94,8 +97,35 @@

Detailed Description

Stores information about local interface addresses.

Constructor & Destructor Documentation

+ +

◆ LocalIntfAddrTy() [1/3]

+ +
+
+

Public Member Functions

 LocalIntfAddrTy ()
 Standard constructor keeps all empty/invalid. More...
 
 LocalIntfAddrTy (const char *_intfName, const sockaddr *sa, uint32_t _flags)
 Constructor looks up interface idx from its name. More...
 
+ + + + +
+ + + + + + + +
XPMP2::LocalIntfAddrTy::LocalIntfAddrTy ()
+ 		+inline
+
+ +

Standard constructor keeps all empty/invalid.

+ +
+ -

◆ LocalIntfAddrTy() [1/2]

+

◆ LocalIntfAddrTy() [2/3]

@@ -139,7 +169,7 @@

-

◆ LocalIntfAddrTy() [2/2]

+

◆ LocalIntfAddrTy() [3/3]

diff --git a/src/Network.cpp b/src/Network.cpp index f280cea..b8579bb 100755 --- a/src/Network.cpp +++ b/src/Network.cpp @@ -64,6 +64,9 @@ struct LocalIntfAddrTy InetAddrTy addr; ///< address, internally this is in_addr or in6_addr uint8_t family = 0; ///< either `AF_INET` or `AF_INET6` uint32_t flags = 0; ///< stuff like `IFF_MULTICAST`, `IFF_LOOPBACK`, `IFF_BROADCAST`... + + /// Standard constructor keeps all empty/invalid + LocalIntfAddrTy () {} /// Constructor looks up interface idx from its name LocalIntfAddrTy (const char* _intfName, @@ -127,6 +130,46 @@ std::string _NetwGetIntfName (uint32_t idx, uint8_t family) return intfName; } +/// Find a matching local interface based on name and family +LocalIntfAddrTy _NetwFindLocalIntf (const std::string& intf, uint8_t family) +{ + if (!intf.empty()) { + // a string full of digits? -> use as index + uint32_t idx = 0; + if (std::all_of(intf.begin(), intf.end(), ::isdigit)) + idx = (uint32_t)std::stol(intf); + + // Search our list of interfaces either by intf idx or by its name + // On Windows, that can stores differing intfIdx for IPv4 vs IPv6. + std::lock_guard lock(mtxAddrLocal); + SetLocalIntfAddrTy::const_iterator i = + std::find_if(gAddrLocal.begin(), gAddrLocal.end(), + [intf,idx,family](const LocalIntfAddrTy& a) + { return a.family == family && (idx ? a.intfIdx == idx : a.intfName == intf); }); + if (i != gAddrLocal.end()) + return *i; + } + + return LocalIntfAddrTy(); +} + +/// Return list of interface names of given family +std::string _NetwGetInterfaceNames (uint8_t family) +{ + std::string ret, prev; + ret.reserve(gAddrLocal.size() * 15); // Windows can use rather lengthy names... + + std::lock_guard lock(mtxAddrLocal); + for (const LocalIntfAddrTy& a: gAddrLocal) + { + if (a.family != family) continue; // skip wrong family + if (a.intfName == prev) continue; // same interface may appear several times, add only once + if (!ret.empty()) ret += ','; + ret += (prev = a.intfName); + } + return ret; +} + /// Fetch all local addresses and cache locally void _NetwGetLocalAddresses (bool bForceRefresh = false) { @@ -276,7 +319,7 @@ uint32_t GetIntfNext (SetLocalIntfAddrTy::const_iterator& i, uint8_t family, // Constructor copies given socket info SockAddrTy::SockAddrTy (const sockaddr* pSa) { - memset(this, 0, sizeof(SockAddrTy)); + memset((void*)this, 0, sizeof(SockAddrTy)); if (pSa) { switch (pSa->sa_family) { case AF_INET: @@ -742,11 +785,12 @@ void UDPReceiver::GetAddrHints (struct addrinfo& hints) // // Constructor -UDPMulticast::UDPMulticast(const std::string& _multicastAddr, int _port, int _ttl, - size_t _bufSize, unsigned _timeOut_ms) : +UDPMulticast::UDPMulticast(const std::string& _multicastAddr, int _port, + const std::string& _sendIntf, + int _ttl, size_t _bufSize, unsigned _timeOut_ms) : SocketNetworking() { - Join(_multicastAddr, _port, _ttl, _bufSize, _timeOut_ms); + Join(_multicastAddr, _port, _sendIntf, _ttl, _bufSize, _timeOut_ms); } // makes sure pMCAddr is cleared up @@ -756,8 +800,9 @@ UDPMulticast::~UDPMulticast() } // Connect to the multicast group -void UDPMulticast::Join (const std::string& _multicastAddr, int _port, int _ttl, - size_t _bufSize, unsigned _timeOut_ms) +void UDPMulticast::Join (const std::string& _multicastAddr, int _port, + const std::string& _sendIntf, + int _ttl, size_t _bufSize, unsigned _timeOut_ms) { // Already connected? -> disconnect first if (isOpen()) @@ -779,24 +824,23 @@ void UDPMulticast::Join (const std::string& _multicastAddr, int _port, int _ttl, throw NetRuntimeError ("No address info found for " + _multicastAddr); if (pMCAddr->ai_family != AF_INET && pMCAddr->ai_family != AF_INET6) throw NetRuntimeError ("Multicast address " + _multicastAddr + " was not resolved as IPv4 or IPv6 address but as " + std::to_string(pMCAddr->ai_family)); - hints.ai_family = pMCAddr->ai_family; // fill our string with a nicely formatted string multicastAddr = GetAddrString(pMCAddr->ai_addr); // Make sure all local addresses are known, are needed during the MC send process + std::lock_guard lock(mtxAddrLocal); _NetwGetLocalAddresses(true); + // If configured, lookup a specific interface (address) to send from and join only + const LocalIntfAddrTy sendIntf = _NetwFindLocalIntf(_sendIntf, GetFamily()); + if (!_sendIntf.empty() && !sendIntf.intfIdx) { + LOG_MSG(logERR, "MC %s: Configured remoteSendIntf '%s' not found! Available interfaces are: %s", + GetMCAddr().c_str(), _sendIntf.c_str(), _NetwGetInterfaceNames(GetFamily()).c_str()); + } // open the socket Open("", _port, _bufSize, _timeOut_ms); - // Have address info ready for the "any" interface - struct addrinfo* pAnyAddrInfo = nullptr; - hints.ai_flags |= AI_PASSIVE; - if (getaddrinfo(nullptr, "0", &hints, &pAnyAddrInfo) != 0) - throw NetRuntimeError ("getaddrinfo failed for NULL address"); - - // Actually join the multicast group if (IsIPv4()) { @@ -804,7 +848,12 @@ void UDPMulticast::Join (const std::string& _multicastAddr, int _port, int _ttl, const int on = 1; ip_mreq mreqv4 = {}; mreqv4.imr_multiaddr.s_addr = ((sockaddr_in*)pMCAddr->ai_addr)->sin_addr.s_addr; - mreqv4.imr_interface.s_addr = in_addr{INADDR_ANY}.s_addr; + + if (sendIntf.intfIdx) // if specific interface given then only read from there + mreqv4.imr_interface.s_addr = sendIntf.addr.in_addr.s_addr; + else // otherwise read from any + mreqv4.imr_interface.s_addr = in_addr{INADDR_ANY}.s_addr; + if (setsockopt(f_socket, IPPROTO_IP, IP_ADD_MEMBERSHIP, (const char*) &mreqv4, sizeof(mreqv4)) < 0) throw NetRuntimeError ("setsockopt(IP_ADD_MEMBERSHIP) failed"); if (setsockopt(f_socket, IPPROTO_IP, IP_MULTICAST_TTL, (char*)&_ttl, sizeof(_ttl)) < 0) @@ -832,6 +881,10 @@ void UDPMulticast::Join (const std::string& _multicastAddr, int _port, int _ttl, mreqv6.ipv6mr_interface > 0; mreqv6.ipv6mr_interface = GetIntfNext(i, AF_INET6, IFF_MULTICAST)) { + // If a single interface is configured then we only joing on that interface + if (sendIntf.intfIdx && sendIntf.intfIdx != mreqv6.ipv6mr_interface) + continue; + if (setsockopt(f_socket, IPPROTO_IPV6, IPV6_JOIN_GROUP, (const char*) &mreqv6, sizeof(mreqv6)) < 0) { char sErr[SERR_LEN]; strerror_s(sErr, sizeof(sErr), errno); @@ -847,8 +900,9 @@ void UDPMulticast::Join (const std::string& _multicastAddr, int _port, int _ttl, throw NetRuntimeError ("setsockopt(IPV6_JOIN_GROUP) failed for all interfaces!"); } - // free local address info - freeaddrinfo(pAnyAddrInfo); + // If a sending interface is given let's set it + if (sendIntf.intfIdx) + SendToIntf(sendIntf.intfIdx); } // Send future datagrams on default interfaces only (default) diff --git a/src/Network.h b/src/Network.h index 8e6d607..56a9576 100755 --- a/src/Network.h +++ b/src/Network.h @@ -59,7 +59,7 @@ struct SockAddrTy }; /// Constructor zeroes out everying - SockAddrTy() { memset(this, 0, sizeof(SockAddrTy)); } + SockAddrTy() { memset((void*)this, 0, sizeof(SockAddrTy)); } /// Constructor copies given socket info SockAddrTy (const sockaddr* pSa); @@ -207,8 +207,9 @@ class UDPMulticast : public SocketNetworking /// Default constructor is not doing anything UDPMulticast() : SocketNetworking() {} /// @brief Constructor creates a socket and binds it to INADDR_ANY and connects to the given multicast address - UDPMulticast(const std::string& _multicastAddr, int _port, int _ttl=8, - size_t _bufSize = 512, unsigned _timeOut_ms = 0); + UDPMulticast(const std::string& _multicastAddr, int _port, + const std::string& _sendIntf, + int _ttl=8, size_t _bufSize = 512, unsigned _timeOut_ms = 0); /// makes sure pMCAddr is cleared up virtual ~UDPMulticast(); @@ -217,8 +218,9 @@ class UDPMulticast : public SocketNetworking /// @brief Connect to the multicast group /// @exception XPMP2::NetRuntimeError in case of any errors - void Join (const std::string& _multicastAddr, int _port, int _ttl=8, - size_t _bufSize = 512, unsigned _timeOut_ms = 0); + void Join (const std::string& _multicastAddr, int _port, + const std::string& _sendIntf, + int _ttl=8, size_t _bufSize = 512, unsigned _timeOut_ms = 0); /// Protocol family uint8_t GetFamily () const { return pMCAddr ? (uint8_t)pMCAddr->ai_family : AF_UNSPEC; } diff --git a/src/Remote.cpp b/src/Remote.cpp index f7942bd..39002f4 100755 --- a/src/Remote.cpp +++ b/src/Remote.cpp @@ -642,6 +642,7 @@ void RmtSendLoop () bool bChangeIntf = std::chrono::steady_clock::now() - tpIntfSwitch > std::chrono::seconds(REMOTE_RECV_BEACON_INTVL/2); bool bIntfChanged = false; std::string from; + if (glob.remoteAutoDiscovery()) bChangeIntf = false; // Loop makes sure we read everything, maybe there's a new interface in there somewhere while (gpMc->RecvMC(bChangeIntf, &from, nullptr, &bIntfChanged) > 0) { @@ -692,7 +693,8 @@ void RmtSendMain() glob.remoteStatus = REMOTE_SEND_WAITING; // Create a multicast socket and listen if there is any traffic in our multicast group - gpMc->Join(glob.remoteMCGroup, glob.remotePort, glob.remoteTTL,glob.remoteBufSize); + gpMc->Join(glob.remoteMCGroup, glob.remotePort, glob.remoteSendIntf, + glob.remoteTTL, glob.remoteBufSize); int maxSock = (int)gpMc->getSocket() + 1; #if APL == 1 || LIN == 1 // the self-pipe to shut down the TCP socket gracefully @@ -839,7 +841,8 @@ void RmtRecvMain() glob.remoteStatus = REMOTE_RECV_WAITING; // Create a multicast socket - gpMc->Join(glob.remoteMCGroup, glob.remotePort, glob.remoteTTL,glob.remoteBufSize); + gpMc->Join(glob.remoteMCGroup, glob.remotePort, glob.remoteSendIntf, + glob.remoteTTL, glob.remoteBufSize); int maxSock = (int)gpMc->getSocket() + 1; #if APL == 1 || LIN == 1 // the self-pipe to shut down the TCP socket gracefully @@ -850,7 +853,6 @@ void RmtRecvMain() #endif // Send out a first Interest Beacon - gpMc->SendToAll(); RmtSendBeacon(); // *** Main listening loop *** diff --git a/src/Utilities.cpp b/src/Utilities.cpp index 0bb360b..cf17dcd 100755 --- a/src/Utilities.cpp +++ b/src/Utilities.cpp @@ -126,6 +126,7 @@ void GlobVars::ReadConfigFile () } else if (ln[0] == "remoteMCGroup") remoteMCGroup = ln[1]; else if (ln[0] == "remotePort") remotePort = iVal; + else if (ln[0] == "remoteSendIntf") remoteSendIntf = ln[1]; else if (ln[0] == "remoteTTL") remoteTTL = iVal; else if (ln[0] == "remoteBufSize") remoteBufSize = (size_t)iVal; else if (ln[0] == "remoteTxfFrequ") remoteTxfFrequ = iVal; diff --git a/src/XPMP2.h b/src/XPMP2.h index f4bad44..52615f2 100755 --- a/src/XPMP2.h +++ b/src/XPMP2.h @@ -204,6 +204,10 @@ struct GlobVars { std::string remoteMCGroup = "239.255.1.1"; // for IPv6 try "FF02::1" /// The port we use is _different_ from the port the X-Plane BEACON uses, so we don't get into conflict int remotePort = 49788; + /// The interface used to send multicast on. (Empty == auto-discovery) + std::string remoteSendIntf; + /// Use auto-discovery for the MC send interface? + bool remoteAutoDiscovery() const { return remoteSendIntf.empty(); } /// Time-to-live, or mumber of hops for a multicast message int remoteTTL = 8; /// Buffer size, ie. max message length we send over multicast