org.apache.ignite.internal.processors.continuous

Interface GridContinuousHandler

All Superinterfaces:

Cloneable, Externalizable, Serializable

All Known Implementing Classes:

CacheContinuousQueryHandler, CacheContinuousQueryHandlerV2, GridMessageListenHandler

public interface GridContinuousHandler
extends Externalizable, Cloneable

Continuous routine handler.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GridContinuousHandler.RegisterStatus Listener registration status.

Method Summary

Methods

Modifier and Type	Method and Description
String	cacheName()
GridContinuousHandler	clone() Clones this handler.
GridContinuousBatch	createBatch() Creates new batch.
boolean	isEvents()
boolean	isMessaging()
boolean	isQuery()
boolean	keepBinary()
void	notifyCallback(UUID nodeId, UUID routineId, Collection<?> objs, GridKernalContext ctx) Notifies local callback.
void	onBatchAcknowledged(UUID routineId, GridContinuousBatch batch, GridKernalContext ctx) Called when ack for a batch is received from client.
void	onListenerRegistered(UUID routineId, GridKernalContext ctx) Callback called after listener is registered and acknowledgement is sent.
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).
GridContinuousHandler.RegisterStatus	register(UUID nodeId, UUID routineId, GridKernalContext ctx) Registers listener.
void	unregister(UUID routineId, GridKernalContext ctx) Unregisters listener.
void	updateCounters(AffinityTopologyVersion topVer, Map<UUID,Map<Integer,Long>> cntrsPerNode, Map<Integer,Long> cntrs)

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Method Detail

register

GridContinuousHandler.RegisterStatus register(UUID nodeId,
                                            UUID routineId,
                                            GridKernalContext ctx)
                                              throws IgniteCheckedException

Registers listener.

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.

onListenerRegistered

void onListenerRegistered(UUID routineId,
                        GridKernalContext ctx)

Callback called after listener is registered and acknowledgement is sent.

Parameters:

routineId - Routine ID.

ctx - Kernal context.

unregister

void unregister(UUID routineId,
              GridKernalContext ctx)

Unregisters listener.

Parameters:

routineId - Routine ID.

ctx - Kernal context.

notifyCallback

void notifyCallback(UUID nodeId,
                  UUID routineId,
                  Collection<?> objs,
                  GridKernalContext ctx)

Notifies local callback.

Parameters:

nodeId - ID of the node where notification came from.

routineId - Routine ID.

objs - Notification objects.

ctx - Kernal context.

p2pMarshal

void p2pMarshal(GridKernalContext ctx)
                throws IgniteCheckedException

Deploys and marshals inner objects (called only if peer deployment is enabled).

Parameters:

ctx - Kernal context.

Throws:

IgniteCheckedException - In case of error.

p2pUnmarshal

void p2pUnmarshal(UUID nodeId,
                GridKernalContext ctx)
                  throws IgniteCheckedException

Unmarshals inner objects (called only if peer deployment is enabled).

Parameters:

nodeId - Sender node ID.

ctx - Kernal context.

Throws:

IgniteCheckedException - In case of error.

createBatch

GridContinuousBatch createBatch()

Creates new batch.

Returns:

New batch.

onBatchAcknowledged

void onBatchAcknowledged(UUID routineId,
                       GridContinuousBatch batch,
                       GridKernalContext ctx)

Called when ack for a batch is received from client.

Parameters:

routineId - Routine ID.

batch - Acknowledged batch.

ctx - Kernal context.

orderedTopic

@Nullable
Object orderedTopic()

Returns:

Topic for ordered notifications. If null, notifications will be sent in non-ordered messages.

clone

GridContinuousHandler clone()

Clones this handler.

Returns:

Clone of this handler.

isEvents

boolean isEvents()

Returns:

True if for events.

isMessaging

boolean isMessaging()

Returns:

True if for messaging.

isQuery

boolean isQuery()

Returns:

True if for continuous queries.

keepBinary

boolean keepBinary()

Returns:

True if Ignite Binary objects should be passed to the listener and filter.

cacheName

String cacheName()

Returns:

Cache name if this is a continuous query handler.

updateCounters

void updateCounters(AffinityTopologyVersion topVer,
                  Map<UUID,Map<Integer,Long>> cntrsPerNode,
                  Map<Integer,Long> cntrs)

Parameters:

cntrsPerNode - Init state partition counters for node.

cntrs - Init state for partition counters.

topVer - Topology version.