org.gridgain.grid.kernal

Class GridMessagingImpl

java.lang.Object

org.gridgain.grid.kernal.GridMessagingImpl

All Implemented Interfaces:

GridMessaging

public class GridMessagingImpl
extends Object
implements GridMessaging

GridMessaging implementation.

Constructor Summary

Constructors

Constructor and Description
GridMessagingImpl(GridKernalContext ctx, GridProjection prj)

Method Summary

Methods

Modifier and Type	Method and Description
void	localListen(Object topic, GridBiPredicate<UUID,?> p) Adds local listener for given topic on local node only.
GridProjection	projection() Gets grid projection to which this GridMessaging instance belongs.
GridFuture<UUID>	remoteListen(Object topic, GridBiPredicate<UUID,?> p) Adds a message listener for a given topic to all nodes in the projection (possibly including this node if it belongs to the projection as well).
void	send(Object topic, Collection<?> msgs) Sends given messages with specified topic to the nodes in this projection.
void	send(Object topic, Object msg) Sends given message with specified topic to the nodes in this projection.
void	sendOrdered(Object topic, Object msg, long timeout) Sends given message with specified topic to the nodes in this projection.
void	stopLocalListen(Object topic, GridBiPredicate<UUID,?> p) Unregisters local listener for given topic on local node only.
GridFuture<?>	stopRemoteListen(UUID opId) Unregisters all listeners identified with provided operation ID on all nodes in this projection.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridMessagingImpl

public GridMessagingImpl(GridKernalContext ctx,
                 GridProjection prj)

Parameters:

ctx - Kernal context.

prj - Projection.

Method Detail

projection

public GridProjection projection()

Gets grid projection to which this GridMessaging instance belongs.

Specified by:

projection in interface GridMessaging

Returns:

Grid projection to which this GridMessaging instance belongs.

send

public void send(@Nullable
        Object topic,
        Object msg)
          throws GridException

Sends given message with specified topic to the nodes in this projection.

Specified by:

send in interface GridMessaging

Parameters:

topic - Topic to send to, null for default topic.

msg - Message to send.

Throws:

GridException - If failed to send a message to any of the nodes.

GridEmptyProjectionException - Thrown in case when this projection is empty.

send

public void send(@Nullable
        Object topic,
        Collection<?> msgs)
          throws GridException

Sends given messages with specified topic to the nodes in this projection.

Specified by:

send in interface GridMessaging

Parameters:

topic - Topic to send to, null for default topic.

msgs - Messages to send. Order of the sending is undefined. If the method produces the exception none or some messages could have been sent already.

Throws:

GridException - If failed to send a message to any of the nodes.

GridEmptyProjectionException - Thrown in case when this projection is empty.

sendOrdered

public void sendOrdered(@Nullable
               Object topic,
               Object msg,
               long timeout)
                 throws GridException

Sends given message with specified topic to the nodes in this projection. Messages sent with this method will arrive in the same order they were sent. Note that if a topic is used for ordered messages, then it cannot be reused for non-ordered messages.

The timeout parameter specifies how long an out-of-order message will stay in a queue, waiting for messages that are ordered ahead of it to arrive. If timeout expires, then all ordered messages that have not arrived before this message will be skipped. When (and if) expired messages actually do arrive, they will be ignored.

Specified by:

sendOrdered in interface GridMessaging

Parameters:

topic - Topic to send to, null for default topic.

msg - Message to send.

timeout - Message timeout in milliseconds, 0 for default which is GridConfiguration.getNetworkTimeout().

Throws:

GridException - If failed to send a message to any of the nodes.

GridEmptyProjectionException - Thrown in case when this projection is empty.

localListen

public void localListen(@Nullable
               Object topic,
               GridBiPredicate<UUID,?> p)

Adds local listener for given topic on local node only. This listener will be notified whenever any node within grid projection will send a message for a given topic to this node. Local listen subscription will happen regardless of whether local node belongs to this grid projection or not.

Specified by:

localListen in interface GridMessaging

Parameters:

topic - Topic to subscribe to.

p - Predicate that is called on each received message. If predicate returns false, then it will be unsubscribed from any further notifications.

stopLocalListen

public void stopLocalListen(@Nullable
                   Object topic,
                   GridBiPredicate<UUID,?> p)

Unregisters local listener for given topic on local node only.

Specified by:

stopLocalListen in interface GridMessaging

Parameters:

topic - Topic to unsubscribe from.

p - Listener predicate.

remoteListen

public GridFuture<UUID> remoteListen(@Nullable
                            Object topic,
                            GridBiPredicate<UUID,?> p)

Adds a message listener for a given topic to all nodes in the projection (possibly including this node if it belongs to the projection as well). This means that any node within this grid projection can send a message for a given topic and all nodes within projection will receive listener notification.

Specified by:

remoteListen in interface GridMessaging

Parameters:

topic - Topic to subscribe to, null means default topic.

p - Predicate that is called on each node for each received message. If predicate returns false, then it will be unsubscribed from any further notifications.

Returns:

Future that finishes when all listeners are registered. It returns operation ID that can be passed to GridMessaging.stopRemoteListen(UUID) method to stop listening.

stopRemoteListen

public GridFuture<?> stopRemoteListen(UUID opId)

Unregisters all listeners identified with provided operation ID on all nodes in this projection.

Specified by:

stopRemoteListen in interface GridMessaging

Parameters:

opId - Listen ID that was returned from GridMessaging.remoteListen(Object, GridBiPredicate) method.

Returns:

Future that finishes when all listeners are unregistered.