License

Classes
struct	face_sdk__license
	The license object. A license object provides information about your limits in face_sdk. See Licensing. More...

Typedefs
typedef struct face_sdk__license	face_sdk__license_t
	The license object. A license object provides information about your limits in face_sdk. See Licensing. More...

Functions
bool	face_sdk__license__get_addr (const face_sdk__license_t *license, uint64_t *addr)
	Retrieves face_sdk__license_t object address * *. More...
bool	face_sdk__license__get_license_info (const face_sdk__license_t *license, uint8_t **license_info, uint64_t *license_info_size)
	Retrieves information in YML format about your limits in face_sdk. See License YML format. More...
bool	face_sdk__load_license_from_file (face_sdk__license_t **license)
	Loads license from file in known paths. (see Known paths) More...
bool	face_sdk__load_license_from_file_1 (uint8_t *file_name, uint64_t file_name_size, face_sdk__license_t **license)
	Loads license from specified file. More...
bool	face_sdk__load_license_from_data (const uint8_t *data, uint64_t data_size, face_sdk__license_t **license)
	Loads license from memory. More...
bool	face_sdk__generate_license_request (const uint32_t *gpu_ids, uint64_t gpu_ids_size, uint8_t **request_data, uint64_t *request_data_size)
	Api function generating license request. Usually you can use face_sdk_utils for this purpose. More...
void	face_sdk__license_free (face_sdk__license_t *license)
	Destroys face_sdk__license object. More...

Detailed Description

Typedef Documentation

face_sdk__license_t

typedef struct face_sdk__license face_sdk__license_t

The license object. A 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__generate_license_request()

bool face_sdk__generate_license_request	(	const uint32_t *	gpu_ids,
		uint64_t	gpu_ids_size,
		uint8_t **	request_data,
		uint64_t *	request_data_size
	)

Api function generating license request. Usually you can use face_sdk_utils for this purpose.

Parameters

[in]	gpu_ids	List of gpu ids
[in]	gpu_ids_size	Number of items in gpu_ids
[out]	request_data	Binary request data
[out]	request_data_size	Request data size in bytes

Returns

true on success, false on failure. See last_error

face_sdk__license__get_addr()

bool face_sdk__license__get_addr	(	const face_sdk__license_t *	license,
		uint64_t *	addr
	)

Retrieves face_sdk__license_t object address * *.

Parameters

[in]	license	face_sdk__license_t object *
[out]	addr	Object address * *

Returns

true on success, false on failure. See last_error

face_sdk__license__get_license_info()

bool face_sdk__license__get_license_info	(	const face_sdk__license_t *	license,
		uint8_t **	license_info,
		uint64_t *	license_info_size
	)

Retrieves information in YML format about your limits in face_sdk. See License YML format.

Parameters

[in]	license	License object
[out]	license_info	String containing license information. See text_encoding
[out]	license_info	Size in bytes of licence_info string

Returns

true on success, false on failure. See last_error

face_sdk__license_free()

void face_sdk__license_free

(

face_sdk__license_t *

license

)

Destroys face_sdk__license object.

Parameters

[in]

license

License object

face_sdk__load_license_from_data()

bool face_sdk__load_license_from_data	(	const uint8_t *	data,
		uint64_t	data_size,
		face_sdk__license_t **	license
	)

Loads license from memory.

Parameters

[in]	data	Binary license data
[in]	data_size	Data size
[out]	license	License object

Returns

true on success, false on failure. See last_error

face_sdk__load_license_from_file()

bool face_sdk__load_license_from_file

(

face_sdk__license_t **

license

)

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

Parameters

[out]

license

License object

Returns

true on success, false on failure. See last_error

face_sdk__load_license_from_file_1()

bool face_sdk__load_license_from_file_1	(	uint8_t *	file_name,
		uint64_t	file_name_size,
		face_sdk__license_t **	license
	)

Loads license from specified file.

Parameters

[in]	file_name	String containing path to a file. See text_encoding
[in]	file_name_size	Size in bytes of file_name string
[out]	license	License object

Returns

true on success, false on failure. See last_error