License

Authenticate your copy of ReconstructMe SDK. More...

Typedefs
typedef int	reme_license_t
	Handle referencing a license object.
reme_error_t	reme_license_create (reme_context_t c, reme_license_t *l)
	Creates a new license object.
reme_error_t	reme_license_destroy (reme_context_t c, reme_license_t *l)
	Destroy a previously created license object.
reme_error_t	reme_license_clear_runtime_info (reme_context_t c, reme_license_t l)
	Reset data related to runtime information.
reme_error_t	reme_license_add_software (reme_context_t c, reme_license_t l, const char *module, int module_length, const char *shash, int shash_length)
	Add licensed software.
reme_error_t	reme_license_authenticate (reme_context_t c, reme_license_t l, const char *license)
	Authenticate using the given license file and any specified runtime data.
reme_error_t	reme_license_bind_hardware_hashes (reme_context_t c, reme_license_t l, reme_options_t o)
	Access hardware hashes for generating single user licenses bound to specific hardware.

Detailed Description

Authenticate your copy of ReconstructMe SDK.

The license handling is responsible for activating/deactivating certain SDK features depending on the license supplied. By default ReconstructMe SDK runs in non-commercial mode. To active the commerical mode and remove the limitations from the non-commercial version, you need to authenticate using the license file you have received on purchase. The snippet below shows how to do this

  // Create a license object
  reme_license_t l;
  reme_license_create(c, &l);
  reme_error_t e = reme_license_authenticate(c, l, "license.txt.sgn");

  if (e == REME_ERROR_SUCCESS) {
    puts("Now running in commercial mode");
  } else {
    puts("Failed to authenticate.");
  }

Typedef Documentation

typedef int reme_license_t

Handle referencing a license object.

ReconstructMe SDK commercial requires a valid license to be used.

Function Documentation

reme_error_t reme_license_create	(	reme_context_t	c,
		reme_license_t *	l
	)

Creates a new license object.

Only one license object can be around for a context. Multiple invocations will return the same handle.

Parameters

c	A valid context object
l	A pointer that will receive the license handle.

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_UNSPECIFIED	On failure

Examples:

example_reconstructmesdk_calibration.cpp, example_reconstructmesdk_colorize.cpp, example_reconstructmesdk_point_and_shoot_with_colors.cpp, and example_reconstructmesdk_sensor_multi_independent.cpp.

reme_error_t reme_license_destroy	(	reme_context_t	c,
		reme_license_t *	l
	)

Destroy a previously created license object.

Parameters

c	A pointer to a valid context object
l	A mutable pointer to a valid license handle to destroy

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_UNSPECIFIED	On failure

reme_error_t reme_license_clear_runtime_info	(	reme_context_t	c,
		reme_license_t	l
	)

Reset data related to runtime information.

Parameters

c	A pointer to a valid context object
l	A valid license handle

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_UNSPECIFIED	On failure

reme_error_t reme_license_add_software	(	reme_context_t	c,
		reme_license_t	l,
		const char *	module,
		int	module_length,
		const char *	shash,
		int	shash_length
	)

Add licensed software.

These values are required when the license is bound to specific software

Parameters

c	A pointer to a valid context object
l	A valid license handle
module	Name of the module that the signed hash corresponds to. This module must be found in the current process (i.e. loaded by the current process). Wildcards *? are accepted.
module_length	length of module string in bytes
shash	the signed checksum of the module
shash_length	length of the signed checksum in bytes

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_UNSPECIFIED	On failure

reme_error_t reme_license_authenticate	(	reme_context_t	c,
		reme_license_t	l,
		const char *	license
	)

Authenticate using the given license file and any specified runtime data.

Unless a valid ReconstructMe SDK license is specified, this SDK runs in non-commercial mode.

Parameters

c	A valid context handle
l	A valid license handle
license	The license file path containing it.

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_INVALID_LICENSE	On authentication error. reme_context_bind_error_info contains details.
REME_ERROR_UNSPECIFIED	On failure. CIFIED On other failure

Examples:

example_reconstructmesdk_calibration.cpp, example_reconstructmesdk_colorize.cpp, example_reconstructmesdk_point_and_shoot_with_colors.cpp, and example_reconstructmesdk_sensor_multi_independent.cpp.

reme_error_t reme_license_bind_hardware_hashes	(	reme_context_t	c,
		reme_license_t	l,
		reme_options_t	o
	)

Access hardware hashes for generating single user licenses bound to specific hardware.

Associated Protocol Buffers Specification

  // Hardware hashes
  message hardware {
    repeated string hashes = 1;
  }

Parameters

c	A valid context object
l	A valid license object
o	A valid options binding

Return values

REME_ERROR_SUCCESS	On success
REME_ERROR_UNSPECIFIED	On failure