org.apache.ignite.internal.processors.cache.distributed.dht.preloader

Class GridDhtPartitionsExchangeFuture

java.lang.Object

org.apache.ignite.internal.util.future.GridFutureAdapter<AffinityTopologyVersion>

org.apache.ignite.internal.processors.cache.distributed.dht.GridDhtTopologyFutureAdapter

org.apache.ignite.internal.processors.cache.distributed.dht.preloader.GridDhtPartitionsExchangeFuture

All Implemented Interfaces:

Comparable<GridDhtPartitionsExchangeFuture>, IgniteDiagnosticAware, IgniteInternalFuture<AffinityTopologyVersion>, CachePartitionExchangeWorkerTask, GridDhtTopologyFuture

public class GridDhtPartitionsExchangeFuture
extends GridDhtTopologyFutureAdapter
implements Comparable<GridDhtPartitionsExchangeFuture>, CachePartitionExchangeWorkerTask, IgniteDiagnosticAware

Future for exchanging partition maps.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ignite.internal.processors.cache.distributed.dht.GridDhtTopologyFutureAdapter

GridDhtTopologyFutureAdapter.CacheValidation

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXCHANGE_LOG

Fields inherited from class org.apache.ignite.internal.processors.cache.distributed.dht.GridDhtTopologyFutureAdapter

clusterIsActive, grpValidRes

Constructor Summary

Constructors

Constructor and Description
GridDhtPartitionsExchangeFuture(GridCacheSharedContext cctx, ReadWriteLock busyLock, GridDhtPartitionExchangeId exchId, ExchangeActions exchActions, CacheAffinityChangeMessage affChangeMsg)

Method Summary

Modifier and Type	Method and Description
boolean	activateCluster()
void	addDiagnosticRequest(IgniteDiagnosticPrepareContext diagCtx)
boolean	addOrMergeDelayedFullMessage(ClusterNode node, GridDhtPartitionsFullMessage fullMsg) Add or merge updates received from coordinator while exchange in progress.
void	affinityChangeMessage(CacheAffinityChangeMessage affChangeMsg) Sets affinity change message associated with the exchange.
boolean	cacheAddedOnExchange(int cacheId, UUID rcvdFrom)
boolean	cacheGroupAddedOnExchange(int grpId, UUID rcvdFrom)
boolean	changedBaseline()
void	cleanUp() Cleans up resources to avoid excessive memory usage.
int	compareTo(GridDhtPartitionsExchangeFuture fut)
ExchangeContext	context()
boolean	dynamicCacheGroupStarted(int grpId)
boolean	equals(Object o)
ExchangeDiscoveryEvents	events()
ExchangeActions	exchangeActions() Gets exchanges actions (such as cache start or stop) associated with the exchange future.
void	exchangeActions(ExchangeActions exchActions) Sets exchange actions associated with the exchange future (such as cache start or stop).
boolean	exchangeDone() Ready affinity future (GridCachePartitionExchangeManager.affinityReadyFuture(AffinityTopologyVersion) is completed before GridFutureAdapter.onDone(Object, Throwable) is called on GridDhtPartitionsExchangeFuture, it is guaranteed that this method will return true if affinity ready future is finished.
GridDhtPartitionExchangeId	exchangeId()
boolean	fastReplyOnSingleMessage(ClusterNode node, GridDhtPartitionsSingleMessage msg) Tries to fast reply with GridDhtPartitionsFullMessage on received single message in case of exchange future has already completed.
void	finishMerged() Finish merged future to allow GridCachePartitionExchangeManager.ExchangeFutureSet cleanup.
DiscoveryEvent	firstEvent()
DiscoCache	firstEventCache()
void	forceClientReconnect(ClusterNode node, GridDhtPartitionsSingleMessage msg) Method is called on coordinator in situation when initial ExchangeFuture created on client join event was preempted from exchange history because of IGNITE_EXCHANGE_HISTORY_SIZE property.
boolean	hasCachesToStart()
int	hashCode()
void	init(boolean newCrd) Starts activity.
AffinityTopologyVersion	initialVersion() Gets the affinity topology version for which this exchange was created.
boolean	localJoinExchange()
boolean	mergeJoinExchange(GridDhtPartitionsExchangeFuture fut) Merges this exchange with given one.
GridDhtPartitionsSingleMessage	mergeJoinExchangeOnDone(GridDhtPartitionsExchangeFuture fut)
Object	mutex()
static long	nextDumpTimeout(int step, long timeout)
boolean	onAdded()
void	onAffinityChangeMessage(ClusterNode node, CacheAffinityChangeMessage msg) Affinity change message callback, processed from the same thread as onNodeLeft(org.apache.ignite.cluster.ClusterNode).
boolean	onDone(AffinityTopologyVersion res, Throwable err) Callback to notify that future is finished.
void	onDynamicCacheChangeFail(ClusterNode node, DynamicCacheChangeFailureMessage msg) Cache change failure message callback, processed from the discovery thread.
void	onEvent(GridDhtPartitionExchangeId exchId, DiscoveryEvent discoEvt, DiscoCache discoCache) Event callback.
void	onNodeLeft(ClusterNode node) Node left callback, processed from the same thread as onAffinityChangeMessage(org.apache.ignite.cluster.ClusterNode, org.apache.ignite.internal.processors.cache.CacheAffinityChangeMessage).
void	onReceiveFullMessage(ClusterNode node, GridDhtPartitionsFullMessage msg)
void	onReceivePartitionRequest(ClusterNode node, GridDhtPartitionsSingleRequest msg)
void	onReceiveSingleMessage(ClusterNode node, GridDhtPartitionsSingleMessage msg) Processing of received single message.
boolean	partitionChangesInProgress()
UUID	partitionHistorySupplier(int grpId, int partId, long cntrSince) Retreives the node which has WAL history since cntrSince.
boolean	reconnectOnError(Throwable e)
boolean	serverNodeDiscoveryEvent()
GridCacheSharedContext	sharedContext()
String	shortInfo()
boolean	skipForExchangeMerge()
AffinityTopologyVersion	topologyVersion() Gets result topology version of this future.
String	toString()
void	waitAndReplyToNode(UUID nodeId, GridDhtPartitionsSingleMessage msg)

Methods inherited from class org.apache.ignite.internal.processors.cache.distributed.dht.GridDhtTopologyFutureAdapter

validateCache, validateCacheGroup

Methods inherited from class org.apache.ignite.internal.util.future.GridFutureAdapter

cancel, chain, chain, error, get, get, get, getUninterruptibly, ignoreInterrupts, isCancelled, isDone, isFailed, listen, logger, onCancelled, onDone, onDone, onDone, onDone, reset, result

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.ignite.internal.IgniteInternalFuture

cancel, chain, chain, error, get, get, get, getUninterruptibly, isCancelled, isDone, listen, result

Field Detail

EXCHANGE_LOG

public static final String EXCHANGE_LOG

See Also:

Constant Field Values

Constructor Detail

GridDhtPartitionsExchangeFuture

public GridDhtPartitionsExchangeFuture(GridCacheSharedContext cctx,
                                       ReadWriteLock busyLock,
                                       GridDhtPartitionExchangeId exchId,
                                       ExchangeActions exchActions,
                                       CacheAffinityChangeMessage affChangeMsg)

Parameters:

cctx - Cache context.

busyLock - Busy lock.

exchId - Exchange ID.

exchActions - Cache change requests.

affChangeMsg - Affinity change message.

Method Detail

mutex

public Object mutex()

Returns:

Future mutex.

sharedContext

public GridCacheSharedContext sharedContext()

Returns:

Shared cache context.

skipForExchangeMerge

public boolean skipForExchangeMerge()

Specified by:

skipForExchangeMerge in interface CachePartitionExchangeWorkerTask

Returns:

False if exchange merge should stop if this task is found in exchange worker queue.

context

public ExchangeContext context()

Returns:

Exchange context.

exchangeActions

public void exchangeActions(ExchangeActions exchActions)

Sets exchange actions associated with the exchange future (such as cache start or stop). Exchange actions is created from discovery event, so the actions must be set before the event is processed, thus the setter requires that evtLatch be armed.

Parameters:

exchActions - Exchange actions.

exchangeActions

@Nullable
public ExchangeActions exchangeActions()

Gets exchanges actions (such as cache start or stop) associated with the exchange future. Exchange actions can be null (for example, if the exchange is created for topology change event).

Returns:

Exchange actions.

affinityChangeMessage

public void affinityChangeMessage(CacheAffinityChangeMessage affChangeMsg)

Sets affinity change message associated with the exchange. Affinity change message is required when centralized affinity change is performed.

Parameters:

affChangeMsg - Affinity change message.

initialVersion

public AffinityTopologyVersion initialVersion()

Gets the affinity topology version for which this exchange was created. If several exchanges were merged, initial version is the version of the earliest merged exchange.

Specified by:

initialVersion in interface GridDhtTopologyFuture

Returns:

Initial exchange version.

topologyVersion

public AffinityTopologyVersion topologyVersion()

Gets result topology version of this future. Result version can differ from initial exchange version if exchanges for multiple discovery events are merged, in this case result version is version of last discovery event.

This method should be called only for finished topology future since result version is not known before exchange finished.

Specified by:

topologyVersion in interface GridDhtTopologyFuture

Returns:

Result topology version.

partitionHistorySupplier

@Nullable
public UUID partitionHistorySupplier(int grpId,
                                               int partId,
                                               long cntrSince)

Retreives the node which has WAL history since cntrSince.

Parameters:

grpId - Cache group ID.

partId - Partition ID.

cntrSince - Partition update counter since history supplying is requested.

Returns:

ID of history supplier node or null if it doesn't exist.

cacheAddedOnExchange

public boolean cacheAddedOnExchange(int cacheId,
                                    UUID rcvdFrom)

Parameters:

cacheId - Cache ID.

rcvdFrom - Node ID cache was received from.

Returns:

True if cache was added during this exchange.

cacheGroupAddedOnExchange

public boolean cacheGroupAddedOnExchange(int grpId,
                                         UUID rcvdFrom)

Parameters:

grpId - Cache group ID.

rcvdFrom - Node ID cache group was received from.

Returns:

True if cache group was added during this exchange.

dynamicCacheGroupStarted

public boolean dynamicCacheGroupStarted(int grpId)

Parameters:

grpId - Cache group ID.

Returns:

True if non-client cache group was added during this exchange.

onAdded

public boolean onAdded()

Returns:

True

onEvent

public void onEvent(GridDhtPartitionExchangeId exchId,
                    DiscoveryEvent discoEvt,
                    DiscoCache discoCache)

Event callback.

Parameters:

exchId - Exchange ID.

discoEvt - Discovery event.

discoCache - Discovery data cache.

activateCluster

public boolean activateCluster()

Returns:

True if activate cluster exchange.

changedBaseline

public boolean changedBaseline()

hasCachesToStart

public boolean hasCachesToStart()

Returns:

True if there are caches to start.

firstEvent

public DiscoveryEvent firstEvent()

Returns:

First event discovery event.

firstEventCache

public DiscoCache firstEventCache()

Returns:

Discovery cache for first event.

events

public ExchangeDiscoveryEvents events()

Returns:

Events processed in this exchange.

exchangeId

public GridDhtPartitionExchangeId exchangeId()

Returns:

Exchange ID.

init

public void init(boolean newCrd)
          throws IgniteInterruptedCheckedException

Starts activity.

Parameters:

newCrd - True if node become coordinator on this exchange.

Throws:

IgniteInterruptedCheckedException - If interrupted.

localJoinExchange

public boolean localJoinExchange()

Returns:

True if exchange for local node join.

serverNodeDiscoveryEvent

public boolean serverNodeDiscoveryEvent()

Returns:

True if exchange triggered by server node join or fail.

exchangeDone

public boolean exchangeDone()

Ready affinity future (GridCachePartitionExchangeManager.affinityReadyFuture(AffinityTopologyVersion) is completed before GridFutureAdapter.onDone(Object, Throwable) is called on GridDhtPartitionsExchangeFuture, it is guaranteed that this method will return true if affinity ready future is finished.

Also this method returns false for merged exchange futures.

Specified by:

exchangeDone in interface GridDhtTopologyFuture

Returns:

True if exchange is finished and result topology version can be used.

finishMerged

public void finishMerged()

Finish merged future to allow GridCachePartitionExchangeManager.ExchangeFutureSet cleanup.

onDone

public boolean onDone(@Nullable
                      AffinityTopologyVersion res,
                      @Nullable
                      Throwable err)

Callback to notify that future is finished. Note that if non-null exception is passed in the result value will be ignored.

Overrides:

onDone in class GridFutureAdapter<AffinityTopologyVersion>

Parameters:

res - Optional result.

err - Optional error.

Returns:

True if result was set by this call.

cleanUp

public void cleanUp()

Cleans up resources to avoid excessive memory usage.

mergeJoinExchange

public boolean mergeJoinExchange(GridDhtPartitionsExchangeFuture fut)

Merges this exchange with given one.

Parameters:

fut - Current exchange to merge with.

Returns:

True if need wait for message from joined server node.

mergeJoinExchangeOnDone

@Nullable
public GridDhtPartitionsSingleMessage mergeJoinExchangeOnDone(GridDhtPartitionsExchangeFuture fut)

Parameters:

fut - Current future.

Returns:

Pending join request if any.

forceClientReconnect

public void forceClientReconnect(ClusterNode node,
                                 GridDhtPartitionsSingleMessage msg)

Method is called on coordinator in situation when initial ExchangeFuture created on client join event was preempted from exchange history because of IGNITE_EXCHANGE_HISTORY_SIZE property.

Parameters:

node - Client node that should try to reconnect to the cluster.

msg - Single message received from the client which didn't find original ExchangeFuture.

onReceiveSingleMessage

public void onReceiveSingleMessage(ClusterNode node,
                                   GridDhtPartitionsSingleMessage msg)

Processing of received single message. Actual processing in future may be delayed if init method was not completed, see initDone()

Parameters:

node - Sender node.

msg - Single partition info.

fastReplyOnSingleMessage

public boolean fastReplyOnSingleMessage(ClusterNode node,
                                        GridDhtPartitionsSingleMessage msg)

Tries to fast reply with GridDhtPartitionsFullMessage on received single message in case of exchange future has already completed.

Parameters:

node - Cluster node which sent single message.

msg - Single message.

Returns:

true if fast reply succeed.

waitAndReplyToNode

public void waitAndReplyToNode(UUID nodeId,
                               GridDhtPartitionsSingleMessage msg)

Parameters:

nodeId - Node ID.

msg - Client's message.

onReceiveFullMessage

public void onReceiveFullMessage(ClusterNode node,
                                 GridDhtPartitionsFullMessage msg)

Parameters:

node - Sender node.

msg - Full partition info.

onReceivePartitionRequest

public void onReceivePartitionRequest(ClusterNode node,
                                      GridDhtPartitionsSingleRequest msg)

Parameters:

node - Sender node.

msg - Message with full partition info.

onDynamicCacheChangeFail

public void onDynamicCacheChangeFail(ClusterNode node,
                                     DynamicCacheChangeFailureMessage msg)

Cache change failure message callback, processed from the discovery thread.

Parameters:

node - Message sender node.

msg - Failure message.

onAffinityChangeMessage

public void onAffinityChangeMessage(ClusterNode node,
                                    CacheAffinityChangeMessage msg)

Affinity change message callback, processed from the same thread as onNodeLeft(org.apache.ignite.cluster.ClusterNode).

Parameters:

node - Message sender node.

msg - Message.

onNodeLeft

public void onNodeLeft(ClusterNode node)

Node left callback, processed from the same thread as onAffinityChangeMessage(org.apache.ignite.cluster.ClusterNode, org.apache.ignite.internal.processors.cache.CacheAffinityChangeMessage).

Parameters:

node - Left node.

reconnectOnError

public boolean reconnectOnError(Throwable e)

Parameters:

e - Exception.

Returns:

True if local node should try reconnect in case of error.

partitionChangesInProgress

public boolean partitionChangesInProgress()

Returns:

True If partition changes triggered by receiving Single/Full messages are not finished yet.

addOrMergeDelayedFullMessage

public boolean addOrMergeDelayedFullMessage(ClusterNode node,
                                            GridDhtPartitionsFullMessage fullMsg)

Add or merge updates received from coordinator while exchange in progress.

Parameters:

fullMsg - Full message with exchangeId = null.

Returns:

True if message should be ignored and processed after exchange is done.

compareTo

public int compareTo(GridDhtPartitionsExchangeFuture fut)

Specified by:

compareTo in interface Comparable<GridDhtPartitionsExchangeFuture>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

addDiagnosticRequest

public void addDiagnosticRequest(IgniteDiagnosticPrepareContext diagCtx)

Specified by:

addDiagnosticRequest in interface IgniteDiagnosticAware

Parameters:

diagCtx - Context.

shortInfo

public String shortInfo()

Returns:

Short information string.

toString

public String toString()

Overrides:

toString in class GridFutureAdapter<AffinityTopologyVersion>

nextDumpTimeout

public static long nextDumpTimeout(int step,
                                   long timeout)

Parameters:

step - Exponent coefficient.

timeout - Base timeout.

Returns:

Time to wait before next debug dump.