An abstraction to provide features for tracking and searching lock records. More...

Inheritance diagram for Apac.Licensing.LockRecords:

Public Member Functions
	LockRecords (double persistenceTimerInterval, int volatileLockTimeoutInterval)
	Initializes a new instance of the LockRecords class. More...

void	Add (AcquisitionResponse response)
	Adds a lock record for the specified response. More...

bool	RemoveFeatureLock (string featureResponseId)
	Removes the lock record(s) with the specified feature response id. More...

bool	RenewLocks (string acquisitionId, int keyLockTimeout)
	Renews the locks associated with the acquisition id. More...

bool	RenewLock (string featureResponseId, int keyLockTimeout)
	Renews the lock. More...

bool	Remove (string acquisitionId)
	Removes the lock record(s) with the specified acquisition id. More...

AuditResult	Audit (AcquisitionRequest request)
	Checks the records for the given feature to be sure it holds the proper number of leases for a non-volatile lock. More...

AuditResult	Audit (string contextId, string[] nodeIds, LicensedFeatures feature, int numLeasesHeld)
	Checks the record for the given feature to be sure it holds the proper number of leases for a non-volatile lock. More...

bool	Remove (string contextId, string[] nodeIds, LicensedFeatures feature, int count, out string featureResponseId)
	Removes the volatile lock record with the specified context id, node id, feature and count. More...

bool	Remove (string contextId, string[] nodeIds, LicensedFeatures feature, int numToRelease, int numLeasesHeld, out string featureResponseId)
	Removes the non-volatile lock record with the specified context id, node id, feature and count. More...

int	GetLockCount (string contextId, string[] nodeIds, LicensedFeatures feature)
	Finds the existing lock count for feature in the given contextId and nodeId scope. More...

LockRecord	Get (string contextId, string[] nodeIds, LicensedFeatures feature)

LockRecord[]	ToArray ()

System.Xml.Schema.XmlSchema	GetSchema ()

void	ReadXml (System.Xml.XmlReader reader)

void	WriteXml (System.Xml.XmlWriter writer)

void	SetTimingParameters (double persistenceTimerInterval, int volatileLockTimeoutInterval)

void	CheckTimeouts ()

IEnumerator< LockRecord >	GetEnumerator ()

Protected Member Functions
virtual void	OnLocksPersistenceRequired ()

Properties
int	Count `[get]`
	Gets the count. More...

bool	IsDirty `[get]`
	Gets a value indicating whether this instance is dirty. More...

Events
LocksPersistenceRequiredHandler	LocksPersistenceRequired

Detailed Description

An abstraction to provide features for tracking and searching lock records.

Constructor & Destructor Documentation

◆ LockRecords()

Apac.Licensing.LockRecords.LockRecords	(	double	persistenceTimerInterval,
		int	volatileLockTimeoutInterval
	)

inline

Initializes a new instance of the LockRecords class.

Parameters

persistenceTimerInterval	The persistence timer interval in seconds.
volatileLockTimeoutInterval	The volatile lock timeout interval in minutes.

Member Function Documentation

◆ Add()

void Apac.Licensing.LockRecords.Add ( AcquisitionResponse response )

inline

Adds a lock record for the specified response.

Parameters

response	The response.
featureResponse	The feature response.

◆ Audit() [1/2]

AuditResult Apac.Licensing.LockRecords.Audit ( AcquisitionRequest request )

inline

Checks the records for the given feature to be sure it holds the proper number of leases for a non-volatile lock.

Parameters

acquisitionId	The context id.
numLeasesHeld	The number of leases the client holds.

◆ Audit() [2/2]

AuditResult Apac.Licensing.LockRecords.Audit	(	string	contextId,
		string[]	nodeIds,
		LicensedFeatures	feature,
		int	numLeasesHeld
	)

inline

Checks the record for the given feature to be sure it holds the proper number of leases for a non-volatile lock.

Parameters

contextId	The context id.
nodeIds	The node ids.
feature	The feature.
numLeasesHeld	The number of leases the client holds.

◆ GetLockCount()

int Apac.Licensing.LockRecords.GetLockCount	(	string	contextId,
		string[]	nodeIds,
		LicensedFeatures	feature
	)

inline

Finds the existing lock count for feature in the given contextId and nodeId scope.

Parameters

contextId	The context identifier.
nodeIds	The node identifiers.
feature	The feature.

Returns: Returns the count, or -1 if the given feature record cannot be found.

◆ Remove() [1/3]

bool Apac.Licensing.LockRecords.Remove ( string acquisitionId )

inline

Removes the lock record(s) with the specified acquisition id.

Parameters

acquisitionId The acquisition id.

Returns: Returns true if a removal takes place, false if one does not.

◆ Remove() [2/3]

bool Apac.Licensing.LockRecords.Remove	(	string	contextId,
		string[]	nodeIds,
		LicensedFeatures	feature,
		int	count,
		out string	featureResponseId
	)

inline

Removes the volatile lock record with the specified context id, node id, feature and count.

Parameters

contextId	The context id.
nodeIds	The node ids.
feature	The feature.
count	The count.
acquisitionId	The acquisition id of the original request.

Returns: Returns true if a removal takes place, false if one does not.

◆ Remove() [3/3]

bool Apac.Licensing.LockRecords.Remove	(	string	contextId,
		string[]	nodeIds,
		LicensedFeatures	feature,
		int	numToRelease,
		int	numLeasesHeld,
		out string	featureResponseId
	)

inline

Removes the non-volatile lock record with the specified context id, node id, feature and count.

Parameters

contextId	The context id.
nodeIds	The node ids.
feature	The feature.
numToRelease	The count.
numLeasesHeld	The number of leases held by the client.
featureResponseId	The id of the feature response to the original request.

Returns: Returns true if a removal takes place, false if one does not.

◆ RemoveFeatureLock()

bool Apac.Licensing.LockRecords.RemoveFeatureLock ( string featureResponseId )

inline

Removes the lock record(s) with the specified feature response id.

Parameters

acquisitionId The feature response id.

Returns: Returns true if a removal takes place, false if one does not.

◆ RenewLock()

bool Apac.Licensing.LockRecords.RenewLock	(	string	featureResponseId,
		int	keyLockTimeout
	)

inline

Renews the lock.

Parameters

featureResponseId	The feature response id.
keyLockTimeout	The key lock timeout.

Returns

◆ RenewLocks()

bool Apac.Licensing.LockRecords.RenewLocks	(	string	acquisitionId,
		int	keyLockTimeout
	)

inline

Renews the locks associated with the acquisition id.

Parameters

acquisitionId	The acquisition id.
keyLockTimeout	The key lock timeout.

Returns

Property Documentation

◆ Count

int Apac.Licensing.LockRecords.Count

get

Gets the count.

The count.

◆ IsDirty

bool Apac.Licensing.LockRecords.IsDirty

get

Gets a value indicating whether this instance is dirty.

true if this instance is dirty; otherwise, false.

The documentation for this class was generated from the following file:

/var/lib/jenkins/workspace/apac/APAC/ApacLicensing/Apac.Licensing/LockRecords.cs

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ LockRecords()

Member Function Documentation

◆ Add()

◆ Audit() [1/2]

◆ Audit() [2/2]

◆ GetLockCount()

◆ Remove() [1/3]

◆ Remove() [2/3]

◆ Remove() [3/3]

◆ RemoveFeatureLock()

◆ RenewLock()

◆ RenewLocks()

Property Documentation

◆ Count

◆ IsDirty