org.apache.ignite.internal

Class GridMessageListenHandler

java.lang.Object

org.apache.ignite.internal.GridMessageListenHandler

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, GridContinuousHandler

public class GridMessageListenHandler
extends Object
implements GridContinuousHandler

Continuous handler for message subscription.

See Also:

Serialized Form

Nested Class Summary

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

GridContinuousHandler.RegisterStatus

Constructor Summary

Constructors

Constructor and Description
GridMessageListenHandler() Required by Externalizable.
GridMessageListenHandler(Object topic, IgniteBiPredicate<UUID,Object> pred)

Method Summary

Methods

Modifier and Type	Method and Description
String	cacheName()
GridContinuousHandler	clone() Clones this handler.
boolean	isForEvents()
boolean	isForMessaging()
boolean	isForQuery()
void	notifyCallback(UUID nodeId, UUID routineId, Collection<?> objs, GridKernalContext ctx) Notifies local callback.
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).
void	readExternal(ObjectInput in)
GridContinuousHandler.RegisterStatus	register(UUID nodeId, UUID routineId, GridKernalContext ctx) Registers listener.
String	toString()
void	unregister(UUID routineId, GridKernalContext ctx) Unregisters listener.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GridMessageListenHandler

public GridMessageListenHandler()

Required by Externalizable.

GridMessageListenHandler

public GridMessageListenHandler(@Nullable
                        Object topic,
                        IgniteBiPredicate<UUID,Object> pred)

Parameters:

topic - Topic.

pred - Predicate.

Method Detail

isForEvents

public boolean isForEvents()

Specified by:

isForEvents in interface GridContinuousHandler

Returns:

True if for events.

isForMessaging

public boolean isForMessaging()

Specified by:

isForMessaging in interface GridContinuousHandler

Returns:

True if for messaging.

isForQuery

public boolean isForQuery()

Specified by:

isForQuery in interface GridContinuousHandler

Returns:

True if for continuous queries.

cacheName

public String cacheName()

Specified by:

cacheName in interface GridContinuousHandler

Returns:

Cache name if this is a continuous query handler.

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.

onListenerRegistered

public void onListenerRegistered(UUID routineId,
                        GridKernalContext ctx)

Callback called after listener is registered and acknowledgement is sent.

Specified by:

onListenerRegistered in interface GridContinuousHandler

Parameters:

routineId - Routine ID.

ctx - Kernal context.

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.

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.

orderedTopic

@Nullable
public 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.

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

toString

public String toString()

Overrides:

toString in class Object