GridCachePreloader (Ignite 1.8.0)

All Known Implementing Classes:

GridCachePreloaderAdapter, GridDhtPreloader
```
public interface GridCachePreloader
```
Cache preloader that is responsible for loading cache entries either from remote nodes (for distributed cache) or anywhere else at cache startup.

Method Summary

Methods
Modifier and Type	Method and Description
`Callable<Boolean>`	`addAssignments(GridDhtPreloaderAssignments assignments, boolean forcePreload, Collection<String> caches, int cnt)` Adds assignments to preloader.
`GridDhtPreloaderAssignments`	`assign(GridDhtPartitionsExchangeFuture exchFut)`
`void`	`dumpDebugInfo()` Dumps debug information.
`void`	`evictPartitionAsync(GridDhtLocalPartition part)` Evicts partition asynchronously.
`void`	`forcePreload()` Force preload process.
`void`	`handleDemandMessage(int idx, UUID id, GridDhtPartitionDemandMessage d)` Handles Demand message.
`void`	`handleSupplyMessage(int idx, UUID id, GridDhtPartitionSupplyMessageV2 s)` Handles Supply message.
`boolean`	`needForceKeys()`
`void`	`onInitialExchangeComplete(Throwable err)` Callback by exchange manager when initial partition exchange is complete.
`void`	`onKernalStart()` Kernal start callback.
`void`	`onKernalStop()` Kernal stop callback.
`void`	`onReconnected()` Client reconnected callback.
`void`	`onTopologyChanged(GridDhtPartitionsExchangeFuture lastFut)`
`IgnitePredicate<GridCacheEntryInfo>`	`preloadPredicate()`
`void`	`preloadPredicate(IgnitePredicate<GridCacheEntryInfo> p)`
`IgniteInternalFuture<Boolean>`	`rebalanceFuture()`
`IgniteInternalFuture<Object>`	`request(Collection<KeyCacheObject> keys, AffinityTopologyVersion topVer)` Requests that preloader sends the request for the key.
`IgniteInternalFuture<Object>`	`request(GridNearAtomicAbstractUpdateRequest req, AffinityTopologyVersion topVer)` Requests that preloader sends the request for the key.
`void`	`start()` Starts preloading.
`IgniteInternalFuture<Object>`	`startFuture()`
`void`	`stop()` Stops preloading.
`IgniteInternalFuture<?>`	`syncFuture()`
`void`	`unwindUndeploys()` Unwinds undeploys.

- Method Detail
  - start
```
void start()
           throws IgniteCheckedException
```
    Starts preloading.
    
    Throws:
    
    IgniteCheckedException - If start failed.
  - stop
```
void stop()
```
    Stops preloading.
  - onKernalStart
```
void onKernalStart()
                   throws IgniteCheckedException
```
    Kernal start callback.
    
    Throws:
    
    IgniteCheckedException - If failed.
  - onKernalStop
```
void onKernalStop()
```
    Kernal stop callback.
  - onReconnected
```
void onReconnected()
```
    Client reconnected callback.
  - onInitialExchangeComplete
```
void onInitialExchangeComplete(@Nullable
                             Throwable err)
```
    Callback by exchange manager when initial partition exchange is complete.
    
    Parameters:
    err - Error, if any happened on initial exchange.
  - assign
```
@Nullable
GridDhtPreloaderAssignments assign(GridDhtPartitionsExchangeFuture exchFut)
```
    Parameters:
    exchFut - Exchange future to assign.
    
    Returns:
    Assignments or null if detected that there are pending exchanges.
  - addAssignments
```
Callable<Boolean> addAssignments(GridDhtPreloaderAssignments assignments,
                               boolean forcePreload,
                               Collection<String> caches,
                               int cnt)
```
    Adds assignments to preloader.
    
    Parameters:
    assignments - Assignments to add.
    forcePreload - Force preload flag.
    caches - Rebalancing of these caches will be finished before this started.
    cnt - Counter.
    
    Returns:
    Rebalancing closure.
  - preloadPredicate
```
void preloadPredicate(IgnitePredicate<GridCacheEntryInfo> p)
```
    Parameters:
    p - Preload predicate.
  - preloadPredicate
```
IgnitePredicate<GridCacheEntryInfo> preloadPredicate()
```
    Returns:
    Preload predicate. If not null, will evaluate each preloaded entry during send and receive, and if predicate evaluates to false, entry will be skipped.
  - startFuture
```
IgniteInternalFuture<Object> startFuture()
```
    Returns:
    Future which will complete when preloader is safe to use.
  - syncFuture
```
IgniteInternalFuture<?> syncFuture()
```
    Returns:
    Future which will complete when preloading is finished.
  - rebalanceFuture
```
IgniteInternalFuture<Boolean> rebalanceFuture()
```
    Returns:
    Future which will complete when preloading finishes on current topology. Future result is true in case rebalancing successfully finished at current topology. Future result is false in case rebalancing cancelled or finished with missed partitions and will be restarted at current or pending topology. Note that topology change creates new futures and finishes previous.
  - needForceKeys
```
boolean needForceKeys()
```
    Returns:
    true if there is no need to force keys preloading (e.g. rebalancing has been completed).
  - request
```
IgniteInternalFuture<Object> request(Collection<KeyCacheObject> keys,
                                   AffinityTopologyVersion topVer)
```
    Requests that preloader sends the request for the key.
    
    Parameters:
    keys - Keys to request.
    topVer - Topology version, -1 if not required.
    
    Returns:
    Future to complete when all keys are preloaded.
  - request
```
IgniteInternalFuture<Object> request(GridNearAtomicAbstractUpdateRequest req,
                                   AffinityTopologyVersion topVer)
```
    Requests that preloader sends the request for the key.
    
    Parameters:
    req - Message with keys to request.
    topVer - Topology version, -1 if not required.
    
    Returns:
    Future to complete when all keys are preloaded.
  - forcePreload
```
void forcePreload()
```
    Force preload process.
  - unwindUndeploys
```
void unwindUndeploys()
```
    Unwinds undeploys.
  - handleSupplyMessage
```
void handleSupplyMessage(int idx,
                       UUID id,
                       GridDhtPartitionSupplyMessageV2 s)
```
    Handles Supply message.
    
    Parameters:
    idx - Index.
    id - Node Id.
    s - Supply message.
  - handleDemandMessage
```
void handleDemandMessage(int idx,
                       UUID id,
                       GridDhtPartitionDemandMessage d)
```
    Handles Demand message.
    
    Parameters:
    idx - Index.
    id - Node Id.
    d - Demand message.
  - evictPartitionAsync
```
void evictPartitionAsync(GridDhtLocalPartition part)
```
    Evicts partition asynchronously.
    
    Parameters:
    part - Partition.
  - onTopologyChanged
```
void onTopologyChanged(GridDhtPartitionsExchangeFuture lastFut)
```
    Parameters:
    lastFut - Last future.
  - dumpDebugInfo
```
void dumpDebugInfo()
```
    Dumps debug information.

Interface GridCachePreloader

Method Summary

Method Detail

start

stop

onKernalStart

onKernalStop

onReconnected

onInitialExchangeComplete

assign

addAssignments

preloadPredicate

preloadPredicate

startFuture

syncFuture

rebalanceFuture

needForceKeys

request

request

forcePreload

unwindUndeploys

handleSupplyMessage

handleDemandMessage

evictPartitionAsync

onTopologyChanged

dumpDebugInfo