org.gridgain.grid.kernal

Class GridEventsImpl

java.lang.Object

org.gridgain.grid.kernal.GridEventsImpl

All Implemented Interfaces:

GridEvents

public class GridEventsImpl
extends Object
implements GridEvents

GridEvents implementation.

Constructor Summary

Constructors

Constructor and Description
GridEventsImpl(GridKernalContext ctx, GridProjection prj)

Method Summary

Methods

Modifier and Type	Method and Description
void	disableLocal(int[] types) Disables provided events.
int[]	enabledEvents() Gets types of enabled events.
void	enableLocal(int[] types) Enables provided events.
boolean	isEnabled(int type) Check if event is enabled.
void	localListen(GridPredicate<? extends GridEvent> lsnr, int[] types) Adds an event listener for local events.
<T extends GridEvent> Collection<T>	localQuery(GridPredicate<T> p, int... types) Queries local node for events using passed-in predicate filter for event selection.
GridProjection	projection() Gets grid projection to which this GridMessaging instance belongs.
void	recordLocal(GridEvent evt) Records customer user generated event.
<T extends GridEvent> GridFuture<UUID>	remoteListen(GridBiPredicate<UUID,T> locLsnr, GridPredicate<T> rmtFilter, int... types) Adds event listener for specified events to all nodes in the projection (possibly including local node if it belongs to the projection as well).
<T extends GridEvent> GridFuture<UUID>	remoteListen(int bufSize, long interval, boolean autoUnsubscribe, GridBiPredicate<UUID,T> locLsnr, GridPredicate<T> rmtFilter, int... types) Adds event listener for specified events to all nodes in the projection (possibly including local node if it belongs to the projection as well).
<T extends GridEvent> GridFuture<List<T>>	remoteQuery(GridPredicate<T> p, long timeout, int... types) Asynchronously queries nodes in this projection for events using passed in predicate filter for event selection.
boolean	stopLocalListen(GridPredicate<? extends GridEvent> lsnr, int... types) Removes local event listener.
GridFuture<?>	stopRemoteListen(UUID opId) Stops listening to remote events.
<T extends GridEvent> GridFuture<T>	waitForLocal(GridPredicate<T> filter, int... types) Gets event future that allows for asynchronous waiting for the specified events.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridEventsImpl

public GridEventsImpl(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 GridEvents

Returns:

Grid projection to which this GridMessaging instance belongs.

remoteQuery

public <T extends GridEvent> GridFuture<List<T>> remoteQuery(GridPredicate<T> p,
                                                    long timeout,
                                                    @Nullable
                                                    int... types)

Asynchronously queries nodes in this projection for events using passed in predicate filter for event selection.

Specified by:

remoteQuery in interface GridEvents

Parameters:

p - Predicate filter used to query events on remote nodes.

timeout - Maximum time to wait for result, 0 to wait forever.

types - Event types to be queried.

Returns:

Collection of grid events returned from specified nodes.

remoteListen

public <T extends GridEvent> GridFuture<UUID> remoteListen(@Nullable
                                                  GridBiPredicate<UUID,T> locLsnr,
                                                  @Nullable
                                                  GridPredicate<T> rmtFilter,
                                                  @Nullable
                                                  int... types)

Adds event listener for specified events to all nodes in the projection (possibly including local node if it belongs to the projection as well). This means that all events occurring on any node within this grid projection that pass remove filter will be sent to local node for local listener notification.

The listener can be unsubscribed automatically if local node stops, if locLsnr callback returns false or if GridEvents.stopRemoteListen(UUID) is called.

Specified by:

remoteListen in interface GridEvents

Type Parameters:

T - Type of the event.

Parameters:

locLsnr - Listener callback that is called on local node. If null, this events will be handled on remote nodes by passed in rmtFilter.

rmtFilter - Filter callback that is called on remote node. Only events that pass the remote filter will be sent to local node. If null, all events of specified types will be sent to local node. This remote filter can be used to pre-handle events remotely, before they are passed in to local callback. It will be auto-unsubsribed on the node where event occurred in case if it returns false.

types - Types of events to listen for. If not provided, all events that pass the provided remote filter will be sent to local node.

Returns:

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

remoteListen

public <T extends GridEvent> GridFuture<UUID> remoteListen(int bufSize,
                                                  long interval,
                                                  boolean autoUnsubscribe,
                                                  @Nullable
                                                  GridBiPredicate<UUID,T> locLsnr,
                                                  @Nullable
                                                  GridPredicate<T> rmtFilter,
                                                  @Nullable
                                                  int... types)

Adds event listener for specified events to all nodes in the projection (possibly including local node if it belongs to the projection as well). This means that all events occurring on any node within this grid projection that pass remove filter will be sent to local node for local listener notification.

Specified by:

remoteListen in interface GridEvents

Type Parameters:

T - Type of the event.

Parameters:

bufSize - Remote events buffer size. Events from remote nodes won't be sent until buffer is full or time interval is exceeded.

interval - Maximum time interval after which events from remote node will be sent. Events from remote nodes won't be sent until buffer is full or time interval is exceeded.

autoUnsubscribe - Flag indicating that event listeners on remote nodes should be automatically unregistered if master node (node that initiated event listening) leaves topology. If this flag is false, listeners will be unregistered only when GridEvents.stopRemoteListen(UUID) method is called, or the 'callback (locLsnr)' passed in returns false.

locLsnr - Callback that is called on local node. If this predicate returns true, the implementation will continue listening to events. Otherwise, events listening will be stopped and listeners will be unregistered on all nodes in the projection. If null, this events will be handled on remote nodes by passed in rmtFilter until local node stops (if 'autoUnsubscribe' is true) or until GridEvents.stopRemoteListen(UUID) is called.

rmtFilter - Filter callback that is called on remote node. Only events that pass the remote filter will be sent to local node. If null, all events of specified types will be sent to local node. This remote filter can be used to pre-handle events remotely, before they are passed in to local callback. It will be auto-unsubsribed on the node where event occurred in case if it returns false.

types - Types of events to listen for. If not provided, all events that pass the provided remote filter will be sent to local node.

Returns:

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

See Also:

GridEvents.stopRemoteListen(UUID)

stopRemoteListen

public GridFuture<?> stopRemoteListen(UUID opId)

Stops listening to remote events. This will unregister all listeners identified with provided operation ID on all nodes defined by GridEvents.projection().

Specified by:

stopRemoteListen in interface GridEvents

Parameters:

opId - Operation ID that was returned from GridEvents.remoteListen(GridBiPredicate, GridPredicate, int...) method.

Returns:

Future that finishes when all listeners are unregistered.

See Also:

GridEvents.remoteListen(GridBiPredicate, GridPredicate, int...)

waitForLocal

public <T extends GridEvent> GridFuture<T> waitForLocal(@Nullable
                                               GridPredicate<T> filter,
                                               @Nullable
                                               int... types)

Gets event future that allows for asynchronous waiting for the specified events. This method returns a future which by calling one of its get methods will block and wait for the specified event (either indefinitely or with provided timeout).

Specified by:

waitForLocal in interface GridEvents

Parameters:

filter - Optional filtering predicate. Only if predicates evaluates to true will the event end the wait.

types - Types of the events to wait for. If not provided, all events will be passed to the filter.

Returns:

Grid event future.

localQuery

public <T extends GridEvent> Collection<T> localQuery(GridPredicate<T> p,
                                             @Nullable
                                             int... types)

Queries local node for events using passed-in predicate filter for event selection.

Specified by:

localQuery in interface GridEvents

Parameters:

p - Predicate to filter events. All predicates must be satisfied for the event to be returned.

types - Event types to be queried.

Returns:

Collection of grid events found on local node.

recordLocal

public void recordLocal(GridEvent evt)

Records customer user generated event. All registered local listeners will be notified.

NOTE: all types in range from 1 to 1000 are reserved for internal GridGain events and should not be used by user-defined events. Attempt to record internal event with this method will cause IllegalArgumentException to be thrown.

Specified by:

recordLocal in interface GridEvents

Parameters:

evt - Locally generated event.

localListen

public void localListen(GridPredicate<? extends GridEvent> lsnr,
               int[] types)

Adds an event listener for local events. Note that listener will be added regardless of whether local node is in this projection or not.

Specified by:

localListen in interface GridEvents

Parameters:

lsnr - Predicate that is called on each received event. If predicate returns false, it will be unregistered and will stop receiving events.

types - Event types for which this listener will be notified.

stopLocalListen

public boolean stopLocalListen(GridPredicate<? extends GridEvent> lsnr,
                      @Nullable
                      int... types)

Removes local event listener.

Specified by:

stopLocalListen in interface GridEvents

Parameters:

lsnr - Local event listener to remove.

types - Types of events for which to remove listener. If not specified, then listener will be removed for all types it was registered for.

Returns:

true if listener was removed, false otherwise.

enableLocal

public void enableLocal(int[] types)

Enables provided events. Allows to start recording events that were disabled before. Note that specified events will be enabled regardless of whether local node is in this projection or not.

Specified by:

enableLocal in interface GridEvents

Parameters:

types - Events to enable.

disableLocal

public void disableLocal(int[] types)

Disables provided events. Allows to stop recording events that were enabled before. Note that specified events will be disabled regardless of whether local node is in this projection or not.

Specified by:

disableLocal in interface GridEvents

Parameters:

types - Events to disable.

enabledEvents

public int[] enabledEvents()

Gets types of enabled events.

Specified by:

enabledEvents in interface GridEvents

Returns:

Types of enabled events.

isEnabled

public boolean isEnabled(int type)

Check if event is enabled.

Specified by:

isEnabled in interface GridEvents

Parameters:

type - Event type.

Returns:

True if event of passed in type is enabled.