org.gridgain.grid.cache.dr

Class CacheDrSenderConfiguration

java.lang.Object

org.gridgain.grid.cache.dr.CacheDrSenderConfiguration

All Implemented Interfaces:

Serializable

public class CacheDrSenderConfiguration
extends Object
implements Serializable

Data center replication sender cache configuration.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	DFLT_BACKUP_SYNC_FREQUENCY Default backup partition's DR state synchronization frequency.
static long	DFLT_BATCH_SND_FREQUENCY Default data center replication sender cache batch send frequency.
static int	DFLT_BATCH_SND_SIZE Default data center replication sender cache batch send size.
static int	DFLT_MAX_BATCHES Default data center replication sender cache maximum amount of pending batches.
static boolean	DFLT_PREFER_LOC_SND Default value of if to prefer the local sender hub (if available) ignoring the load balancing policy.
static DrSenderLoadBalancingMode	DFLT_SND_HUB_LOAD_BALANCING_MODE Default data center replication sender cache sender hub load balancing mode.
static int	DFLT_STATE_TRANSFER_THREADS_CNT Default data center replication sender cache amount of worker threads responsible for full state transfer.
static long	DFLT_STATE_TRANSFER_THROTTLE Default data center replication sender cache state transfer throttle.
static int	DFLT_STATE_TRANSFER_THROTTLE_BYTES Default data center replication sender cache state transfer throttle bytes.

Constructor Summary

Constructors

Constructor and Description
CacheDrSenderConfiguration() Default constructor.
CacheDrSenderConfiguration(CacheDrSenderConfiguration cfg) Copying constructor.

Method Summary

Modifier and Type	Method and Description
long	getBackupSyncFrequency() Gets backup part's DR state synchronization frequency.
long	getBatchSendFrequency() Gets batch send frequency.
int	getBatchSendSize() Deprecated. Use GridGainConfiguration.getBatchSendSizeBytes() instead.
CacheDrEntryFilter	getEntryFilter() Gets entry filter.
DrSenderLoadBalancingMode	getLoadBalancingMode() Gets sender hub load balancing mode.
int	getMaxBackupQueueSize() Gets maximum size of backup entries queue.
int	getMaxBatches() Gets maximum amount of batches awaiting for sender hub acknowledge.
String	getSenderGroup() Gets sender group name which sender will be used for replication.
int	getStateTransferThreadsCount() Deprecated. Use GridGainConfiguration.setDrStateTransferThreadPoolSize(int) instead.
long	getStateTransferThrottle() Deprecated. Use getStateTransferThrottleBytes() instead.
int	getStateTransferThrottleBytes() Gets state transfer throttle bytes.
boolean	isPreferLocalSender() Whether to prefer the local sender hub (if available) ignoring the load balancing policy.
CacheDrSenderConfiguration	setBackupSyncFrequency(long backupSyncFreq) Sets backup part's DR state synchronization frequency.
CacheDrSenderConfiguration	setBatchSendFrequency(long batchSndFreq) Sets batch send frequency.
CacheDrSenderConfiguration	setBatchSendSize(int batchSndSize) Deprecated. Use GridGainConfiguration.setBatchSendSizeBytes(int) instead.
CacheDrSenderConfiguration	setEntryFilter(@Nullable CacheDrEntryFilter entryFilter) Set entry filter.
CacheDrSenderConfiguration	setLoadBalancingMode(DrSenderLoadBalancingMode loadBalancingMode) Sets sender hub load balancing mode.
CacheDrSenderConfiguration	setMaxBackupQueueSize(int maxBackupSize) Sets maximum size of backup entries queue.
CacheDrSenderConfiguration	setMaxBatches(int maxBatches) Sets maximum amount of batches awaiting for sender hub acknowledge.
CacheDrSenderConfiguration	setPreferLocalSender(boolean preferLocSnd) Sets whether to prefer the local sender hub.
CacheDrSenderConfiguration	setSenderGroup(String senderGroup) Sets sender group name which sender will be used for replication.
CacheDrSenderConfiguration	setStateTransferThreadsCount(int stateTransferThreadsCnt) Deprecated. Use GridGainConfiguration.setDrStateTransferThreadPoolSize(int) instead.
CacheDrSenderConfiguration	setStateTransferThrottle(long stateTransferThrottle) Deprecated.
CacheDrSenderConfiguration	setStateTransferThrottleBytes(int stateTransferThrottleBytes) Sets state transfer throttle bytes.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_BATCH_SND_FREQUENCY

public static final long DFLT_BATCH_SND_FREQUENCY

Default data center replication sender cache batch send frequency.

See Also:

Constant Field Values

DFLT_BACKUP_SYNC_FREQUENCY

public static final long DFLT_BACKUP_SYNC_FREQUENCY

Default backup partition's DR state synchronization frequency.

See Also:

Constant Field Values

DFLT_BATCH_SND_SIZE

public static final int DFLT_BATCH_SND_SIZE

Default data center replication sender cache batch send size.

See Also:

Constant Field Values

DFLT_MAX_BATCHES

public static final int DFLT_MAX_BATCHES

Default data center replication sender cache maximum amount of pending batches.

See Also:

Constant Field Values

DFLT_SND_HUB_LOAD_BALANCING_MODE

public static final DrSenderLoadBalancingMode DFLT_SND_HUB_LOAD_BALANCING_MODE

Default data center replication sender cache sender hub load balancing mode.

DFLT_STATE_TRANSFER_THREADS_CNT

public static final int DFLT_STATE_TRANSFER_THREADS_CNT

Default data center replication sender cache amount of worker threads responsible for full state transfer.

See Also:

Constant Field Values

DFLT_STATE_TRANSFER_THROTTLE

public static final long DFLT_STATE_TRANSFER_THROTTLE

Default data center replication sender cache state transfer throttle.

See Also:

Constant Field Values

DFLT_STATE_TRANSFER_THROTTLE_BYTES

public static final int DFLT_STATE_TRANSFER_THROTTLE_BYTES

Default data center replication sender cache state transfer throttle bytes.

See Also:

Constant Field Values

DFLT_PREFER_LOC_SND

public static final boolean DFLT_PREFER_LOC_SND

Default value of if to prefer the local sender hub (if available) ignoring the load balancing policy.

See Also:

Constant Field Values

Constructor Detail

CacheDrSenderConfiguration

public CacheDrSenderConfiguration()

Default constructor.

CacheDrSenderConfiguration

public CacheDrSenderConfiguration(CacheDrSenderConfiguration cfg)

Copying constructor.

Parameters:

cfg - Configuration to copy.

Method Detail

getBatchSendSize

@Deprecated
public int getBatchSendSize()

Deprecated. Use GridGainConfiguration.getBatchSendSizeBytes() instead.

Gets batch send size. When size of a batch is greater than the given value or it's lifetime is greater than getBatchSendFrequency() batch will be sent to a sender hub.

When set to non-positive value, batch will be sent only in case it's lifetime is greater than getBatchSendFrequency().

Defaults to DFLT_BATCH_SND_SIZE.

Returns:

Batch send size.

setBatchSendSize

@Deprecated
public CacheDrSenderConfiguration setBatchSendSize(int batchSndSize)

Deprecated. Use GridGainConfiguration.setBatchSendSizeBytes(int) instead.

Sets batch send size. See getBatchSendSize() for more information.

Parameters:

batchSndSize - Batch send size.

Returns:

this for chaining.

getBatchSendFrequency

public long getBatchSendFrequency()

Gets batch send frequency. When size of a batch is greater than getBatchSendSize() or it's lifetime is greater than the given value batch will be sent to a sender hub.

When set to non-positive value, batch will be sent only in case it's size is greater than #getBatchSendSize().

Defaults to DFLT_BATCH_SND_FREQUENCY.

Returns:

Batch send frequency.

setBatchSendFrequency

public CacheDrSenderConfiguration setBatchSendFrequency(long batchSndFreq)

Sets batch send frequency. See getBatchSendFrequency() for more information.

Parameters:

batchSndFreq - Batch send frequency.

Returns:

this for chaining.

getBackupSyncFrequency

public long getBackupSyncFrequency()

Gets backup part's DR state synchronization frequency. Defaults to DFLT_BACKUP_SYNC_FREQUENCY.

Returns:

Batch send frequency.

setBackupSyncFrequency

public CacheDrSenderConfiguration setBackupSyncFrequency(long backupSyncFreq)

Sets backup part's DR state synchronization frequency. Sets the frequency at which GridGain replicates the DR state of primary partitions to backup nodes. The DR state includes information about which entries have been replicated and acknowledged. By synchronizing this state periodically, the system ensures that backup nodes can take over seamlessly in case a primary node fails. Adjusting this parameter allows fine-tuning of synchronization based on workload and network conditions. A lower value increases synchronization frequency, improving fault tolerance but potentially increasing resource usage. A higher value reduces synchronization frequency, decreasing resource usage but slightly delaying backup updates. See getBackupSyncFrequency() for more information.

Parameters:

backupSyncFreq - Backup partition's DR state sync frequency.

Returns:

this for chaining.

getMaxBatches

public int getMaxBatches()

Gets maximum amount of batches awaiting for sender hub acknowledge. When amount of batches awaiting sender hub delivery acknowledge reaches this value, all further cache updates will be suspended until it is below the limit again.

When set to non-positive value, maximum amount of batches is unlimited.

Defaults to DFLT_MAX_BATCHES.

Returns:

Maximum amount of batches awaiting for sender hub acknowledge.

setMaxBatches

public CacheDrSenderConfiguration setMaxBatches(int maxBatches)

Sets maximum amount of batches awaiting for sender hub acknowledge. See getMaxBatches() for more information.

Parameters:

maxBatches - Maximum amount of batches awaiting for sender hub acknowledge.

Returns:

this for chaining.

getMaxBackupQueueSize

public int getMaxBackupQueueSize()

Gets maximum size of backup entries queue. To support failover GridGain tracks replicated entries on backup nodes in a bounded queue. By default it's size is calculated based on maximum amount of batches getMaxBatches(), batch send size batchSndSize and number of backup nodes CacheConfiguration.getBackups(). You may set it's maximum size manually with this method.

Returns:

Maximum size of backup entries queue.

setMaxBackupQueueSize

public CacheDrSenderConfiguration setMaxBackupQueueSize(int maxBackupSize)

Sets maximum size of backup entries queue. See getMaxBackupQueueSize() for more information.

Parameters:

maxBackupSize - Maximum size of backup entries queue.

Returns:

this for chaining.

getEntryFilter

public CacheDrEntryFilter getEntryFilter()

Gets entry filter. When set it will be applied to all entries which are candidates for data center replication. If the filter is not passed, data center replication will not be performed on that entry.*

Defaults to null.

Returns:

Entry filter.

setEntryFilter

public CacheDrSenderConfiguration setEntryFilter(@Nullable
                                                 @Nullable CacheDrEntryFilter entryFilter)

Set entry filter. See getEntryFilter() for more information.

Parameters:

entryFilter - Entry filter.

Returns:

this for chaining.

getLoadBalancingMode

public DrSenderLoadBalancingMode getLoadBalancingMode()

Gets sender hub load balancing mode. When batch is ready to be sent, this parameter defines how to select the next sender hub this batch will be sent to.

Defaults to DFLT_SND_HUB_LOAD_BALANCING_MODE.

Returns:

Sender hub load balancing mode.

setLoadBalancingMode

public CacheDrSenderConfiguration setLoadBalancingMode(DrSenderLoadBalancingMode loadBalancingMode)

Sets sender hub load balancing mode. See getLoadBalancingMode() for more information.

Parameters:

loadBalancingMode - Sender hub load balancing mode.

Returns:

this for chaining.

getStateTransferThrottle

@Deprecated
public long getStateTransferThrottle()

Deprecated. Use getStateTransferThrottleBytes() instead.

Gets state transfer throttle. Defines delay in milliseconds to wait between full state transfer batches creation to avoid CPU or network overload.

When set to 0 throttling is disabled.

Defaults to DFLT_STATE_TRANSFER_THROTTLE.

Returns:

State transfer throttle.

setStateTransferThrottle

@Deprecated
public CacheDrSenderConfiguration setStateTransferThrottle(long stateTransferThrottle)

Deprecated.

Sets state transfer throttle. See getStateTransferThrottle() for more information.

Parameters:

stateTransferThrottle - State transfer throttle.

Returns:

this for chaining.

getStateTransferThrottleBytes

public int getStateTransferThrottleBytes()

Gets state transfer throttle bytes. Defines maximum allowed unacknowledged(unprocessed) messages in bytes.

When set to 0 throttling is disabled.

Defaults to DFLT_STATE_TRANSFER_THROTTLE_BYTES.

Returns:

State transfer throttle bytes.

setStateTransferThrottleBytes

public CacheDrSenderConfiguration setStateTransferThrottleBytes(int stateTransferThrottleBytes)

Sets state transfer throttle bytes. See getStateTransferThrottleBytes() for more information.

Parameters:

stateTransferThrottleBytes - State transfer throttle bytes.

Returns:

this for chaining.

getStateTransferThreadsCount

@Deprecated
public int getStateTransferThreadsCount()

Deprecated. Use GridGainConfiguration.setDrStateTransferThreadPoolSize(int) instead.

Gets state transfer threads count. Defines amount of threads which will iterate over cache and force entries data center replication.

Defaults to DFLT_STATE_TRANSFER_THREADS_CNT.

Returns:

State transfer threads count.

setStateTransferThreadsCount

@Deprecated
public CacheDrSenderConfiguration setStateTransferThreadsCount(int stateTransferThreadsCnt)

Deprecated. Use GridGainConfiguration.setDrStateTransferThreadPoolSize(int) instead.

Sets state transfer threads count. See getStateTransferThreadsCount() for more information.

Parameters:

stateTransferThreadsCnt - State transfer threads count.

Returns:

this for chaining.

isPreferLocalSender

public boolean isPreferLocalSender()

Whether to prefer the local sender hub (if available) ignoring the load balancing policy.

Defaults to DFLT_PREFER_LOC_SND.

Returns:

True whether to prefer local sender hub.

setPreferLocalSender

public CacheDrSenderConfiguration setPreferLocalSender(boolean preferLocSnd)

Sets whether to prefer the local sender hub. See isPreferLocalSender() for more information.

Parameters:

preferLocSnd - Whether to prefer the local sender.

Returns:

this for chaining.

getSenderGroup

public String getSenderGroup()

Gets sender group name which sender will be used for replication.

Returns:

Group name.

setSenderGroup

public CacheDrSenderConfiguration setSenderGroup(String senderGroup)

Sets sender group name which sender will be used for replication. Note: If is set to null, then default group will be used DrUtils.DFLT_SENDER_GROUP_NAME.

Parameters:

senderGroup - Sender group name.

Returns:

this for chaining.

toString

public String toString()

Overrides:

toString in class Object