Package com.qfs.index

Interface IMultiVersionIndex

All Superinterfaces:

IMultiVersion, IMultiVersionOperations, ITransactionalMultiVersion

All Known Implementing Classes:

MultiVersionLazyDeleteLinkedIndex

public interface IMultiVersionIndex
extends ITransactionalMultiVersion

Multiversion main index.

Author:

ActiveViam

Method Summary

Modifier and Type	Method	Description
IIndexVersion	commit(IEpoch epoch)	Commits the pending transient state at the specified epoch.
Runnable	destroy()	Frees all resources held by this data structure.
IIndexVersion	getMostRecentVersion()	Retrieves the latest (i.e.
IIndexTransaction	getOrCreateTransaction()	Returns the current transaction. The result is never null contrary to ITransactionalMultiVersion.getTransaction().
IIndexTransaction	getTransaction()	Returns the current transaction.

Methods inherited from interface com.qfs.multiversion.ITransactionalMultiVersion

rollback

Method Detail

getMostRecentVersion

IIndexVersion getMostRecentVersion()

Description copied from interface: IMultiVersion

Retrieves the latest (i.e. current) version of the object.

Specified by:

getMostRecentVersion in interface IMultiVersion

Returns:

the latest version of the object

commit

IIndexVersion commit(IEpoch epoch)

Description copied from interface: IMultiVersionOperations

Commits the pending transient state at the specified epoch.

This automatically creates a new transient, writable state.

Thread-safety: unless specific otherwise by the implementing class, it is not thread-safe to call IMultiVersionOperations.commit(IEpoch) and IMultiVersionOperations.rollback() concurrently.

Specified by:

commit in interface IMultiVersionOperations

Parameters:

epoch - the epoch associated with this commit

Returns:

the version that prevails after this commit (possibly an untouched current version if the commit had absolutely no impact on the state)

getTransaction

IIndexTransaction getTransaction()

Description copied from interface: ITransactionalMultiVersion

Returns the current transaction.

Specified by:

getTransaction in interface ITransactionalMultiVersion

Returns:

the current transaction or null when there is no transaction

See Also:

ITransactionalMultiVersion.getOrCreateTransaction()

getOrCreateTransaction

IIndexTransaction getOrCreateTransaction()

Description copied from interface: ITransactionalMultiVersion

Returns the current transaction.
The result is never null contrary to ITransactionalMultiVersion.getTransaction().

THIS METHOD SHOULD BE CALLED ONLY IF IMultiVersionOperations.commit(IEpoch) (or ITransactionalMultiVersion.rollback()) IS GUARANTEED TO BE CALLED otherwise this could cause a memory leak if the transaction holds a version (because the multiversion will keep the transaction).

Specified by:

getOrCreateTransaction in interface ITransactionalMultiVersion

Returns:

the current transaction

See Also:

ITransactionalMultiVersion.getTransaction()

destroy

Runnable destroy()

Frees all resources held by this data structure.

Returns:

the Runnable to run to actually destroy the data