bright, fresh software
Downloads  |  Buy

Using TurboFloat with C#

Before you can do anything you need to login to your LimeLM account (or sign up). Then download TurboFloat for Windows on your API page.

Adding floating licensing to your appTurboActivate.dat and Version GUID

After you've created a new product, go to the version page of the product you will be adding licensing to. You will need to do 2 things:

  1. Download the TurboActivate.dat file for the product version.
  2. Make a note of the Version GUID.

You'll be including the TurboActivate.dat file in the same folder as the TurboFloat.dll file and you'll use the Version GUID in your code as part of integrating TurboFloat within your app.

Choose Platform Target (AnyCPU, x86, x64)

For C# projects we recommend you set the "Platform target" to x86. If you do this, your app will be able to run on both 32-bit and 64-bit machines without having to do complex installation scripts.

To set the target platform to x86 first click the "Project -> [Project Name] Properties" menu in Visual Studio. Click the "Build" tab on the right hand side. Then choose x86 from the "Platform target" dropdown:

Target platform x86

Make sure you set this for both your "Release" and "Debug" configurations.

AnyCPU platform target

If instead of the x86 platform target you would rather choose the AnyCPU platform target then you need to make a few changes. The first thing you need to do add a "conditional compilation symbol" named TF_BOTH_DLL (do this for both Debug and Release builds). Then you need to include both the x86 and x64 versions of TurboFloat with your binaries. So copy the TurboFloat.dll from the x86 folder and put it in the Debug & Release folders. In the x64 folder rename TurboFloat.dll to "TurboFloat64.dll".

Example project

Included in TurboFloat Library package is a simple example project. The TurboFloat.cs file contains all the functions you'll be using to add the floating licenses functionality to your app.

Step-by-step walkthrough

We're going to walk you through adding floating licensing to your app by using our C# example application. If you haven't downloaded it already you can get the example app inside the TurboFloat Library package.

Step 1. Install the TurboFloat Server

Before you can continue you need to install the TurboFloat Server for your app or run it from commandline. If you're just testing things out then you can install it on your development machine.

Step 2. Request "license lease"

In the example "Text Editor" C# application the "Form1.cs" file is the main UI for the app. That is, it's the entry point for the application. And because it's the entry point of the application it's where we'll be requesting the "license lease" from the TurboFloat Server.

First, create the TurboFloat instance as a private member in the class:

public partial class Form1 : Form
{
    TurboFloat tf;

Then, in the constructor for the form, you'll actually create the new instance of the TurboFloat class. Paste the Version GUID you copied from earlier:

public Form1()
{
    InitializeComponent();

    try
    {
        //TODO: goto the version page at LimeLM and paste this GUID here
        tf = new TurboFloat("PASTE-VERSION-GUID-HERE");
    }
    catch (TurboFloatException ex)
    {
        MessageBox.Show("Failed to get a lease from the floating license server: " + ex.Message);
        Close();
        return;
    }

Next, we'll actually request the lease from the TurboFloat Server:

try
{
    //TODO: goto the version page at LimeLM and paste this GUID here
    tf = new TurboFloat("PASTE-VERSION-GUID-HERE");

    tf.RequestLease();
}

Step 3. Handle the "LeaseChange" event

The native TurboFloat library handles all the details about renewing leases, retrying, etc. All you have to do is handle the cases where TurboFloat talks to your app and tells it something has changed (license lease failing to be renewed or new license field data). To do this you need to handle the LeaseChange event. Here we add a new event handler before we request a lease:

try
{
    //TODO: goto the version page at LimeLM and paste this GUID here
    tf = new TurboFloat("PASTE-VERSION-GUID-HERE");

    tf.LeaseChange += TurboFloat_LeaseChange;
    tf.RequestLease();
}

Then, add the "TurboFloat_LeaseChange()" function to handle notifications from the TurboFloat library:

void TurboFloat_LeaseChange(object sender, StatusArgs e)
{
    if (e.Status == TF_LeaseStatus.TF_CB_FEATURES_CHANGED)
    {
        //TODO: if you're using feature values in your app
        //      you might want to reload them now.
    }
    else // TF_CB_EXPIRED, TF_CB_EXPIRED_INET, and everything else
    {
        // Immediately disable the app and/or show a modal
        // form that gives the user the option to Save /
        // Save As the data (if applicable) and let the
        // user re-try connecting to the server.

        this.Enabled = false;

        //Note: Don't just close your app. Your users will be
        //      rightfully ticked-off if you do something like that.

        // Instead, we're showing a modal dialog that lets the
        // user try to get a new lease from the server. Or,
        // if they can't, then save their data.

        LeaseExpired frmLeaseExp = new LeaseExpired(tf);
        if (frmLeaseExp.ShowDialog(this) == DialogResult.Cancel)
        {
            // close the app
            Close();
            return;
        }

        // We've gotten a new lease, so re-enable the app.
        this.Enabled = true;
    }
}

Step 4. Finishing touches

Included in the example C# app are 3 forms that you might want to copy to your own application:

  1. LeaseExpired.cs: a form to show if the license lease has expired.

    Lease expired

  2. frmInternetErr.cs: a form to show if there's an internet error (that is, a server is specified, but your app couldn't connect to the server).

    Internet error

  3. ServerConfig.cs: a form to allow the end-user to enter details about where their TurboFloat Server is located.

    Config TurboFloat Server location

You've already seen example usage of the LeaseExpired form in the TurboFloat_LeaseChange() function. Here's an example usage of the ServerConfig and frmInternetErr forms. Its logic is fairly simple. First it tries to get a lease, and if that fails then it prompts the user for action:

try
{
    //TODO: goto the version page at LimeLM and paste this GUID here
    tf = new TurboFloat("PASTE-VERSION-GUID-HERE");

    tf.LeaseChange += TurboFloat_LeaseChange;
    tf.RequestLease();
}
catch (ServerException)
{
    ServerConfig srvConf = new ServerConfig(tf);
    if (srvConf.ShowDialog(this) != DialogResult.OK)
    {
        MessageBox.Show("You must specify the location of the floating license server to run YourApp.");
        Close();
        return;
    }
}
catch (TurboFloatException ex)
{
    // Give the user an option to try another server if they
    // couldn't connect to the first one, or if the first one
    // is for a different product.
    if (ex is wyDay.TF.InternetException
        || ex is WrongServerProductException
        || ex is UsernameNotAllowedException)
    {
        frmInternetErr inetErr = new frmInternetErr(tf);
        if (inetErr.ShowDialog(this) != DialogResult.OK)
        {
            // exit the app on failure
            Close();
            return;
        }
    }
    else
    {
        MessageBox.Show("Failed to get a lease from the floating license server: " + ex.Message);
        Close();
        return;
    }
}

Step 5. Dropping the lease when your app closes

After you've successfully requested a lease from the TurboFloat Server, the TurboFloat library integrated in your app takes care of renewing the leases automatically and silently. You'll only ever get a notification of something going wrong in the handler for the LeaseChange event that we covered in Step 3.

When your app is closing you should "drop" the lease using the DropLease() method, and cleanup the memory using the Cleanup() method:

void Form1_FormClosed(object sender, FormClosedEventArgs e)
{
    try
    {
        // Drop the lease
        if (tf.HasLease())
            tf.DropLease();

        // Cleanup memory used by TurboFloat library
        TurboFloat.Cleanup();
    }
    catch (Exception)
    {
        // we're exiting anyway, just let the lease be a zombie.
    }
}

What this does is tell the TurboFloat Server that you're through using the lease in this instance of your app, and another instance of your app on another computer or another session can now use that "free slot".

If you can't drop the lease (because your app can't connect to the internet, or for any other reason), and you choose to exit your app anyway, then the "lease" on the TurboFloat Server will be a "zombie". The lease will expire eventually on the TurboFloat Server, and thus the free slot will open back up.

Step 6: Testing the lease change event

Testing requesting leases, dropping them, and everything else in the TurboFloat Library is intuitive: just call the function and it does the thing you want it to do. Testing the lease change event is, however, slightly less intuitive. Here's how you can test the lease change event:

  1. If your app is open and has a lease, close your app and make sure it drops the license lease from the TurboFloat Server.

  2. Stop the TurboFloat Server instance.

  3. Open the TurboFloat Server config file, and edit <lease .../> element and set it to "30". This will set the lease length to 30 seconds.

  4. Save the changes you made to the configuration file.

  5. Start your TurboFloat Server instance again.

  6. Start your app again, and make sure it successfully gets a license lease from the TurboFloat Server.

  7. Now, stop the TurboFloat Server instance, but leave your app running.

  8. Within the next 30 seconds the lease change event will be called because the TurboFloat Library was not able to renew the license lease automatically.