Face SDK  1.8.2 Mozart release
Face Recognition Software Development Kit
Classes | Typedefs | Functions
Remote_license
Base » c interface

Classes

struct  face_sdk__remote_license_callback
 Callback object used in face_sdk__make_remote_license() function. More...
 
struct  face_sdk__remote_license
 The remote_license object. A remote_license object provides information about your limits in face_sdk. See Licensing. More...
 

Typedefs

typedef uint8_t *(* face_sdk__on_load_cb_t) (uint64_t *license_data_size)
 Called when license is about to be fetch from server. Callback implementation is supposed to return cached license data.
 
typedef void(* face_sdk__on_updated_cb_t) (const uint8_t *license_data, uint64_t license_data_size)
 Called if license is successfully fetched. Callback implementation should cache the license and return cache subsequent on_load call.
 
typedef void(* face_sdk__on_free_data_cb_t) (const uint8_t *license_data)
 Called when license data should be free.
 
typedef struct face_sdk__remote_license_callback face_sdk__remote_license_callback_t
 Callback object used in face_sdk__make_remote_license() function.
 
typedef struct face_sdk__remote_license face_sdk__remote_license_t
 The remote_license object. A remote_license object provides information about your limits in face_sdk. See Licensing. More...
 

Functions

bool face_sdk__remote_license_callback__get_addr (const face_sdk__remote_license_callback_t *remote_license_callback, uint64_t *addr)
 Retrieves face_sdk__remote_license_callback_t object address. More...
 
bool face_sdk__make_remote_license_callback (face_sdk__on_load_cb_t on_load_cb, face_sdk__on_updated_cb_t on_updated_cb, face_sdk__on_free_data_cb_t on_free_data_cb, face_sdk__remote_license_callback_t **callback)
 
void face_sdk__remote_license_callback_free (face_sdk__remote_license_callback_t *callback)
 Destroys face_sdk__remote_license_callback object. More...
 
bool face_sdk__remote_license__get_addr (const face_sdk__remote_license_t *remote_license, uint64_t *addr)
 Retrieves face_sdk__remote_license_t object address. More...
 
bool face_sdk__remote_license__force_update (const face_sdk__remote_license_t *license)
 Fetches license from server or from local cache.
 
bool face_sdk__make_remote_license (uint8_t *token, uint64_t token_size, face_sdk__remote_license_t **license)
 Loads license from file in known paths. (see Known paths) More...
 
bool face_sdk__make_remote_license_1 (uint8_t *token, uint64_t token_size, uint8_t *file_name, uint64_t file_name_size, face_sdk__remote_license_t **license)
 Loads license from file in known paths. (see Known paths) More...
 
bool face_sdk__make_remote_license_2 (uint8_t *token, uint64_t token_size, const face_sdk__remote_license_callback_t *callback, face_sdk__remote_license_t **license)
 Loads license from file in known paths. (see Known paths) More...
 
bool face_sdk__make_remote_license_3 (uint8_t *token, uint64_t token_size, uint8_t *request, uint64_t request_size, const face_sdk__remote_license_callback_t *callback, face_sdk__remote_license_t **license)
 Loads license from file in known paths. (see Known paths) More...
 
bool face_sdk__make_default_license (void **license, int *type)
 Make license depending on environment variables (FACE_SDK_REMOTE_LICENSE_DEFAULT and FACE_SDK_REMOTE_LICENSE_TOKEN). set FACE_SDK_REMOTE_LICENSE_DEFAULT to '1' to construct remote_license by default, then FACE_SDK_REMOTE_LICENSE_TOKEN must contain license token. More...
 
void face_sdk__remote_license_free (face_sdk__remote_license_t *license)
 Destroys face_sdk__remote_license object. More...
 

Detailed Description

Typedef Documentation

◆ face_sdk__remote_license_t

typedef struct face_sdk__remote_license face_sdk__remote_license_t

The remote_license object. A remote_license object provides information about your limits in face_sdk. See Licensing.

Use face_sdk__load_licence_from_file() and face_sdk__load_licence_from_data() functions for instantiate a license object.

Function Documentation

◆ face_sdk__make_default_license()

bool face_sdk__make_default_license ( void **  license,
int *  type 
)

Make license depending on environment variables (FACE_SDK_REMOTE_LICENSE_DEFAULT and FACE_SDK_REMOTE_LICENSE_TOKEN). set FACE_SDK_REMOTE_LICENSE_DEFAULT to '1' to construct remote_license by default, then FACE_SDK_REMOTE_LICENSE_TOKEN must contain license token.

Parameters
[out]licenseLicense object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_remote_license()

bool face_sdk__make_remote_license ( uint8_t *  token,
uint64_t  token_size,
face_sdk__remote_license_t **  license 
)

Loads license from file in known paths. (see Known paths)

Parameters
[in]tokenToken
[in]token_sizeSize in bytes of token
[out]licenseLicense object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_remote_license_1()

bool face_sdk__make_remote_license_1 ( uint8_t *  token,
uint64_t  token_size,
uint8_t *  file_name,
uint64_t  file_name_size,
face_sdk__remote_license_t **  license 
)

Loads license from file in known paths. (see Known paths)

Parameters
[in]tokenToken
[in]token_sizeSize in bytes of token
[in]file_nameLocal file to store fetched license
[in]file_name_sizeSize in bytes of file_name_size string
[out]licenseLicense object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_remote_license_2()

bool face_sdk__make_remote_license_2 ( uint8_t *  token,
uint64_t  token_size,
const face_sdk__remote_license_callback_t *  callback,
face_sdk__remote_license_t **  license 
)

Loads license from file in known paths. (see Known paths)

Parameters
[in]tokenToken
[in]token_sizeSize in bytes of token
[in]callbackremote_license_callback object
[out]licenseLicense object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_remote_license_3()

bool face_sdk__make_remote_license_3 ( uint8_t *  token,
uint64_t  token_size,
uint8_t *  request,
uint64_t  request_size,
const face_sdk__remote_license_callback_t *  callback,
face_sdk__remote_license_t **  license 
)

Loads license from file in known paths. (see Known paths)

Parameters
[in]tokenToken
[in]token_sizeSize in bytes of token
[in]requestLicense request data
[in]request_sizeSize in bytes of request
[in]callbackremote_license_callback object
[out]licenseLicense object
Returns
true on success, false on failure. See last_error

◆ face_sdk__remote_license__get_addr()

bool face_sdk__remote_license__get_addr ( const face_sdk__remote_license_t *  remote_license,
uint64_t *  addr 
)

Retrieves face_sdk__remote_license_t object address.

Parameters
[in]remote_licenseface_sdk__remote_license_t object
[out]addrObject address
Returns
true on success, false on failure. See last_error

◆ face_sdk__remote_license_callback__get_addr()

bool face_sdk__remote_license_callback__get_addr ( const face_sdk__remote_license_callback_t *  remote_license_callback,
uint64_t *  addr 
)

Retrieves face_sdk__remote_license_callback_t object address.

Parameters
[in]remote_license_callbackface_sdk__remote_license_callback_t object
[out]addrObject address
Returns
true on success, false on failure. See last_error

◆ face_sdk__remote_license_callback_free()

void face_sdk__remote_license_callback_free ( face_sdk__remote_license_callback_t *  callback)

Destroys face_sdk__remote_license_callback object.

Parameters
[in]configRemote License callback object

◆ face_sdk__remote_license_free()

void face_sdk__remote_license_free ( face_sdk__remote_license_t *  license)

Destroys face_sdk__remote_license object.

Parameters
[in]licenseLicense object
Generated by   doxygen 1.8.14