openDAQ
Open data acquisition platform
IModuleAuthenticator Struct Referenceabstract

Module authenticator interface. More...

+ Inheritance diagram for IModuleAuthenticator:
+ Collaboration diagram for IModuleAuthenticator:

Detailed Description

Module authenticator interface.

Public Member Functions

virtual ErrCode INTERFACE_FUNC authenticateModuleBinary (Bool *binaryValid, IString **vendorKey, IString *binaryPath)=0
 Verify the module binary with a certificate file. More...
 
virtual ErrCode INTERFACE_FUNC setLogger (ILogger *logger)=0
 API call to add allow the openDAQ instance to add it's logger after during construction. More...
 
- Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC borrowInterface (const IntfID &intfID, void **obj) const =0
 Returns another interface which is supported by the object without incrementing the reference count. More...
 
virtual ErrCode INTERFACE_FUNC dispose ()=0
 Disposes all references held by the object. More...
 
virtual ErrCode INTERFACE_FUNC getHashCode (SizeT *hashCode)=0
 Returns hash code of the object. More...
 
virtual ErrCode INTERFACE_FUNC equals (IBaseObject *other, Bool *equal) const =0
 Compares object to another object for equality. More...
 
virtual ErrCode INTERFACE_FUNC toString (CharPtr *str)=0
 Returns a string representation of the object. More...
 
- Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC queryInterface (const IntfID &intfID, void **obj)=0
 Returns another interface which is supported by the object and increments the reference count. More...
 
virtual int INTERFACE_FUNC addRef ()=0
 Increments the reference count for an interface on an object. More...
 
virtual int INTERFACE_FUNC releaseRef ()=0
 Decrements the reference count for an interface on an object. More...
 

Member Function Documentation

◆ authenticateModuleBinary()

virtual ErrCode INTERFACE_FUNC authenticateModuleBinary ( Bool binaryValid,
IString **  vendorKey,
IString binaryPath 
)
pure virtual

Verify the module binary with a certificate file.

Parameters
binaryPathAbsolute path to the binary.
[out]binaryValidThe binarys checksum matches and it's considered valid.
[out]vendorKeyKey for the vendor to identify if their certificate was used to authenticate the module.

◆ setLogger()

virtual ErrCode INTERFACE_FUNC setLogger ( ILogger logger)
pure virtual

API call to add allow the openDAQ instance to add it's logger after during construction.

Because the IModuleAuthenticator is constructed before the openDAQ IInstance and passed to the instance builder, the logger needs to be added seperately. To allow for this, the call needs to be added to the API, as the instance doesn't know the type of ModuleAuthenticatorImpl it's using.

Parameters
loggerThe instance's logger.