java.lang.Object
- org.apache.ignite.internal.processors.cache.query.continuous.CacheContinuousQueryHandler<K,V>

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, GridContinuousHandler

Direct Known Subclasses:

CacheContinuousQueryHandlerV2
```
public class CacheContinuousQueryHandler<K,V>
extends Object
implements GridContinuousHandler
```
Continuous query handler.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.ignite.internal.processors.continuous.GridContinuousHandler
  GridContinuousHandler.RegisterStatus

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DFLT_CONTINUOUS_QUERY_BACKUP_ACK_THRESHOLD`
`static int`	`DFLT_CONTINUOUS_QUERY_LISTENER_MAX_BUFFER_SIZE`
`static String`	`IGNITE_CONTINUOUS_QUERY_BACKUP_ACK_THRESHOLD`
`static String`	`IGNITE_CONTINUOUS_QUERY_LISTENER_MAX_BUFFER_SIZE`
`protected IgniteInternalFuture<Void>`	`initFut`	Initialization future.
`protected IgniteInternalFuture<Void>`	`p2pUnmarshalFut`	P2P unmarshalling future.

Constructor Summary

Constructors
Constructor	Description
`CacheContinuousQueryHandler()`	Required by `Externalizable`.
`CacheContinuousQueryHandler(String cacheName, Object topic, @Nullable javax.cache.event.CacheEntryUpdatedListener<K,V> locLsnr, @Nullable CacheEntryEventSerializableFilter<K,V> rmtFilter, boolean oldValRequired, boolean sync, boolean ignoreExpired, boolean ignoreClsNotFound)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`cacheName()`
`GridContinuousHandler`	`clone()`	Clones this handler.
`GridContinuousBatch`	`createBatch()`	Creates new batch.
`boolean`	`filter(org.apache.ignite.internal.processors.cache.query.continuous.CacheContinuousQueryEvent evt)`
`void`	`flushOnNodeLeft()`	Node which started routine leave topology.
`javax.cache.event.CacheEntryEventFilter`	`getEventFilter()`
`protected javax.cache.event.CacheEntryEventFilter`	`getEventFilter0()`	Returns an event filter without waiting on the unmarshalling future.
`@Nullable IgniteClosure<javax.cache.event.CacheEntryEvent<? extends K,? extends V>,?>`	`getTransformer()`
`IgniteClosure<javax.cache.event.CacheEntryEvent<? extends K,? extends V>,?>`	`getTransformer0()`
`protected void`	`initRemoteFilter(javax.cache.event.CacheEntryEventFilter filter, GridKernalContext ctx)`	Performs resource injection and checks asynchrony for the provided remote filter.
`void`	`internal(boolean internal)`
`boolean`	`isEvents()`
`boolean`	`isMarshalled()`
`boolean`	`isMessaging()`
`boolean`	`isQuery()`
`boolean`	`keepBinary()`
`void`	`keepBinary(boolean keepBinary)`
`javax.cache.event.CacheEntryUpdatedListener<K,V>`	`localListener()`
`boolean`	`localOnly()`
`void`	`localOnly(boolean locOnly)`
`@Nullable ContinuousQueryWithTransformer.EventListener<?>`	`localTransformedEventListener()`
`void`	`notifyCallback(UUID nodeId, UUID routineId, Collection<?> objs, GridKernalContext ctx)`	Notifies local callback.
`boolean`	`notifyExisting()`
`void`	`notifyExisting(boolean notifyExisting)`
`boolean`	`oldValueRequired()`
`void`	`onBatchAcknowledged(UUID routineId, GridContinuousBatch batch, GridKernalContext ctx)`	Called when ack for a batch is received from client.
`void`	`onClientDisconnected()`	Client node disconnected callback.
`@Nullable Object`	`orderedTopic()`
`void`	`p2pMarshal(GridKernalContext ctx)`	Deploys and marshals inner objects (called only if peer deployment is enabled).
`void`	`p2pUnmarshal(UUID nodeId, GridKernalContext ctx)`	Unmarshals inner objects (called only if peer deployment is enabled).
`protected <T> T`	`p2pUnmarshal(org.apache.ignite.internal.processors.cache.query.continuous.CacheContinuousQueryDeployableObject depObj, UUID nodeId, GridKernalContext ctx)`
`void`	`readExternal(ObjectInput in)`
`GridContinuousHandler.RegisterStatus`	`register(UUID nodeId, UUID routineId, GridKernalContext ctx)`	Registers listener.
`void`	`skipPrimaryCheck(boolean skipPrimaryCheck)`
`void`	`taskNameHash(int taskHash)`
`String`	`toString()`
`void`	`unregister(UUID routineId, GridKernalContext ctx)`	Unregisters listener.
`Map<Integer,T2<Long,Long>>`	`updateCounters()`
`void`	`updateCounters(AffinityTopologyVersion topVer, Map<UUID,Map<Integer,T2<Long,Long>>> cntrsPerNode, Map<Integer,T2<Long,Long>> cntrs)`
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DFLT_CONTINUOUS_QUERY_BACKUP_ACK_THRESHOLD
```
public static final int DFLT_CONTINUOUS_QUERY_BACKUP_ACK_THRESHOLD
```
See Also:

IGNITE_CONTINUOUS_QUERY_BACKUP_ACK_THRESHOLD, Constant Field Values

DFLT_CONTINUOUS_QUERY_LISTENER_MAX_BUFFER_SIZE
```
public static final int DFLT_CONTINUOUS_QUERY_LISTENER_MAX_BUFFER_SIZE
```
See Also:

IGNITE_CONTINUOUS_QUERY_LISTENER_MAX_BUFFER_SIZE, Constant Field Values

IGNITE_CONTINUOUS_QUERY_BACKUP_ACK_THRESHOLD

@SystemProperty(value="The size of the buffer with acknowledgment events that are sent to backup nodes",
                type=java.lang.Long.class,
                defaults="100")
public static final String IGNITE_CONTINUOUS_QUERY_BACKUP_ACK_THRESHOLD

See Also:: Constant Field Values

IGNITE_CONTINUOUS_QUERY_LISTENER_MAX_BUFFER_SIZE

@SystemProperty(value="The maximum size of the continuous query listener buffer. 10% of events are dropped once the buffer is full",
                type=java.lang.Long.class,
                defaults="10000")
public static final String IGNITE_CONTINUOUS_QUERY_LISTENER_MAX_BUFFER_SIZE

See Also:: Constant Field Values

p2pUnmarshalFut

protected transient IgniteInternalFuture<Void> p2pUnmarshalFut

P2P unmarshalling future.

initFut

protected transient IgniteInternalFuture<Void> initFut

Initialization future.

Constructor Detail

CacheContinuousQueryHandler
```
public CacheContinuousQueryHandler()
```
Required by Externalizable.

CacheContinuousQueryHandler

public CacheContinuousQueryHandler(String cacheName,
                                   Object topic,
                                   @Nullable
                                   @Nullable javax.cache.event.CacheEntryUpdatedListener<K,V> locLsnr,
                                   @Nullable
                                   @Nullable CacheEntryEventSerializableFilter<K,V> rmtFilter,
                                   boolean oldValRequired,
                                   boolean sync,
                                   boolean ignoreExpired,
                                   boolean ignoreClsNotFound)

Constructor.

Parameters:: cacheName - Cache name.; topic - Topic for ordered messages.; locLsnr - Local listener.; rmtFilter - Remote filter.; oldValRequired - Old value required flag.; sync - Synchronous flag.; ignoreExpired - Ignore expired events flag.

Method Detail
- internal
```
public void internal(boolean internal)
```
  Parameters:
  
  internal - Internal query.
- notifyExisting
```
public void notifyExisting(boolean notifyExisting)
```
  Parameters:
  
  notifyExisting - Notify existing.
- notifyExisting
```
public boolean notifyExisting()
```
  Returns:
  
  True if handler should obtain existing entries,false otherwise.
- oldValueRequired
```
public boolean oldValueRequired()
```
  Returns:
  
  True if old value required for handler, false otherwise.
- localListener
```
public javax.cache.event.CacheEntryUpdatedListener<K,V> localListener()
```
  Returns:
  
  Local listener.
- localOnly
```
public void localOnly(boolean locOnly)
```
  Parameters:
  
  locOnly - Local only.
- localOnly
```
public boolean localOnly()
```
  Returns:
  
  True if handler are local only, false otherwise.
- taskNameHash
```
public void taskNameHash(int taskHash)
```
  Parameters:
  
  taskHash - Task hash.
- skipPrimaryCheck
```
public void skipPrimaryCheck(boolean skipPrimaryCheck)
```
  Parameters:
  
  skipPrimaryCheck - Whether to skip primary check for REPLICATED cache.
- isEvents
```
public boolean isEvents()
```
  Specified by:
  
  isEvents in interface GridContinuousHandler
  
  Returns:
  
  True if for events.
- isMessaging
```
public boolean isMessaging()
```
  Specified by:
  
  isMessaging in interface GridContinuousHandler
  
  Returns:
  
  True if for messaging.
- isQuery
```
public boolean isQuery()
```
  Specified by:
  
  isQuery in interface GridContinuousHandler
  
  Returns:
  
  True if for continuous queries.
- keepBinary
```
public boolean keepBinary()
```
  Specified by:
  
  keepBinary in interface GridContinuousHandler
  
  Returns:
  
  True if Ignite Binary objects should be passed to the listener and filter.
- keepBinary
```
public void keepBinary(boolean keepBinary)
```
  Parameters:
  
  keepBinary - Keep binary flag.
- cacheName
```
public String cacheName()
```
  Specified by:
  
  cacheName in interface GridContinuousHandler
  
  Returns:
  
  Cache name if this is a continuous query handler.
- updateCounters
```
public void updateCounters(AffinityTopologyVersion topVer,
                           Map<UUID,Map<Integer,T2<Long,Long>>> cntrsPerNode,
                           Map<Integer,T2<Long,Long>> cntrs)
```
  Specified by:
  
  updateCounters in interface GridContinuousHandler
  
  Parameters:
  
  topVer - Topology version.
  
  cntrsPerNode - Init state partition counters for node.
  
  cntrs - Init state for partition counters.
- updateCounters
```
public Map<Integer,T2<Long,Long>> updateCounters()
```
  Specified by:
  
  updateCounters in interface GridContinuousHandler
  
  Returns:
  
  Init state for partition counters.
- register
```
public GridContinuousHandler.RegisterStatus register(UUID nodeId,
                                                     UUID routineId,
                                                     GridKernalContext ctx)
                                              throws IgniteCheckedException
```
  Registers listener.
  
  Specified by:
  
  register in interface GridContinuousHandler
  
  Parameters:
  
  nodeId - ID of the node that started routine.
  
  routineId - Routine ID.
  
  ctx - Kernal context.
  
  Returns:
  
  Whether listener was actually registered.
  
  Throws:
  
  IgniteCheckedException - In case of error.
- initRemoteFilter
```
protected void initRemoteFilter(javax.cache.event.CacheEntryEventFilter filter,
                                GridKernalContext ctx)
                         throws IgniteCheckedException
```
  Performs resource injection and checks asynchrony for the provided remote filter.
  
  Parameters:
  
  filter - Remote filter.
  
  ctx - Kernal context.
  
  Throws:
  
  IgniteCheckedException - If failed to perform resource injection.
- getEventFilter
```
public javax.cache.event.CacheEntryEventFilter getEventFilter()
                                                       throws IgniteCheckedException
```
  Returns:
  
  Cache entry event filter.
  
  Throws:
  
  IgniteCheckedException - If P2P unmarshalling failed.
- getEventFilter0
```
protected javax.cache.event.CacheEntryEventFilter getEventFilter0()
```
  Returns an event filter without waiting on the unmarshalling future.
  
  Returns:
  
  Cache entry event filter.
- getTransformer
```
@Nullable
public @Nullable IgniteClosure<javax.cache.event.CacheEntryEvent<? extends K,? extends V>,?> getTransformer()
                                                                                                                 throws IgniteCheckedException
```
  Returns:
  
  Cache entry event transformer.
  
  Throws:
  
  IgniteCheckedException
- getTransformer0
```
public IgniteClosure<javax.cache.event.CacheEntryEvent<? extends K,? extends V>,?> getTransformer0()
```
  Returns:
  
  Cache entry event transformer.
- localTransformedEventListener
```
@Nullable
public @Nullable ContinuousQueryWithTransformer.EventListener<?> localTransformedEventListener()
```
  Returns:
  
  Local listener of transformed events.
- unregister
```
public void unregister(UUID routineId,
                       GridKernalContext ctx)
```
  Unregisters listener.
  
  Specified by:
  
  unregister in interface GridContinuousHandler
  
  Parameters:
  
  routineId - Routine ID.
  
  ctx - Kernal context.
- notifyCallback
```
public void notifyCallback(UUID nodeId,
                           UUID routineId,
                           Collection<?> objs,
                           GridKernalContext ctx)
```
  Notifies local callback.
  
  Specified by:
  
  notifyCallback in interface GridContinuousHandler
  
  Parameters:
  
  nodeId - ID of the node where notification came from.
  
  routineId - Routine ID.
  
  objs - Notification objects.
  
  ctx - Kernal context.
- filter
```
public boolean filter(org.apache.ignite.internal.processors.cache.query.continuous.CacheContinuousQueryEvent evt)
```
  Parameters:
  
  evt - Query event.
  
  Returns:
  
  True if event passed filter otherwise false.
- onClientDisconnected
```
public void onClientDisconnected()
```
  Client node disconnected callback.
  
  Specified by:
  
  onClientDisconnected in interface GridContinuousHandler
- flushOnNodeLeft
```
public void flushOnNodeLeft()
```
  Node which started routine leave topology.
  
  Specified by:
  
  flushOnNodeLeft in interface GridContinuousHandler
- p2pMarshal
```
public void p2pMarshal(GridKernalContext ctx)
                throws IgniteCheckedException
```
  Deploys and marshals inner objects (called only if peer deployment is enabled).
  
  Specified by:
  
  p2pMarshal in interface GridContinuousHandler
  
  Parameters:
  
  ctx - Kernal context.
  
  Throws:
  
  IgniteCheckedException - In case of error.
- p2pUnmarshal
```
public void p2pUnmarshal(UUID nodeId,
                         GridKernalContext ctx)
                  throws IgniteCheckedException
```
  Unmarshals inner objects (called only if peer deployment is enabled).
  
  Specified by:
  
  p2pUnmarshal in interface GridContinuousHandler
  
  Parameters:
  
  nodeId - Sender node ID.
  
  ctx - Kernal context.
  
  Throws:
  
  IgniteCheckedException - In case of error.
- isMarshalled
```
public boolean isMarshalled()
```
  Returns:
  
  Whether the handler is marshalled for peer class loading.
- p2pUnmarshal
```
protected <T> T p2pUnmarshal(org.apache.ignite.internal.processors.cache.query.continuous.CacheContinuousQueryDeployableObject depObj,
                             UUID nodeId,
                             GridKernalContext ctx)
                      throws IgniteCheckedException
```
  Type Parameters:
  
  T - Result type.
  
  Parameters:
  
  depObj - Deployable object to unmarshal.
  
  nodeId - Sender node Id.
  
  ctx - Kernal context.
  
  Returns:
  
  Unmarshalled object.
  
  Throws:
  
  IgniteCheckedException - In case of unmarshalling failures.
- createBatch
```
public GridContinuousBatch createBatch()
```
  Creates new batch.
  
  Specified by:
  
  createBatch in interface GridContinuousHandler
  
  Returns:
  
  New batch.
- onBatchAcknowledged
```
public void onBatchAcknowledged(UUID routineId,
                                GridContinuousBatch batch,
                                GridKernalContext ctx)
```
  Called when ack for a batch is received from client.
  
  Specified by:
  
  onBatchAcknowledged in interface GridContinuousHandler
  
  Parameters:
  
  routineId - Routine ID.
  
  batch - Acknowledged batch.
  
  ctx - Kernal context.
- orderedTopic
```
@Nullable
public @Nullable Object orderedTopic()
```
  Specified by:
  
  orderedTopic in interface GridContinuousHandler
  
  Returns:
  
  Topic for ordered notifications. If null, notifications will be sent in non-ordered messages.
- clone
```
public GridContinuousHandler clone()
```
  Clones this handler.
  
  Specified by:
  
  clone in interface GridContinuousHandler
  
  Overrides:
  
  clone in class Object
  
  Returns:
  
  Clone of this handler.
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
  Specified by:
  
  writeExternal in interface Externalizable
  
  Throws:
  
  IOException
- readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
  Specified by:
  
  readExternal in interface Externalizable
  
  Throws:
  
  IOException
  
  ClassNotFoundException

Class CacheContinuousQueryHandler<K,​V>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ignite.internal.processors.continuous.GridContinuousHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DFLT_CONTINUOUS_QUERY_BACKUP_ACK_THRESHOLD

DFLT_CONTINUOUS_QUERY_LISTENER_MAX_BUFFER_SIZE

IGNITE_CONTINUOUS_QUERY_BACKUP_ACK_THRESHOLD

IGNITE_CONTINUOUS_QUERY_LISTENER_MAX_BUFFER_SIZE

p2pUnmarshalFut

initFut

Constructor Detail

CacheContinuousQueryHandler

CacheContinuousQueryHandler

Method Detail

internal

notifyExisting

notifyExisting

oldValueRequired

localListener

localOnly

localOnly

taskNameHash

skipPrimaryCheck

isEvents

isMessaging

isQuery

keepBinary

keepBinary

cacheName

updateCounters

updateCounters

register

initRemoteFilter

getEventFilter

getEventFilter0

getTransformer

getTransformer0

localTransformedEventListener

unregister

notifyCallback

filter

onClientDisconnected

flushOnNodeLeft

p2pMarshal

p2pUnmarshal

isMarshalled

p2pUnmarshal

createBatch

onBatchAcknowledged

orderedTopic

clone

toString

writeExternal

readExternal

Class CacheContinuousQueryHandler<K,V>