com.hazelcast.cache.impl.eviction

Class CacheClearExpiredRecordsTask

java.lang.Object

com.hazelcast.internal.eviction.ClearExpiredRecordsTask<CachePartitionSegment>

com.hazelcast.cache.impl.eviction.CacheClearExpiredRecordsTask

All Implemented Interfaces:

OperationResponseHandler, Runnable

public class CacheClearExpiredRecordsTask
extends ClearExpiredRecordsTask<CachePartitionSegment>
implements OperationResponseHandler

Clears expired entries. This task provides per partition expiration operation logic. Fires cleanup operations at most partition operation thread count or some factor of it in one round.

• "hazelcast.internal.cache.expiration.cleanup.percentage": Scannable percentage of entries in a maps' partition in each round. Default percentage is 10%.
• "hazelcast.internal.cache.expiration.cleanup.operation.count": Number of scannable partitions in each round. No default value exists. Dynamically calculated against partition-count or partition-thread-count.

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

Node-wide setting example:

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

System-wide setting example:

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

Field Summary

Fields

Modifier and Type	Field and Description
static HazelcastProperty	CLEANUP_OPERATION_COUNT
static HazelcastProperty	CLEANUP_PERCENTAGE
static int	DEFAULT_CLEANUP_PERCENTAGE
static int	DEFAULT_TASK_PERIOD_SECONDS
static int	MAX_EXPIRED_KEY_COUNT_IN_BATCH
static String	PROP_CLEANUP_OPERATION_COUNT
static String	PROP_CLEANUP_PERCENTAGE
static String	PROP_TASK_PERIOD_SECONDS
static HazelcastProperty	TASK_PERIOD_SECONDS

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

cleanupOperationCount, cleanupPercentage, containers, DIFFERENCE_BETWEEN_TWO_SUBSEQUENT_PARTITION_CLEANUP_MILLIS, nodeEngine, operationService, taskPeriodSeconds

Constructor Summary

Constructors

Constructor and Description
CacheClearExpiredRecordsTask(NodeEngine nodeEngine, CachePartitionSegment[] containers)

Method Summary

Modifier and Type	Method and Description
protected void	clearLeftoverExpiredKeyQueues(CachePartitionSegment container)
protected Operation	createExpirationOperation(int expirationPercentage, CachePartitionSegment container)
protected long	getLastCleanupTime(CachePartitionSegment container)
protected boolean	hasExpiredKeyToSendBackup(CachePartitionSegment container)
protected boolean	hasRunningCleanup(CachePartitionSegment container)
protected boolean	isContainerEmpty(CachePartitionSegment container)
protected boolean	notHaveAnyExpirableRecord(CachePartitionSegment container)
void	sendResponse(Operation op, Object response) Sends a response.
protected void	setHasRunningCleanup(CachePartitionSegment container, boolean status)
protected void	sortPartitionContainers(List<CachePartitionSegment> containers)

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

getCleanupOperationCount, run, sendCleanupOperations

Methods inherited from class java.lang.Object

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

Field Detail

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

DEFAULT_TASK_PERIOD_SECONDS

public static final int DEFAULT_TASK_PERIOD_SECONDS

See Also:

Constant Field Values

TASK_PERIOD_SECONDS

public static final HazelcastProperty TASK_PERIOD_SECONDS

DEFAULT_CLEANUP_PERCENTAGE

public static final int DEFAULT_CLEANUP_PERCENTAGE

See Also:

Constant Field Values

MAX_EXPIRED_KEY_COUNT_IN_BATCH

public static final int MAX_EXPIRED_KEY_COUNT_IN_BATCH

See Also:

Constant Field Values

CLEANUP_PERCENTAGE

public static final HazelcastProperty CLEANUP_PERCENTAGE

CLEANUP_OPERATION_COUNT

public static final HazelcastProperty CLEANUP_OPERATION_COUNT

Constructor Detail

CacheClearExpiredRecordsTask

public CacheClearExpiredRecordsTask(NodeEngine nodeEngine,
                                    CachePartitionSegment[] containers)

Method Detail

hasExpiredKeyToSendBackup

protected boolean hasExpiredKeyToSendBackup(CachePartitionSegment container)

Specified by:

hasExpiredKeyToSendBackup in class ClearExpiredRecordsTask<CachePartitionSegment>

hasRunningCleanup

protected boolean hasRunningCleanup(CachePartitionSegment container)

Specified by:

hasRunningCleanup in class ClearExpiredRecordsTask<CachePartitionSegment>

setHasRunningCleanup

protected void setHasRunningCleanup(CachePartitionSegment container,
                                    boolean status)

Specified by:

setHasRunningCleanup in class ClearExpiredRecordsTask<CachePartitionSegment>

isContainerEmpty

protected boolean isContainerEmpty(CachePartitionSegment container)

Specified by:

isContainerEmpty in class ClearExpiredRecordsTask<CachePartitionSegment>

notHaveAnyExpirableRecord

protected boolean notHaveAnyExpirableRecord(CachePartitionSegment container)

Specified by:

notHaveAnyExpirableRecord in class ClearExpiredRecordsTask<CachePartitionSegment>

getLastCleanupTime

protected long getLastCleanupTime(CachePartitionSegment container)

Specified by:

getLastCleanupTime in class ClearExpiredRecordsTask<CachePartitionSegment>

clearLeftoverExpiredKeyQueues

protected void clearLeftoverExpiredKeyQueues(CachePartitionSegment container)

Specified by:

clearLeftoverExpiredKeyQueues in class ClearExpiredRecordsTask<CachePartitionSegment>

sortPartitionContainers

protected void sortPartitionContainers(List<CachePartitionSegment> containers)

Specified by:

sortPartitionContainers in class ClearExpiredRecordsTask<CachePartitionSegment>

sendResponse

public void sendResponse(Operation op,
                         Object response)

Description copied from interface: OperationResponseHandler

Sends a response.

Specified by:

sendResponse in interface OperationResponseHandler

Parameters:

op - the operation that got executed.

response - the response of the operation that got executed.

createExpirationOperation

protected Operation createExpirationOperation(int expirationPercentage,
                                              CachePartitionSegment container)

Specified by:

createExpirationOperation in class ClearExpiredRecordsTask<CachePartitionSegment>