Class: TElfinConfiguration

Declaration: Elfin.h

Taxonomy Categories:

Member Functions:

Interface Category:

API (3rd party product).

Inherits From:

TProviderOperation

Inherited By:

None.

Purpose:

Defines an operation for specifying Elfin configuration. These configuration parameters are required for ELM (the Elan License Manager, a trademark of Elan Computer Group). ELM is the back-end licensing technology for the Elfin Licensing Framework implementation.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None. necessary.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TElfinConfiguration::TElfinConfiguration

TElfinConfiguration (const TText & feature, const unsigned long option, TText & host, const int port, const TText & service, const char * salt)

Interface Category:

API.

Purpose:

Constructor

Calling Context:

Construct this object before invoking ExecuteOperations

Parameters:

const TText & feature -Product's feature being licensed via ELM.
const unsigned long option -ELM defined option, as in elm.h.
TText & host -Name of host on which license server is running.
const int port -Port number on which developer's copy of ELM License Server is listening.
const TText & service -If port is 0, this specifies the service name. for developer's copy of ELM License Server. Service names typically appear in /etc/services on Unix systems.
const char * salt -Company specific encryption salt, unique for each developer's copy of Elan License Manager.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TElfinConfiguration::~TElfinConfiguration

virtual ~ TElfinConfiguration ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TElfinConfiguration::operator=

TElfinConfiguration & operator =(const TElfinConfiguration &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TElfinConfiguration & -Object to copy

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TElfinConfiguration::GetOperationType

virtual void GetOperationType (TStandardText & token) const

Interface Category:

API.

Purpose:

Overrides the base class function. Retrieves the operation type represented by this object.

Calling Context:

Called to get type of operation

Parameters:

TStandardText & token -Storage to which the operation type is copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TElfinConfiguration::SetOption

virtual void SetOption (const unsigned long option)

Interface Category:

API.

Purpose:

Allows option specified to ELM to be changed.

Calling Context:

Called to change option by client's licensed product.

Parameters:

const unsigned long option -ELM defined option, as in elm.h

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TElfinConfiguration::GetHost

virtual TText & GetHost ()

Interface Category:

API.

Purpose:

Allows TLicenseUse to examine the host name in AcceptOperationsResult.

Calling Context:

Called during OperationsResult acceptance phase.

Parameters:

Takes no parameters.

Return Value:

Returns a TText reference to the host name.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.