public class FairAffinityFunction extends Object implements AffinityFunction
partitions - Number of partitions to spread across nodes.
excludeNeighbors - If set to true, will exclude same-host-neighbors
from being backups of each other. This flag can be ignored in cases when topology has no enough nodes
for assign backups.
Note that backupFilter is ignored if excludeNeighbors is set to true.
backupFilter - Optional filter for back up nodes. If provided, then only
nodes that pass this filter will be selected as backup nodes. If not provided, then
primary and backup nodes will be selected out of all nodes available for this cache.
Cache affinity can be configured for individual caches via CacheConfiguration.getAffinity() method.
| Modifier and Type | Field and Description |
|---|---|
static int |
DFLT_PART_CNT
Default partition count.
|
| Constructor and Description |
|---|
FairAffinityFunction()
Empty constructor with all defaults.
|
FairAffinityFunction(boolean exclNeighbors)
Initializes affinity with flag to exclude same-host-neighbors from being backups of each other
and specified number of backups.
|
FairAffinityFunction(boolean exclNeighbors,
int parts)
Initializes affinity with flag to exclude same-host-neighbors from being backups of each other,
and specified number of backups and partitions.
|
FairAffinityFunction(int parts) |
FairAffinityFunction(int parts,
IgniteBiPredicate<ClusterNode,ClusterNode> backupFilter)
Initializes optional counts for replicas and backups.
|
| Modifier and Type | Method and Description |
|---|---|
List<List<ClusterNode>> |
assignPartitions(AffinityFunctionContext ctx)
Gets affinity nodes for a partition.
|
IgniteBiPredicate<ClusterNode,ClusterNode> |
getBackupFilter()
Gets optional backup filter.
|
int |
getPartitions()
Gets total number of key partitions.
|
boolean |
isExcludeNeighbors()
Checks flag to exclude same-host-neighbors from being backups of each other (default is
false). |
int |
partition(Object key)
Gets partition number for a given key starting from
0. |
int |
partitions()
Gets total number of partitions available.
|
void |
removeNode(UUID nodeId)
Removes node from affinity.
|
void |
reset()
Resets cache affinity to its initial state.
|
void |
setBackupFilter(IgniteBiPredicate<ClusterNode,ClusterNode> backupFilter)
Sets optional backup filter.
|
void |
setExcludeNeighbors(boolean exclNeighbors)
Sets flag to exclude same-host-neighbors from being backups of each other (default is
false). |
void |
setPartitions(int parts)
Sets total number of partitions.
|
public static final int DFLT_PART_CNT
public FairAffinityFunction()
public FairAffinityFunction(boolean exclNeighbors)
Note that backupFilter is ignored if excludeNeighbors is set to true.
exclNeighbors - True if nodes residing on the same host may not act as backups
of each other.public FairAffinityFunction(int parts)
parts - Number of partitions.public FairAffinityFunction(boolean exclNeighbors,
int parts)
Note that backupFilter is ignored if excludeNeighbors is set to true.
exclNeighbors - True if nodes residing on the same host may not act as backups
of each other.parts - Total number of partitions.public FairAffinityFunction(int parts,
@Nullable
IgniteBiPredicate<ClusterNode,ClusterNode> backupFilter)
Note that backupFilter is ignored if excludeNeighbors is set to true.
parts - Total number of partitions.backupFilter - Optional back up filter for nodes. If provided, backups will be selected
from all nodes that pass this filter. First argument for this filter is primary node, and second
argument is node being tested.public int getPartitions()
Note that for fully replicated caches this method should always
return 1.
public void setPartitions(int parts)
parts - Total number of partitions.@Nullable public IgniteBiPredicate<ClusterNode,ClusterNode> getBackupFilter()
null, backups will be selected
from all nodes that pass this filter. First node passed to this filter is primary node,
and second node is a node being tested.
Note that backupFilter is ignored if excludeNeighbors is set to true.
public void setBackupFilter(@Nullable
IgniteBiPredicate<ClusterNode,ClusterNode> backupFilter)
Note that backupFilter is ignored if excludeNeighbors is set to true.
backupFilter - Optional backup filter.public boolean isExcludeNeighbors()
false).
Note that backupFilter is ignored if excludeNeighbors is set to true.
True if nodes residing on the same host may not act as backups of each other.public void setExcludeNeighbors(boolean exclNeighbors)
false).
Note that backupFilter is ignored if excludeNeighbors is set to true.
exclNeighbors - True if nodes residing on the same host may not act as backups of each other.public List<List<ClusterNode>> assignPartitions(AffinityFunctionContext ctx)
Note that partitioned affinity must obey the following contract: given that node
N is primary for some key K, if any other node(s) leave
grid and no node joins grid, node N will remain primary for key K.
assignPartitions in interface AffinityFunctionctx - Affinity function context. Will provide all required information to calculate
new partition assignments.public void reset()
reset in interface AffinityFunctionpublic int partitions()
0 inclusively to
N exclusively without any gaps.partitions in interface AffinityFunctionpublic int partition(Object key)
0. Partitioned caches
should make sure that keys are about evenly distributed across all partitions
from 0 to partition count for best performance.
Note that for fully replicated caches it is possible to segment key sets among different grid node groups. In that case each node group should return a unique partition number. However, unlike partitioned cache, mappings of keys to nodes in replicated caches are constant and a node cannot migrate from one partition to another.
partition in interface AffinityFunctionkey - Key to get partition for.public void removeNode(UUID nodeId)
removeNode in interface AffinityFunctionnodeId - ID of node to remove.
Follow @ApacheIgnite
Ignite Fabric : ver. 1.5.11 Release Date : April 8 2016