Package com.qfs.index

Interface IMultiVersionLongArray

All Superinterfaces:

IDroppableComponent, IMultiVersion, IMultiVersionOperations, ITransactionalMultiVersion

All Known Implementing Classes:

MultiVersionLongArray

public interface IMultiVersionLongArray
extends ITransactionalMultiVersion, IDroppableComponent

Multiversion long array.

Author:

ActiveViam

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IMultiVersionLongArray.IDiscardProcedure	A procedure that is invoked whenever the garbage stored in a version of an array is collected.

Method Summary

Modifier and Type	Method	Description
ILongArrayVersion	commit(IEpoch epoch)	Commits the pending transient state at the specified epoch.
Runnable	destroy()	Frees all resources held by this data structure.
void	drop()	Notifies the component that it has been definitively dropped.
ISquashableLongArrayVersion	getMostRecentVersion()	Retrieves the latest (i.e.
ILongArrayTransaction	getOrCreateTransaction()	Returns the current transaction. The result is never null contrary to ITransactionalMultiVersion.getTransaction().
ILongArrayTransaction	getTransaction()	Returns the current transaction.
boolean	isTransient()	Returns whether this array is transient.
void	setDiscardProcedure(IMultiVersionLongArray.IDiscardProcedure procedure)	Sets the discard procedure.

Methods inherited from interface com.qfs.multiversion.ITransactionalMultiVersion

rollback

Method Detail

getMostRecentVersion

ISquashableLongArrayVersion 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

ILongArrayVersion 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

ILongArrayTransaction 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

ILongArrayTransaction 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 structure

isTransient

boolean isTransient()

Returns whether this array is transient.

Returns:

true if this array is transient, false otherwise

drop

void drop()

Notifies the component that it has been definitively dropped.

No more roll back is possible.

The component should nullify the references it does not need anymore (example: latest, transaction) to avoid memory leak.

setDiscardProcedure

void setDiscardProcedure(IMultiVersionLongArray.IDiscardProcedure procedure)

Sets the discard procedure.

The procedure will be invoked whenever the garbage stored in a version of this array is collected.

Parameters:

procedure - the discard procedure