Skip to content

Commit

Permalink
GitBook: [master] 17 pages modified
Browse files Browse the repository at this point in the history
  • Loading branch information
@adnan-kamili @gitbook-bot
adnan-kamili authored and gitbook-bot committed Apr 27, 2021
1 parent f2f72cc commit ccfbfeb
Show file tree
Hide file tree
Showing 17 changed files with 55 additions and 82 deletions.
14 changes: 6 additions & 8 deletions ...icenses/using-lexfloatclient/using-lexfloatclient-with-c-c++-and-objective-c.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
First of all, login to your Cryptlex account and download the LexFloatClient library for Windows, macOS, or Linux:

* [Download LexFloatClient for Windows](https://app.cryptlex.com/downloads)
* [Download LexFloatClient for MacOS](https://app.cryptlex.com/downloads)
* [Download LexFloatClient for macOS](https://app.cryptlex.com/downloads)
* [Download LexFloatClient for Linux](https://app.cryptlex.com/downloads)

The above download package contains the library \(shared as well as static\) which you will be using to add licensing to your app.
Expand All @@ -15,18 +15,16 @@ After you've added a product for your app in the dashboard, go to the product pa
* Note the product id for the product.
* Download the example project from [Github](https://github.com/cryptlex/lexfloatclient-c).

Product id is the identifier of your product which is to be used in the code. The product id of the LexFloatServer and LexFloatClient must match.
The product id is the identifier of your product that is to be used in the code. The product id of the LexFloatServer and LexFloatClient must match.

### Adding library to your app
### Adding the library to your app

LexFloatClient example project for C contains the **LexFloatClient.h** header file. In addition to that, it includes the **LexFloatClient.lib** file required in the case of Windows. It contains all the LexFloatClient API functions needed to add licensing to your app.

Depending on the platform you are targeting **\(x86 or x64\)** you need to link the respective LexFloatClient.dll with your application.

LexFloatClient has a dependency on `VS2015` runtime on **Windows**. On the target machines where you will deploy your app, you can install the `VS2015` runtime, if not present, using the link: [https://www.microsoft.com/en-in/download/details.aspx?id=48145](https://www.microsoft.com/en-in/download/details.aspx?id=48145)

LexFloatClient has a dependency on `libnss3` library on **Linux**. On the target machines where you will deploy your app, ensure `libnss3` library is installed.

### Setting product id

The first LexFloatClient API function you need to use in your code is `SetHostProductId()`. It sets the product id of the product you will be adding licensing to.
Expand All @@ -37,7 +35,7 @@ SetHostProductId("PASTE_PRODUCT_ID");
### Requesting floating license
To receive a floating license, you will use `SetHostUrl()`, `SetFloatingLicenseCallback()` and `RequestFloatingLicense()`LexFloatClient API methods. It sets LexFloatServer address, callback for status notifications, contacts the server and receives the floating license.
To receive a floating license, you will use `SetHostUrl()`, `SetFloatingLicenseCallback()` and `RequestFloatingLicense()`LexFloatClient API methods. It sets the LexFloatServer address, the callback for status notifications, contacts the server and receives the floating license.
```c
int status;
Expand Down Expand Up @@ -68,7 +66,7 @@ The above code can be executed every time user starts the app or needs a new lic

### Renewing floating license

License lease automatically renews itself in a background thread. When license is renewed or it fails to renew, Callback is invoked \(from background thread\).
License lease automatically renews itself in a background thread. When a license is renewed or fails to renew, the callback is invoked \(from the background thread\).

```c
void LF_CC LicenceRenewCallback(uint32_t status)
Expand Down Expand Up @@ -112,5 +110,5 @@ The above code should be executed every time user closes the app.

## Need more help

In case you need more help for adding LexFloatClient to your app, we'll be glad to help you make the integration. You can either post your questions on our [support forum](https://forums.cryptlex.com) or can contact us through [email](mailto:[email protected]?Subject=Using%20LexFloatClient).
In case you need more help with adding LexFloatClient to your app, we'll be glad to help you make the integration. You can either post your questions on our [support forum](https://forums.cryptlex.com) or can contact us through [email](mailto:[email protected]?Subject=Using%20LexFloatClient).

12 changes: 5 additions & 7 deletions ...n-premise-floating-licenses/using-lexfloatclient/using-lexfloatclient-with-c.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ After you've added a product for your app in the dashboard, go to the product pa
* Note the product id for the product.
* Download the example project from [Github](https://github.com/cryptlex/lexfloatclient-dotnet/tree/master/examples).

Product id is the identifier of your product which is to be used in the code. The product id of the LexFloatServer and LexFloatClient must match.
The product id is the identifier of your product that is to be used in the code. The product id of the LexFloatServer and LexFloatClient must match.

### Adding library to your app
### Adding the library to your app

LexFloatClient wrapper for C\# can be easily installed through [nuget](https://www.nuget.org/packages/Cryptlex.LexFloatClient):

Expand All @@ -21,8 +21,6 @@ dotnet add package Cryptlex.LexFloatClient

LexFloatClient has a dependency on `VS2015` runtime on **Windows**. On the target machines where you will deploy your app, you can install the `VS2015` runtime, if not present, using the link: [https://www.microsoft.com/en-in/download/details.aspx?id=48145](https://www.microsoft.com/en-in/download/details.aspx?id=48145)

LexFloatClient \(`.NET Core`\) has dependency on `libnss3` library on **Linux**. On the target machines where you will deploy your app, ensure `libnss3` library is installed.

### Setting product id

The first LexFloatClient API function you need to use in your code is `SetHostProductId()`. It sets the product id of the product you will be adding licensing to.
Expand All @@ -33,7 +31,7 @@ LexFloatClient.SetHostProductId("PASTE_PRODUCT_ID");

### Requesting floating license

To receive a floating license, you will use `SetHostUrl()`, `SetFloatingLicenseCallback()` and `RequestFloatingLicense()`LexFloatClient API methods. It sets LexFloatServer address, callback for status notifications, contacts the server and receives the floating license.
To receive a floating license, you will use `SetHostUrl()`, `SetFloatingLicenseCallback()` and `RequestFloatingLicense()`LexFloatClient API methods. It sets the LexFloatServer address, the callback for status notifications, contacts the server and receives the floating license.

```csharp
private void leaseBtn_Click(object sender, EventArgs e)
Expand All @@ -57,7 +55,7 @@ The above code can be executed every time user starts the app or needs a new lic

### Renewing license lease

License lease automatically renews itself in a background thread. When license is renewed or it fails to renew, Callback is invoked \(from background thread\).
License lease automatically renews itself in a background thread. When a license is renewed or fails to renew, the callback is invoked \(from the background thread\).

```csharp
private void LicenceRenewCallback(uint status)
Expand Down Expand Up @@ -107,5 +105,5 @@ The above code should be executed every time user closes the app.

## Need more help

In case you need more help for adding LexFloatClient to your app, we'll be glad to help you make the integration. You can either post your questions on our [support forum](https://forums.cryptlex.com) or can contact us through [email](mailto:[email protected]?Subject=Using%20LexFloatClient).
In case you need more help with adding LexFloatClient to your app, we'll be glad to help you make the integration. You can either post your questions on our [support forum](https://forums.cryptlex.com) or can contact us through [email](mailto:[email protected]?Subject=Using%20LexFloatClient).

20 changes: 9 additions & 11 deletions ...mise-floating-licenses/using-lexfloatclient/using-lexfloatclient-with-delphi.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Using LexFloatClient with Delphi

First of all, login to your Cryptlex account and download LexFloatClient library for Windows:
First of all, login to your Cryptlex account and download the LexFloatClient library for Windows:

* [Download LexFloatClient for Windows](https://app.cryptlex.com/downloads)

Expand All @@ -13,18 +13,16 @@ After you've added a product for your app in the dashboard, go to the product pa
* Note the product id for the product.
* Download the example project from [Github](https://github.com/cryptlex/lexfloatclient-delphi)

Product id is the identifier of your product which is to be used in the code. The product id of the LexFloatServer and LexFloatClient must match.
The product id is the identifier of your product that is to be used in the code. The product id of the LexFloatServer and LexFloatClient must match.

### Adding library to your app
### Adding the library to your app

LexFloatClient example project for Delphi \(7 or newer\) contains the **LexFloatClient.pas** unit file. In addition to that, it includes **LexFloatClient.DelphiFeatures.pas** unit file used internally.

You need to add these files to your app in order to use LexFloatClient API in your app. Both units must be added, but only the LexFloatClient unit must be added to the uses list.

LexFloatClient has a dependency on `VS2015` runtime on **Windows**. On the target machines where you will deploy your app, you can install the `VS2015` runtime, if not present, using the link: [https://www.microsoft.com/en-in/download/details.aspx?id=48145](https://www.microsoft.com/en-in/download/details.aspx?id=48145)

LexFloatClient has a dependency on `libnss3` library on **Linux**. On the target machines where you will deploy your app, ensure `libnss3` library is installed.

### Setting product id

The first LexFloatClient API procedure you need to use in your code is `LexFloatClient.SetHostProductId`. It sets the product id of the product you will be adding licensing to.
Expand All @@ -35,7 +33,7 @@ SetHostProductId('PASTE_PRODUCT_ID');

### Requesting license lease

To receive a floating license, you will use `LexFloatClient.SetHostUrl`, `LexFloatClient.SetFloatingLicenseCallback` and `LexFloatClient.RequestFloatingLicense` LexFloatClient API methods. It sets LexFloatServer address, callback for status notifications, contacts the server and receives the floating license.
To receive a floating license, you will use `LexFloatClient.SetHostUrl`, `LexFloatClient.SetFloatingLicenseCallback` and `LexFloatClient.RequestFloatingLicense` LexFloatClient API methods. It sets the LexFloatServer address, the callback for status notifications, contacts the server and receives the floating license.

```text
var
Expand Down Expand Up @@ -83,11 +81,11 @@ end;

The above code can be executed every time user starts the app or needs a new license.

The second argument of `LexFloatClient.SetFloatingLicenseCallback` is False because console applications have no message loop. In GUI applications `Synchronized` is recommended to be `True` to enforce execution in main thread.
The second argument of `LexFloatClient.SetFloatingLicenseCallback` is False because console applications have no message loop. In GUI applications `Synchronized` is recommended to be `True` to enforce execution in the main thread.

### Renewing license lease

License lease automatically renews itself in a background thread. When something goes wrong, Callback is invoked \(from background thread\). Callback can be either procedure, object method, class method or a closure \(also known as anonymous function\). Note that GUI applications cannot safely interact with GUI elements from a thread other than GUI one. `System.Classes.TThread.Synchronize` will be used if `Synchronized` was `True` when callback was set. On another hand, `Synchronized` cannot work without message loop in main thread \(e.g. in console applications\), so synchronization must be performed in another way then.
License lease automatically renews itself in a background thread. When something goes wrong, the callback is invoked \(from the background thread\). The callback can be either procedure, object method, class method or a closure \(also known as an anonymous function\). Note that GUI applications cannot safely interact with GUI elements from a thread other than GUI one. `System.Classes.TThread.Synchronize` will be used if `Synchronized` was `True` when the callback was set. On another hand, `Synchronized` cannot work without a message loop in the main thread \(e.g. in console applications\), so synchronization must be performed in another way then.

```text
procedure OnLexFloatClient(const Error: Exception);
Expand All @@ -105,13 +103,13 @@ begin
end;
```

You would ideally request for a new license if Callback gets invoked.
You would ideally request a new license if the callback gets invoked.

### Dropping license lease

When your user is done using the app, the app should send a request to free the license, thereby making it available for other users. If the app doesn't, the license becomes \(zombie\) useless until lease time is over.

GUI \(e.g. VCL\) applications are supposed to divide the code into initialization and finalization. `LexFloatClient.ResetFloatingLicenseCallback` should be called before callback is going to become invalid. E.g. form method is invalid after form is destroyed, so putting `ResetFloatingLicenseCallback` in `TForm.OnDestroy` is a proper place. `LexFloatClient.DropFloatingLicense` should also be invoked, but beware of exceptions it can raise. Sample code:
GUI \(e.g. VCL\) applications are supposed to divide the code into initialization and finalization. `LexFloatClient.ResetFloatingLicenseCallback` should be called before the callback is going to become invalid. E.g. form method is invalid after the form is destroyed, so putting `ResetFloatingLicenseCallback` in `TForm.OnDestroy` is a proper place. `LexFloatClient.DropFloatingLicense` should also be invoked, but beware of exceptions it can raise. Sample code:

```text
procedure TForm1.OnDestroy;
Expand All @@ -129,5 +127,5 @@ The above code should be executed every time user closes the app.

## Need more help

In case you need more help for adding LexActivator to your app, we'll be glad to help you make the integration. You can either post your questions on our [support forum](https://forums.cryptlex.com) or can contact us through [email](mailto:[email protected]?Subject=Using%20LexFloatClient).
In case you need more help with adding LexActivator to your app, we'll be glad to help you make the integration. You can either post your questions on our [support forum](https://forums.cryptlex.com) or can contact us through [email](mailto:[email protected]?Subject=Using%20LexFloatClient).

12 changes: 5 additions & 7 deletions ...-premise-floating-licenses/using-lexfloatclient/using-lexfloatclient-with-go.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ After you've added a product for your app in the dashboard, go to the product pa
* Note the product id for the product.
* Download the example project from [Github](https://github.com/cryptlex/lexfloatclient-go/tree/main/examples)

Product id is the identifier of your product that is to be used in the code. The product id of the LexFloatServer and LexFloatClient must match.
The product id is the identifier of your product that is to be used in the code. The product id of the LexFloatServer and LexFloatClient must match.

### Adding library to your app
### Adding the library to your app

LexFloatClient wrapper for Go can be easily installed using the **go get** command:

Expand All @@ -27,8 +27,6 @@ This would copy the LexFloatClient.dll to your project directory.

LexFloatClient has a dependency on `VS2015` runtime on **Windows**. On the target machines where you will deploy your app, you can install the `VS2015` runtime, if not present, using the link: [https://www.microsoft.com/en-in/download/details.aspx?id=48145](https://www.microsoft.com/en-in/download/details.aspx?id=48145)

LexFloatClient has a dependency on `libnss3` library on **Linux**. On the target machines where you will deploy your app, ensure `libnss3` library is installed.

### Setting product id

The first LexFloatClient API function you need to use in your code is `SetHostProductId()`. It sets the product id of the product you will be adding licensing to.
Expand All @@ -39,7 +37,7 @@ lexfloatclient.SetHostProductId("PASTE_PRODUCT_ID");

### Requesting floating license

To receive a floating license, you will use `SetHostUrl()`, `SetFloatingLicenseCallback()` and `RequestFloatingLicense()`LexFloatClient API methods. It sets LexFloatServer address, callback for status notifications, contacts the server and receives the floating license.
To receive a floating license, you will use `SetHostUrl()`, `SetFloatingLicenseCallback()` and `RequestFloatingLicense()`LexFloatClient API methods. It sets the LexFloatServer address, the callback for status notifications, contacts the server and receives the floating license.

```python
func main() {
Expand Down Expand Up @@ -68,7 +66,7 @@ The above code can be executed every time user starts the app or needs a new lic

### Renewing floating license

License lease automatically renews itself in a background thread. When license is renewed or it fails to renew, Callback is invoked \(from the background thread\).
License lease automatically renews itself in a background thread. When a license is renewed or fails to renew, the callback is invoked \(from the background thread\).

```python
func licenseCallback(status int) {
Expand Down Expand Up @@ -97,5 +95,5 @@ The above code should be executed every time user closes the app.

## Need more help

In case you need more help for adding LexFloatClient to your app, we'll be glad to help you make the integration. You can either post your questions on our [support forum](https://forums.cryptlex.com) or can contact us through [email](mailto:[email protected]?Subject=Using%20LexFloatClient).
In case you need more help with adding LexFloatClient to your app, we'll be glad to help you make the integration. You can either post your questions on our [support forum](https://forums.cryptlex.com) or can contact us through [email](mailto:[email protected]?Subject=Using%20LexFloatClient).

Loading

0 comments on commit ccfbfeb

Please sign in to comment.