Added UDP multicast for plugin discovery by JanC · Pull Request #153 · nasa/XPlaneConnect

JanC · 2019-03-02T13:16:57Z

Hi,
as discussed in #147, here is the implementation of the UDP discovery of the plugin.

The format of the UDP packet is:

4 bytes: BECN
1 byte: 0
2 bytes: XPlaneConnect server port e.g. '49009'
4 bytes: X-Plane version e.g. '11260'
null terminated string: XPlaneConnect plugin version e.g. '1.3-rc.1'

The changes are

Use C++11 needed by <thread>
Added a helper Timer class that can run a callback every x milliseconds
Start a timer in XPluginEnable to UDP multicast the BECN packet

Compiles fine on all platforms. I'll provide the binaries once this is reviewed.

What is not part of this pull request are the client side implementations but I believe this can be done separately.

Tested on macOS, Linux and Windows

+ wait for thread to join when stopping the timer

to fix Linux compile error

jason-watkins · 2019-03-07T15:16:21Z

Hi Jan,

Sorry for the late response. The code looks good. While I'm fine with leaving out most of the client stuff, I would like to see at least one test to make sure the code works. If you could at support to one of the clients and add a test for it I would appreciate it.

Thanks,
Jason

JanC · 2019-03-08T13:19:41Z

Hi Jason,
sure, I’ll implement that as well.
Thanks for looking into this

Jan

jason-watkins

I've taken a closer look at the changes and made a few notes. In addition, it looks like spaces and tabs are intermixed inconsistently, which happens to be a pet peave of mine. If you wouldn't mind doing a search/replace to make sure the plugin source is consistent it will save me the trouble.

Once the comments are addressed, I think this is ready to merge.

jason-watkins · 2019-03-13T21:29:17Z

xpcPlugin/MessageHandlers.cpp

 #include <cmath>
 #include <cstring>

+#define MULTICAST_GROUP "239.255.1.1"


Where does this value come from? Is it a good default value that should be baked in? If there was some non-arbitrary reason for this value, let's mention it in a comment

I used the same group (but a different port) as the native X-Plane BECN packet. See this comment #147 (comment) I believe we are free to choose whatever arbitrary multicast group.

jason-watkins · 2019-03-13T21:33:59Z

xpcPlugin/Timer.h

+    class Timer
+    {
+
+        bool running = false;


bool isn't guaranteed to be thread-safe. I think std::atomic_flag would be the most appropriate replacement.

xpcPlugin/Timer.h

jason-watkins · 2019-03-13T21:35:20Z

xpcPlugin/Timer.h

+        bool running = false;
+
+    public:
+        std::thread th;


Does the thread need to be public?

correct. Moved to private

jason-watkins · 2019-03-13T21:35:45Z

xpcPlugin/Timer.h

+
+    public:
+        std::thread th;
+        typedef std::function<void(void)> Callback;


I prefer the C++11 style of using Callback = std::function<void(void)>

nasa/XPlaneConnect#153

* Minor improvements to the handling of landing gear by the SetGear and HandlePOSI functions * sendPOSI command change (double for lat/lon/h) (#111) * Updated POSI to use doubles for lat/lon/alt, as step size for floats was unacceptably large at high longitudes. * Updated Java library for MATLAB, updated Java project, and updated Windows plugin binaries * Rolled back Java version to 1.7 for MATLAB compatibility * Update MessageHandlers.cpp * Update DataManager.cpp * Added pause functionality for individual a/c Adds new cases such that: 0: Unpauses all a/c 1: Pauses all a/c 2: Switches case for all a/c 100:119: Pauses a/c 0:19 200:219: Unpauses a/c 0:19 Updates log messages. Keeps the 0,1,2 arguments as they previously were. * Finished individual pause functionality * Update DataManager.cpp * Updated flags to allow for individual pause commands * Individual pause command documentation * Updated flags to allow for individual pause commands * Adding individual pause to documentation * Updated flags to allow for individual pause commands * Requested changes, cleaning * Update CMakeLists.txt Include "-fno-stack-protector" for linking and compiling for systems that do not have this have this flag as a default. * Enabling AI after setting position (#118) Previously, the code enabled the AI before setting the position of a/c, which negated its purpose. * Updated XPlane SDK to version 2.1.3 * Resolve function ambiguity for std::abs on mac Fixes #126 * Update copyright notice * Update Windows binaries * Update Linux binaries * Update version numbers * fix osx abs ambiguity (#142) * fix indexing error (#143) * Runway camera location control (#144) * update ignore * basics working * set cam pos remotely * log cam position * keep default behaviour, if short view message is received Compatibility with existing software * all to tabs * rename variable * option to use camera direction fields * Added UDP multicast for plugin discovery (#153) * Added Timer * Added UDPSocket::GetAddr * Added MessageHandlers::SendBeacon() * PoC of starting a timer on PluginEnable * C++11 * Added Timer to xcode project * C++11 in cmake * added Timer to cmake * use function pointer in Timer * moved Timer to namespace + wait for thread to join when stopping the timer * Windows: changed uint to unisgned short * Windows: Added Timer.h/cpp to project * GetAddr static * Send xplane and plugin version with BECN * SendBeacon with params * fixed file copyrights * Include functional to fix Linux compile error * review fixes * Send plugin receive port in BECN * review fixes * Fixed tabs vs spaces indentations (#157) * Java client BECN implementation (#155) * Added MS Azure Dev Ops CI integration (#162) * Do not build for i386 on macOS Use ARCHS_STANDARD to avoid the error “The i386 architecture is deprecated. You should update your ARCHS build setting to remove the i386 architecture.” * Fixed missing include The Visual Studio solution was not compiling * Fixed isnan ambigious refernce Ambigious reference when compiling on travis https://stackoverflow.com/questions/33770374/why-is-isnan-ambiguous-and-how-to-avoid-it * Set MSVC warning level to 3 Too many warnings were generated when building a Release build making Travis job to fail because of too much output * Use default toolset for Visual Studio AppVeyor recommends to set the default toolset * #include <cstdint> * Use MSVC ToolsVersion="14.0" # Conflicts: # xpcPlugin/xpcPlugin/xpcPlugin.vcxproj * Removed binaries from repository # Conflicts: # xpcPlugin/XPlaneConnect/64/win.xpl # xpcPlugin/XPlaneConnect/win.xpl * Added ms azure ci xcode linux linux + macos linux + macos removed branch filter win tests win tests Test all platfroms artifacts tests * output all binaries to ‘XPlaneConnect’ All platforms produce a binary in xpcPlugin/XPlaneConnect/ xpcPlugin/XPlaneConnect/64/ * Added ms azure GH deploy deploy stage GH release test trigger tags * Clean up yml file - Added variables - Added job decriptions * Ignore script to ignore .exp files + fixed output path * Renamed ms azure GH connection * Update service connection for azure pipeline * Added Python3 compatible xpc client. (#156) * Update Azure Pipelines service connection

JanC added 17 commits March 2, 2019 14:16

Added Timer

8965fc5

Added UDPSocket::GetAddr

0c03191

Added MessageHandlers::SendBeacon()

6701791

PoC of starting a timer on PluginEnable

997358b

C++11

4b069e4

Added Timer to xcode project

33bf019

C++11 in cmake

6d9c08f

added Timer to cmake

2699972

use function pointer in Timer

0714a41

moved Timer to namespace

dfd6747

+ wait for thread to join when stopping the timer

Windows: changed uint to unisgned short

b7e32c4

Windows: Added Timer.h/cpp to project

87734b9

GetAddr static

e8549e8

Send xplane and plugin version with BECN

c988beb

SendBeacon with params

7368425

fixed file copyrights

7c33233

Include functional

b1e6fb4

to fix Linux compile error

JanC and others added 2 commits March 11, 2019 09:43

review fixes

7e84096

Send plugin receive port in BECN

227438d

JanC mentioned this pull request Mar 13, 2019

Java client BECN implementation #155

Merged

jason-watkins requested changes Mar 13, 2019

View reviewed changes

review fixes

c513a44

jason-watkins approved these changes Mar 14, 2019

View reviewed changes

jason-watkins merged commit 50335c4 into nasa:develop Mar 14, 2019

JanC mentioned this pull request Mar 15, 2019

Fixed tabs vs spaces indentations #157

Merged

JanC added a commit to JanC/XPConnectKit that referenced this pull request Mar 16, 2019

Added XplaneConnect discovery

a57a712

nasa/XPlaneConnect#153

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added UDP multicast for plugin discovery#153

Added UDP multicast for plugin discovery#153
jason-watkins merged 20 commits intonasa:developfrom
JanC:discovery

JanC commented Mar 2, 2019 •

edited

Loading

Uh oh!

jason-watkins commented Mar 7, 2019

Uh oh!

JanC commented Mar 8, 2019

Uh oh!

jason-watkins left a comment

Uh oh!

jason-watkins Mar 13, 2019

Uh oh!

JanC Mar 13, 2019

Uh oh!

jason-watkins Mar 13, 2019

Uh oh!

JanC Mar 13, 2019

Uh oh!

Uh oh!

jason-watkins Mar 13, 2019

Uh oh!

JanC Mar 13, 2019

Uh oh!

jason-watkins Mar 13, 2019

Uh oh!

JanC Mar 13, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

JanC commented Mar 2, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jason-watkins commented Mar 7, 2019

Uh oh!

JanC commented Mar 8, 2019

Uh oh!

jason-watkins left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

JanC commented Mar 2, 2019 •

edited

Loading