Member Functions

static Sint32 mi::​neuraylib::​ILibrary_authenticator::authenticate( const INeuray* library, const char* vendor_key, Size vendor_key_length, const char* secret_key, Size secret_key_length, Sint32 count = 1) [inline, static]

Convenience function implementing the full library authentication. The embedding application needs to pass in a pointer to the mi::neuraylib::INeuray interface, the vendor key and the secret key. The function will then perform the authentication towards the library.

The function is inline to avoid passing the secret key to the which would enable eavesdroppers to get the key. Keys are supposed to be entered as delivered to the application writer (which are hex encoded byte arrays).

Parameters

library

A pointer to an instance of mi::neuraylib::INeuray. The method attempts to authenticate this instance of the library.

vendor_key

The vendor key assigned to the application writer.

vendor_key_length

The size of the vendor key.

secret_key

The secret key provided to the application writer.

secret_key_length

The size of the secret key.

count

The number of licenses to retrieve.

Returns

Indicates errors in the authentication attempt. Returns 0 if there was no error, or negative values in case of errors. Note that a value of 0 does not imply that the key is valid. Key validity is checked during startup, i.e., in mi::neuraylib::INeuray::start() .

virtual const IString* mi::​neuraylib::​ILibrary_authenticator::get_host_id() const [pure virtual]

Returns the host ID of the machine the program is running on. The host ID is a unique identifier of the machine which can be used to lock a license to a machine.

virtual const IString* mi::​neuraylib::​ILibrary_authenticator::get_last_error_message() const [pure virtual]

Returns the last error message related to authentication. For example, if authentication via FlexNet failed, i.e., mi::neuraylib::INeuray::start() returns -6, then there might be a message providing a more detailed error description, originating from the FlexNet utilities.

Returns

The last error message, or NULL if there is no such error message available.

virtual Uint64 mi::​neuraylib::​ILibrary_authenticator::get_trial_seconds_left() const [pure virtual]

Returns the number of seconds left for trial licenses. This method returns sensible data only when called after has been started or after mi::neuraylib::ILibrary_authenticator::is_flexnet_license_available().

Returns

The number of seconds left before a trial expires, or mi::base::numeric_traits<mi::base::Uint64>::max() for non-trial licenses (or has not yet been started).

virtual bool mi::​neuraylib::​ILibrary_authenticator::is_flexnet_license_available() const [pure virtual]

Indicates whether a valid FlexNet license for the submitted response is available. Please note that this function can only be used after the response was submitted with the call mi::neuraylib::ILibrary_authenticator::authenticate().

Returns

true if a valid FlexNet license is available, false if no valid FlexNet license is availble, no response has been submitted yet, or the license has already been checked out.

virtual bool mi::​neuraylib::​ILibrary_authenticator::is_trial_license() const [pure virtual]

Indicates whether the license provided for authentication is a trial license. This method can only be called after has been started or after mi::neuraylib::ILibrary_authenticator::is_flexnet_license_available().

Returns

true if the license is a trial license, false otherwise (including has not yet been started)

virtual bool mi::​neuraylib::​ILibrary_authenticator::set_flexnet_default_license_path( const char* path) [pure virtual]

Sets the expected FlexNet license file location. To check out a feature, a FlexNet enabled application must first locate the license file. This function sets the default location where to start looking for the license file. The @ symbol cannot be used for file paths, as it is used for specifying FlexNet server addresses. Please note that this function should only be used after the response was submitted using mi::neuraylib::ILibrary_authenticator::authenticate(), otherwise the return value is meaningless.

Returns

true if a valid FlexNet (non-trial) license was found in this path or eventually configured environment variables.

virtual void mi::​neuraylib::​ILibrary_authenticator::set_flexnet_trial_license_data( const Uint8* data, Size size) [pure virtual]

Sets the content of the FlexNet trial license. Similar to set_flexnet_default_license_path(), except that for trial licenses the license data is passed in memory.