com.hazelcast.map.impl.eviction

Class MapClearExpiredRecordsTask

java.lang.Object

com.hazelcast.internal.eviction.ClearExpiredRecordsTask<PartitionContainer,RecordStore>

com.hazelcast.map.impl.eviction.MapClearExpiredRecordsTask

All Implemented Interfaces:

Runnable

public class MapClearExpiredRecordsTask
extends ClearExpiredRecordsTask<PartitionContainer,RecordStore>

Clears expired entries (TTL & idle).

This task provides per partition expiration operation logic. (not per map, not per record store). Fires cleanup operations at most partition operation thread count or some factor of it in one round.

• "hazelcast.internal.map.expiration.task.period.seconds": The time between termination of one execution of this task and the commencement of the next one. Default value is seconds.
• "hazelcast.internal.map.expiration.cleanup.percentage": Scannable percentage of entries in a maps' partition in each round. Default percentage is %.
• "hazelcast.internal.map.expiration.cleanup.operation.count": Number of scannable partitions in each round. No default value exists. Dynamically calculated against partition-count or partition-thread-count.
• "hazelcast.internal.map.expiration.primary.drives_backup": Used to enable/disable management of backup expiration from primary. This can only be used with max idle seconds expiration.

These parameters can be set node-wide or system-wide

Node-wide setting example:

           Config config = new Config();
           config.setProperty("hazelcast.internal.map.expiration.cleanup.operation.count", "3");
           Hazelcast.newHazelcastInstance(config);
       

System-wide setting example:

        System.setProperty("hazelcast.internal.map.expiration.cleanup.operation.count", "3");
    

Nested Class Summary

Nested classes/interfaces inherited from class com.hazelcast.internal.eviction.ClearExpiredRecordsTask

ClearExpiredRecordsTask.ProcessablePartitionType

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_CLEANUP_OPERATION_COUNT
static String	PROP_CLEANUP_PERCENTAGE
static String	PROP_PRIMARY_DRIVES_BACKUP
static String	PROP_TASK_PERIOD_SECONDS

Fields inherited from class com.hazelcast.internal.eviction.ClearExpiredRecordsTask

containers, nodeEngine, partitionService, toBackupSender

Constructor Summary

Constructors

Constructor and Description
MapClearExpiredRecordsTask(PartitionContainer[] containers, NodeEngine nodeEngine)

Method Summary

Modifier and Type	Method and Description
boolean	canPrimaryDriveExpiration()
protected void	equalizeBackupSizeWithPrimary(PartitionContainer container)
protected long	getLastCleanupTime(PartitionContainer container)
protected ClearExpiredRecordsTask.ProcessablePartitionType	getProcessablePartitionType()
protected boolean	hasExpiredKeyToSendBackup(PartitionContainer container)
protected boolean	hasRunningCleanup(PartitionContainer container)
protected boolean	isContainerEmpty(PartitionContainer container)
protected Operation	newBackupExpiryOp(RecordStore store, Collection<ExpiredKey> expiredKeys)
protected Operation	newPrimaryExpiryOp(int expirationPercentage, PartitionContainer container)
protected boolean	notHaveAnyExpirableRecord(PartitionContainer partitionContainer) Here we check if that partition has any expirable record or not, if no expirable record exists in that partition no need to fire an expiration operation.
protected void	setHasRunningCleanup(PartitionContainer container)
protected void	sortPartitionContainers(List<PartitionContainer> partitionContainers)
Iterator<RecordStore>	storeIterator(PartitionContainer container)
String	toString()
void	tryToSendBackupExpiryOp(RecordStore store, boolean sendIfAtBatchSize)

Methods inherited from class com.hazelcast.internal.eviction.ClearExpiredRecordsTask

newBackupExpiryOpFilter, partitionLost, run, sendQueuedExpiredKeys

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROP_PRIMARY_DRIVES_BACKUP

public static final String PROP_PRIMARY_DRIVES_BACKUP

See Also:

Constant Field Values

PROP_CLEANUP_PERCENTAGE

public static final String PROP_CLEANUP_PERCENTAGE

See Also:

Constant Field Values

PROP_CLEANUP_OPERATION_COUNT

public static final String PROP_CLEANUP_OPERATION_COUNT

See Also:

Constant Field Values

PROP_TASK_PERIOD_SECONDS

public static final String PROP_TASK_PERIOD_SECONDS

See Also:

Constant Field Values

Constructor Detail

MapClearExpiredRecordsTask

public MapClearExpiredRecordsTask(PartitionContainer[] containers,
                                  NodeEngine nodeEngine)

Method Detail

canPrimaryDriveExpiration

public boolean canPrimaryDriveExpiration()

tryToSendBackupExpiryOp

public void tryToSendBackupExpiryOp(RecordStore store,
                                    boolean sendIfAtBatchSize)

Specified by:

tryToSendBackupExpiryOp in class ClearExpiredRecordsTask<PartitionContainer,RecordStore>

storeIterator

public Iterator<RecordStore> storeIterator(PartitionContainer container)

Specified by:

storeIterator in class ClearExpiredRecordsTask<PartitionContainer,RecordStore>

newPrimaryExpiryOp

protected Operation newPrimaryExpiryOp(int expirationPercentage,
                                       PartitionContainer container)

Specified by:

newPrimaryExpiryOp in class ClearExpiredRecordsTask<PartitionContainer,RecordStore>

newBackupExpiryOp

protected Operation newBackupExpiryOp(RecordStore store,
                                      Collection<ExpiredKey> expiredKeys)

Specified by:

newBackupExpiryOp in class ClearExpiredRecordsTask<PartitionContainer,RecordStore>

sortPartitionContainers

protected void sortPartitionContainers(List<PartitionContainer> partitionContainers)

Specified by:

sortPartitionContainers in class ClearExpiredRecordsTask<PartitionContainer,RecordStore>

getProcessablePartitionType

protected ClearExpiredRecordsTask.ProcessablePartitionType getProcessablePartitionType()

Specified by:

getProcessablePartitionType in class ClearExpiredRecordsTask<PartitionContainer,RecordStore>

equalizeBackupSizeWithPrimary

protected void equalizeBackupSizeWithPrimary(PartitionContainer container)

Specified by:

equalizeBackupSizeWithPrimary in class ClearExpiredRecordsTask<PartitionContainer,RecordStore>

hasExpiredKeyToSendBackup

protected boolean hasExpiredKeyToSendBackup(PartitionContainer container)

Specified by:

hasExpiredKeyToSendBackup in class ClearExpiredRecordsTask<PartitionContainer,RecordStore>

hasRunningCleanup

protected boolean hasRunningCleanup(PartitionContainer container)

Specified by:

hasRunningCleanup in class ClearExpiredRecordsTask<PartitionContainer,RecordStore>

setHasRunningCleanup

protected void setHasRunningCleanup(PartitionContainer container)

Specified by:

setHasRunningCleanup in class ClearExpiredRecordsTask<PartitionContainer,RecordStore>

notHaveAnyExpirableRecord

protected boolean notHaveAnyExpirableRecord(PartitionContainer partitionContainer)

Here we check if that partition has any expirable record or not, if no expirable record exists in that partition no need to fire an expiration operation.

Specified by:

notHaveAnyExpirableRecord in class ClearExpiredRecordsTask<PartitionContainer,RecordStore>

Parameters:

partitionContainer - corresponding partition container.

Returns:

true if no expirable record in that partition false otherwise.

isContainerEmpty

protected boolean isContainerEmpty(PartitionContainer container)

Specified by:

isContainerEmpty in class ClearExpiredRecordsTask<PartitionContainer,RecordStore>

getLastCleanupTime

protected long getLastCleanupTime(PartitionContainer container)

Specified by:

getLastCleanupTime in class ClearExpiredRecordsTask<PartitionContainer,RecordStore>

toString

public String toString()

Overrides:

toString in class Object