These are the Support Forums for FSUIPC and related products.

These forums replace the old support forums which have been running for 20+ years. The old forums contain a wealth of information on all FSUIPC products, but are now no longer available.

Please note that you will need to Register and Login to post for support, and also to download attachments. You can view these forums without registering.

Support is also available via Discord. Please use the following invite link to join the FSUIPC Discord server:
https://discord.gg/zjwUTrxmmE

Notifications
Clear all

FSUIPCClientDLL 3.3.16 — Commercial Use, .NET 10 and IPC Retry Behaviour

Posts: 3
Registered
Topic starter
(@xflight)
Joined: 2 weeks ago

Subject: FSUIPCClientDLL 3.3.16 — Commercial Use, .NET 10 and IPC Retry Behaviour

Hello Paul,

I'm developing XFlight Cockpit Profile Studio, a Windows application that allows Microsoft Flight Simulator 2024 users to create and customise Stream Deck profiles for individual aircraft.

The application is being developed with .NET 10 and is intended for commercial distribution as a one-time purchase. It will communicate with MSFS through the local FSUIPC7 IPC interface, without using SimConnect directly. Users would install FSUIPC7 separately.

We are considering FSUIPCClientDLL 3.3.16 and would appreciate your guidance on a few points.

1. Commercial licensing

We understand that the DLL can be distributed royalty-free as part of a commercial application, with the required acknowledgements.

Could you confirm that an end-user Stream Deck profile editor such as ours is covered by this licence and is not considered a developer toolkit?

2. .NET 10 compatibility

Is version 3.3.16 suitable for .NET 10 on Windows, or would you recommend another version?

3. Internal retries and timeouts

Our application needs to handle non-idempotent controls, such as COM frequency swaps, safely.

Does a single Process() call potentially issue multiple IPC notification attempts after a timeout? If so, is there a supported way to disable retries or limit the operation to one notification attempt?

4. Pending operations and recovery

After a timeout or disconnection, can previously queued writes or OnceOnly offsets be processed again during a subsequent Process() call or reconnection?

What is the recommended procedure for safely handling pending operations, buffers and connection recovery after an uncertain result?

5. Isolating an individual command

Our first test involves sending COM_STBY_RADIO_SWAP (66372) through offset 0x3110, with a four-byte payload.

Is there a recommended way to ensure that only this control is submitted, without other pending writes? Also, does Open() perform any diagnostic writes or internal retries?

We understand that exactly-once execution cannot necessarily be guaranteed. Our objective is to prevent unintended retries and accurately distinguish successful transport from an observed simulator response.

Any guidance or references to supported usage patterns would be greatly appreciated.

Thank you for your time and for your work on the FSUIPC .NET client.

Kind regards,

Francesco
XFlight Cockpit Profile Studio


3 Replies
Posts: 8
(@paul-henty)
Joined: 1 year ago

Hi Francesco,

1. An application that allows users to program and use buttons on a Streamdeck is covered by the normal licence. I consider this an end-user application and not a development toolkit.

2. Version 3.3.16 is the latest version and targets .NET8 (specifically net8.0-windows). It will run fine on .NET 10. If you want the DLL to specifically target .NET 10 I can update it for you.

3. Internally (as per the FSUIPC protocol), this client DLL will attempt to send a message to FSUIPC 10 times. If there is no response after 10 attempts the Process() call throws a timeout exception. The internal retries cannot be changed, but the data in the Process() call is only ever sent once per call. A single Process() will never send the same request more than once. The retry means the message never got through.

4. If the Process() call fails because FSUIPC cannot be contacted the connection is closed internally. The offsets and their internal state are preserved. A simple pattern for handling timeouts/disconnections is: Handle the timeout exception from the Process() call -> Start a timer that keeps trying to reopen the connection -> When open again, you can just Process() the offsets or groups again. If an offset has a pending write before the disconnection, it will still have that state when you process() it after reconnection.

5. The grouping system can be used to control when offsets are processed. When offsets are declared they can optionally be placed in a named group. Process() can take one or more group names so that only offsets in the group(s) are processed. Alternatively, offsets can be connected and disconnected by the application. Disconnected offsets retain values but are not processed, even if the group they are in is Processed().

6. Open() should only be called once when the application starts (and after the connection is lost). The application should not be routinely opening and closing the connection. Open() does not write anything to FSUIPC. There are 5 internal retries. If there is no response from FSUIPC an exception is thrown telling you that FSUIPC/WideFS is not running.

FSUIPC uses a synchronous transmission protocol. The DLL calls like Open() and Process() will block when called. When they return they will throw an exception if there was an error (e.g. FSUIPC could not be contacted). If no exception is thrown the call was successful. By handling the exceptions in your code you are in full control of any retry attempts. Internal DLL retries happen during the blocked call. The DLL does not send retries (or do anything) asynchronously.

The DLL is thread safe, so if you want to move the synchronous, blocking calls onto a background thread you can. This will, however, significantly increase the complexity of your application.

Let me know if you need any more information.

Paul


Reply
Posts: 3
Registered
Topic starter
(@xflight)
Joined: 2 weeks ago

Hi Paul,

Thank you very much for your detailed and helpful reply.

Your explanations have clarified several important points for the development of XFlight Cockpit Profile Studio, particularly regarding .NET 10 compatibility, connection recovery, and the handling of pending offset writes.

I also appreciate your clarification about the normal licence covering an end-user Stream Deck application.

Just one final question for future distribution: does the normal licence also allow me to include the FSUIPC Client DLL with the installer of my commercial application, or are there any specific redistribution conditions I should follow?

There is no need for a .NET 10-specific build at this stage, as you have confirmed that version 3.3.16 works with .NET 10.

Thank you again for your time and support.

Best regards,
Francesco
XFlight AI


Reply
Posts: 8
(@paul-henty)
Joined: 1 year ago

does the normal licence also allow me to include the FSUIPC Client DLL with the installer of my commercial application

Yes, you should include the FSUIPC Client DLL in the installer. You can either distribute it as a file alongside your exe, or bundle it inside the exe as a Single-File Application.

Paul


Reply