forked from cryptlex/lexfloatclient-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
258 lines (240 loc) · 8.54 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
/* eslint-disable new-cap */
const { LexFloatClientException } = require('./lib/lexfloatclient-exception');
const { LexFloatStatusCodes } = require('./lib/lexfloatstatus-codes');
const { LexFloatClientNative, arrayToString } = require('./lib/lexfloatclient-native');
/**
* @class LicenseMeterAttribute
* @type {Object}
* @property {name} name The name of the meter attribute.
* @property {allowedUses} allowedUses The allowed uses of the meter attribute.
* @property {totalUses} totalUses The total uses of the meter attribute.
* @property {grossUses} totalUses The gross uses of the meter attribute.
*/
class LicenseMeterAttribute {
constructor(name, allowedUses, totalUses, grossUses) {
this.name = name;
this.allowedUses = allowedUses;
this.totalUses = totalUses;
this.grossUses = grossUses;
}
}
/**
* @class LexFloatClient
*/
class LexFloatClient {
/**
* Sets the product id of your application.
*
* @param {string} productId the unique product id of your application as mentioned on
* the product page in the dashboard.
* @throws {LexFloatClientException}
*/
static SetHostProductId(productId) {
const status = LexFloatClientNative.SetHostProductId(productId);
if (LexFloatStatusCodes.LF_OK != status) {
throw new LexFloatClientException(status);
}
}
/**
* Sets the network address of the LexFloatServer.
*
* The url format should be: http://[ip or hostname]:[port]
*
* @param {string} hostUrl url string having the correct format
* @throws {LexFloatClientException}
*/
static SetHostUrl(hostUrl) {
const status = LexFloatClientNative.SetHostUrl(hostUrl);
if (LexFloatStatusCodes.LF_OK != status) {
throw new LexFloatClientException(status);
}
}
/**
* Sets the renew license callback function.
*
* Whenever the license lease is about to expire, a renew request is sent to
* the server. When the request completes, the license callback function
* gets invoked with one of the following status codes:
*
* LexFloatStatusCodes.LF_OK, LexFloatStatusCodes.LF_E_INET, LexFloatStatusCodes.LF_E_LICENSE_EXPIRED_INET, LexFloatStatusCodes.LF_E_LICENSE_NOT_FOUND,
* LexFloatStatusCodes.LF_E_CLIENT, LexFloatStatusCodes.LF_E_IP, LexFloatStatusCodes.LF_E_SERVER, LexFloatStatusCodes.LF_E_TIME,
* LexFloatStatusCodes.LF_E_SERVER_LICENSE_NOT_ACTIVATED,LexFloatStatusCodes.LF_E_SERVER_TIME_MODIFIED,
* LexFloatStatusCodes.LF_E_SERVER_LICENSE_SUSPENDED, LexFloatStatusCodes.LF_E_SERVER_LICENSE_EXPIRED,
* LexFloatStatusCodes.LF_E_SERVER_LICENSE_GRACE_PERIOD_OVER
*
* @param {function(int)} licenseCallback callback function
* @throws {LexFloatClientException}
*/
static SetFloatingLicenseCallback(licenseCallback) {
const status = LexFloatClientNative.SetFloatingLicenseCallback(licenseCallback);
if (LexFloatStatusCodes.LF_OK != status) {
throw new LexFloatClientException(status);
}
}
/**
* Sets the floating client metadata.
*
* The metadata appears along with the license details of the license in
* LexFloatServer dashboard.
*
* @param {string} key string of maximum length 256 characters with utf-8 encoding.
* encoding.
* @param {string} value string of maximum length 256 characters with utf-8 encoding.
* encoding.
* @throws {LexFloatClientException}
*/
static SetFloatingClientMetadata(key, value) {
const status = LexFloatClientNative.SetFloatingClientMetadata(key, value);
if (LexFloatStatusCodes.LF_OK != status) {
throw new LexFloatClientException(status);
}
}
/**
* Get the value of the license metadata field associated with the
* LexFloatServer license key.
*
* @param {string} key key of the metadata field whose value you want to get
* @return Returns the metadata key value
* @throws {LexFloatClientException}
*/
static GetHostLicenseMetadata(key) {
const array = new Uint8Array(256);
const status = LexFloatClientNative.GetHostLicenseMetadata(key, array, array.length);
if (status != LexFloatStatusCodes.LF_OK) {
throw new LexFloatClientException(status);
}
return arrayToString(array);
}
/**
* Gets the license meter attribute allowed uses and total uses associated
* with the LexFloatServer license.
*
* @param {string} name name of the meter attribute
* @return Returns the values of meter attribute allowed and total uses.
* @throws {LexFloatClientException}
*/
static GetHostLicenseMeterAttribute(name) {
const allowedUses = new Uint32Array(1);
const totalUses = new Uint32Array(1);
const grossUses = new Uint32Array(1);
const status = LexFloatClientNative.GetHostLicenseMeterAttribute(name, allowedUses, totalUses, grossUses);
switch (status) {
case LexFloatStatusCodes.LF_OK:
return new LicenseMeterAttribute(name, allowedUses[0], totalUses[0], grossUses[0]);
default:
throw new LexFloatClientException(status);
}
}
/**
* Gets the license expiry date timestamp of the LexFloatServer license.
*
* @return Returns the timestamp
* @throws {LexFloatClientException}
*/
static GetHostLicenseExpiryDate() {
const expiryDate = new Uint32Array(1);
const status = LexFloatClientNative.GetHostLicenseExpiryDate(expiryDate);
switch (status) {
case LexFloatStatusCodes.LF_OK:
return expiryDate[0];
default:
throw new LexFloatClientException(status);
}
}
/**
* Gets the meter attribute uses consumed by the floating client.
*
* @param {string} name name of the meter attribute
* @return Returns the value of meter attribute uses by the floating client.
* @throws {LexFloatClientException}
*/
static GetFloatingClientMeterAttributeUses(name) {
const uses = new Uint32Array(1);
const status = LexFloatClientNative.GetFloatingClientMeterAttributeUses(name, uses);
if (LexFloatStatusCodes.LF_OK == status) {
return uses[0];
}
throw new LexFloatClientException(status);
}
/**
* Sends the request to lease the license from the LexFloatServer.
*
* @throws {LexFloatClientException}
*/
static RequestFloatingLicense() {
const status = LexFloatClientNative.RequestFloatingLicense();
if (LexFloatStatusCodes.LF_OK != status) {
throw new LexFloatClientException(status);
}
}
/**
* Sends the request to the LexFloatServer to free the license.
*
* Call this function before you exit your application to prevent zombie
* licenses.
*
* @throws {LexFloatClientException}
*/
static DropFloatingLicense() {
const status = LexFloatClientNative.DropFloatingLicense();
if (LexFloatStatusCodes.LF_OK != status) {
throw new LexFloatClientException(status);
}
}
/**
* Checks whether any license has been leased or not.
*
* @return true or false
* @throws {LexFloatClientException}
*/
static HasFloatingLicense() {
const status = LexFloatClientNative.HasFloatingLicense();
switch (status) {
case LexFloatStatusCodes.LF_OK:
return true;
case LexFloatStatusCodes.LF_E_NO_LICENSE:
return false;
default:
throw new LexFloatClientException(status);
}
}
/**
* Increments the meter attribute uses of the floating client.
*
* @param {string} name name of the meter attribute
* @param {string} increment the increment value
* @throws {LexFloatClientException}
*/
static IncrementFloatingClientMeterAttributeUses(name, increment) {
const status = LexFloatClientNative.IncrementFloatingClientMeterAttributeUses(name, increment);
if (LexFloatStatusCodes.LF_OK != status) {
throw new LexFloatClientException(status);
}
}
/**
* Decrements the meter attribute uses of the floating client.
*
* @param {string} name name of the meter attribute
* @param {string} decrement the decrement value
* @throws {LexFloatClientException}
*/
static DecrementFloatingClientMeterAttributeUses(name, decrement) {
const status = LexFloatClientNative.DecrementFloatingClientMeterAttributeUses(name, decrement);
if (LexFloatStatusCodes.LF_OK != status) {
throw new LexFloatClientException(status);
}
}
/**
* Resets the meter attribute uses of the floating client.
*
* @param {string} name name of the meter attribute
* @throws {LexFloatClientException}
*/
static ResetFloatingClientMeterAttributeUses(name) {
const status = LexFloatClientNative.ResetFloatingClientMeterAttributeUses(name);
if (LexFloatStatusCodes.LF_OK != status) {
throw new LexFloatClientException(status);
}
}
}
module.exports = { LexFloatClient, LicenseMeterAttribute, LexFloatStatusCodes, LexFloatClientException };