com.hazelcast.map.impl.eviction

Class MapClearExpiredRecordsTask

java.lang.Object

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

com.hazelcast.map.impl.eviction.MapClearExpiredRecordsTask

All Implemented Interfaces:

OperationResponseHandler, Runnable

public class MapClearExpiredRecordsTask
extends ClearExpiredRecordsTask<PartitionContainer>
implements OperationResponseHandler

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.

• : Scannable percentage of entries in a maps' partition in each round. Default percentage is %.
• : Number of scannable partitions in each round. No default value exists. Dynamically calculated against partition-count or partition-thread-count.
• : 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(
           , "3");
           Hazelcast.newHazelcastInstance(config);
       

System-wide setting example:

        System.setProperty(
        , "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 boolean	DEFAULT_PRIMARY_DRIVES_BACKUP
static int	DEFAULT_TASK_PERIOD_SECONDS
static int	MAX_EXPIRED_KEY_COUNT_IN_BATCH
static HazelcastProperty	PRIMARY_DRIVES_BACKUP
protected boolean	primaryDrivesEviction
static String	PROP_CLEANUP_OPERATION_COUNT
static String	PROP_CLEANUP_PERCENTAGE
static String	PROP_PRIMARY_DRIVES_BACKUP
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
MapClearExpiredRecordsTask(NodeEngine nodeEngine, PartitionContainer[] containers)

Method Summary

Modifier and Type	Method and Description
boolean	canPrimaryDriveExpiration()
protected void	clearLeftoverExpiredKeyQueues(PartitionContainer container) This can happen due to the partition ownership changes.
protected Operation	createExpirationOperation(int expirationPercentage, PartitionContainer container)
protected long	getLastCleanupTime(PartitionContainer container)
protected boolean	hasExpiredKeyToSendBackup(PartitionContainer container)
protected boolean	hasRunningCleanup(PartitionContainer container)
protected boolean	isContainerEmpty(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.
void	sendResponse(Operation op, Object response) Sends a response.
protected void	setHasRunningCleanup(PartitionContainer container, boolean status)
protected void	sortPartitionContainers(List<PartitionContainer> partitionContainers)
String	toString()

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, 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

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_PRIMARY_DRIVES_BACKUP

public static final boolean DEFAULT_PRIMARY_DRIVES_BACKUP

See Also:

Constant Field Values

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

PRIMARY_DRIVES_BACKUP

public static final HazelcastProperty PRIMARY_DRIVES_BACKUP

CLEANUP_PERCENTAGE

public static final HazelcastProperty CLEANUP_PERCENTAGE

CLEANUP_OPERATION_COUNT

public static final HazelcastProperty CLEANUP_OPERATION_COUNT

primaryDrivesEviction

protected final boolean primaryDrivesEviction

Constructor Detail

MapClearExpiredRecordsTask

public MapClearExpiredRecordsTask(NodeEngine nodeEngine,
                                  PartitionContainer[] containers)

Method Detail

sortPartitionContainers

protected void sortPartitionContainers(List<PartitionContainer> partitionContainers)

Specified by:

sortPartitionContainers in class ClearExpiredRecordsTask<PartitionContainer>

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.

canPrimaryDriveExpiration

public boolean canPrimaryDriveExpiration()

createExpirationOperation

protected Operation createExpirationOperation(int expirationPercentage,
                                              PartitionContainer container)

Specified by:

createExpirationOperation in class ClearExpiredRecordsTask<PartitionContainer>

hasExpiredKeyToSendBackup

protected boolean hasExpiredKeyToSendBackup(PartitionContainer container)

Specified by:

hasExpiredKeyToSendBackup in class ClearExpiredRecordsTask<PartitionContainer>

hasRunningCleanup

protected boolean hasRunningCleanup(PartitionContainer container)

Specified by:

hasRunningCleanup in class ClearExpiredRecordsTask<PartitionContainer>

setHasRunningCleanup

protected void setHasRunningCleanup(PartitionContainer container,
                                    boolean status)

Specified by:

setHasRunningCleanup in class ClearExpiredRecordsTask<PartitionContainer>

clearLeftoverExpiredKeyQueues

protected void clearLeftoverExpiredKeyQueues(PartitionContainer container)

This can happen due to the partition ownership changes.

Specified by:

clearLeftoverExpiredKeyQueues in class ClearExpiredRecordsTask<PartitionContainer>

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>

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>

getLastCleanupTime

protected long getLastCleanupTime(PartitionContainer container)

Specified by:

getLastCleanupTime in class ClearExpiredRecordsTask<PartitionContainer>

toString

public String toString()

Overrides:

toString in class Object