org.gridgain.grid.kernal.managers.eventstorage

Class GridEventStorageManager

java.lang.Object

org.gridgain.grid.kernal.managers.GridManagerAdapter<GridEventStorageSpi>

org.gridgain.grid.kernal.managers.eventstorage.GridEventStorageManager

All Implemented Interfaces:

GridComponent, GridManager

public class GridEventStorageManager
extends GridManagerAdapter<GridEventStorageSpi>

Grid event storage SPI manager.

Field Summary

Fields inherited from class org.gridgain.grid.kernal.managers.GridManagerAdapter

ctx, log

Constructor Summary

Constructors

Constructor and Description
GridEventStorageManager(GridKernalContext ctx)

Method Summary

Methods

Modifier and Type	Method and Description
void	addLocalEventListener(GridLocalEventListener lsnr, int[] types) Adds local event listener.
void	addLocalEventListener(GridLocalEventListener lsnr, int type, int... types) Adds local event listener.
void	addLocalEventListener(GridPredicate<? extends GridEvent> lsnr, int[] types) Adds local user event listener.
void	disableEvents(int[] types) Disables provided events.
int[]	enabledEvents() Gets types of enabled user-recordable events.
void	enableEvents(int[] types) Enables provided events.
boolean	isAllUserRecordable(int[] types) Checks whether all provided events are user-recordable.
boolean	isRecordable(int type) Checks whether this event type should be recorded.
boolean	isUserRecordable(int type) Checks if the event type is user-recordable.
<T extends GridEvent> Collection<T>	localEvents(GridPredicate<T> p)
void	onKernalStop0(boolean cancel)
void	printMemoryStats() Prints memory statistics (sizes of internal structures, etc.).
void	record(GridEvent evt) Records event if it's recordable.
<T extends GridEvent> GridFuture<List<T>>	remoteEventsAsync(GridPredicate<T> p, Collection<? extends GridNode> nodes, long timeout)
boolean	removeLocalEventListener(GridLocalEventListener lsnr, int... types) Removes listener for specified events, if any.
boolean	removeLocalEventListener(GridPredicate<? extends GridEvent> lsnr, int... types) Removes user listener for specified events, if any.
void	start() Starts grid component.
void	stop(boolean cancel) Stops grid component.
<T extends GridEvent> GridFuture<T>	waitForEvent(GridPredicate<T> p, int... types)
GridEvent	waitForEvent(long timeout, Runnable c, GridPredicate<? super GridEvent> p, int... types)

Methods inherited from class org.gridgain.grid.kernal.managers.GridManagerAdapter

addSpiAttributes, assertParameter, collectDiscoveryData, enabled, getSpi, getSpi, getSpis, onDiscoveryDataReceived, onKernalStart, onKernalStart0, onKernalStop, startInfo, startSpi, stopInfo, stopSpi, toString, validateNode

Methods inherited from class java.lang.Object

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

Constructor Detail

GridEventStorageManager

public GridEventStorageManager(GridKernalContext ctx)

Parameters:

ctx - Kernal context.

Method Detail

printMemoryStats

public void printMemoryStats()

Prints memory statistics (sizes of internal structures, etc.). NOTE: this method is for testing and profiling purposes only.

Specified by:

printMemoryStats in interface GridComponent

Overrides:

printMemoryStats in class GridManagerAdapter<GridEventStorageSpi>

onKernalStop0

public void onKernalStop0(boolean cancel)

Overrides:

onKernalStop0 in class GridManagerAdapter<GridEventStorageSpi>

Parameters:

cancel - Cancel flag.

stop

public void stop(boolean cancel)
          throws GridException

Stops grid component.

Parameters:

cancel - If true, then all ongoing tasks or jobs for relevant components need to be cancelled.

Throws:

GridException - Thrown in case of any errors.

start

public void start()
           throws GridException

Starts grid component.

Throws:

GridException - Throws in case of any errors.

record

public void record(GridEvent evt)

Records event if it's recordable.

Parameters:

evt - Event to record.

enabledEvents

public int[] enabledEvents()

Gets types of enabled user-recordable events.

Returns:

Array of types of enabled user-recordable events.

enableEvents

public void enableEvents(int[] types)

Enables provided events.

Parameters:

types - Events to enable.

disableEvents

public void disableEvents(int[] types)

Disables provided events.

Parameters:

types - Events to disable.

isUserRecordable

public boolean isUserRecordable(int type)

Checks if the event type is user-recordable.

Parameters:

type - Event type to check.

Returns:

true if passed event should be recorded, false - otherwise.

isRecordable

public boolean isRecordable(int type)

Checks whether this event type should be recorded. Note that internal event types are always recordable for notification purposes but may not be sent down to SPI level for storage and subsequent querying.

Parameters:

type - Event type to check.

Returns:

Whether or not this event type should be recorded.

isAllUserRecordable

public boolean isAllUserRecordable(int[] types)

Checks whether all provided events are user-recordable.

Note that this method supports only predefined GridGain events.

Parameters:

types - Event types.

Returns:

Whether all events are recordable.

Throws:

IllegalArgumentException - If types contains user event type.

addLocalEventListener

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

Adds local user event listener.

Parameters:

lsnr - User listener to add.

types - Event types to subscribe listener for.

addLocalEventListener

public void addLocalEventListener(GridLocalEventListener lsnr,
                         int[] types)

Adds local event listener. Note that this method specifically disallow an empty array of event type to prevent accidental subscription for all system event that may lead to a drastic performance decrease.

Parameters:

lsnr - Listener to add.

types - Event types to subscribe listener for.

addLocalEventListener

public void addLocalEventListener(GridLocalEventListener lsnr,
                         int type,
                         @Nullable
                         int... types)

Adds local event listener.

Parameters:

lsnr - Listener to add.

type - Event type to subscribe listener for.

types - Additional event types to subscribe listener for.

removeLocalEventListener

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

Removes user listener for specified events, if any. If no event types provided - it removes the listener for all its registered events.

Parameters:

lsnr - User listener predicate.

types - Event types.

Returns:

Returns true if removed.

removeLocalEventListener

public boolean removeLocalEventListener(GridLocalEventListener lsnr,
                               @Nullable
                               int... types)

Removes listener for specified events, if any. If no event types provided - it remove the listener for all its registered events.

Parameters:

lsnr - Listener.

types - Event types.

Returns:

Returns true if removed.

waitForEvent

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

Parameters:

p - Optional predicate.

types - Event types to wait for.

Returns:

Event future.

waitForEvent

public GridEvent waitForEvent(long timeout,
                     @Nullable
                     Runnable c,
                     @Nullable
                     GridPredicate<? super GridEvent> p,
                     int... types)
                       throws GridException

Parameters:

timeout - Timeout.

c - Optional continuation.

p - Optional predicate.

types - Event types to wait for.

Returns:

Event.

Throws:

GridException - Thrown in case of any errors.

localEvents

public <T extends GridEvent> Collection<T> localEvents(GridPredicate<T> p)

Parameters:

p - Grid event predicate.

Returns:

Collection of grid events.

remoteEventsAsync

public <T extends GridEvent> GridFuture<List<T>> remoteEventsAsync(GridPredicate<T> p,
                                                          Collection<? extends GridNode> nodes,
                                                          long timeout)

Parameters:

p - Grid event predicate.

nodes - Collection of nodes.

timeout - Maximum time to wait for result, if 0, then wait until result is received.

Returns:

Collection of events.