org.gridgain.grid.events

Class GridCachePreloadingEvent

java.lang.Object

org.gridgain.grid.events.GridEventAdapter

org.gridgain.grid.events.GridCachePreloadingEvent

All Implemented Interfaces:

Serializable, Comparable<GridEvent>, GridEvent

public class GridCachePreloadingEvent
extends GridEventAdapter

In-memory database (cache) preloading event. Preload event happens every time there is a change in grid topology, which means that a node has either joined or left the grid.

Grid events are used for notification about what happens within the grid. Note that by design GridGain keeps all events generated on the local node locally and it provides APIs for performing a distributed queries across multiple nodes:

• GridEvents.remoteQuery(GridPredicate, long, int...) - asynchronously querying events occurred on the nodes specified, including remote nodes.
• GridEvents.localQuery(GridPredicate, int...) - querying only local events stored on this local node.
• GridEvents.localListen(GridPredicate, int...) - listening to local grid events (events from remote nodes not included).

User can also wait for events using method GridEvents.waitForLocal(GridPredicate, int...).

Events and Performance

Note that by default all events in GridGain are enabled and therefore generated and stored by whatever event storage SPI is configured. GridGain can and often does generate thousands events per seconds under the load and therefore it creates a significant additional load on the system. If these events are not needed by the application this load is unnecessary and leads to significant performance degradation.

It is highly recommended to enable only those events that your application logic requires by using GridConfiguration.getIncludeEventTypes() method in GridGain configuration. Note that certain events are required for GridGain's internal operations and such events will still be generated but not stored by event storage SPI if they are disabled in GridGain configuration.

See Also:

GridEventType.EVT_CACHE_PRELOAD_PART_LOADED, GridEventType.EVT_CACHE_PRELOAD_PART_UNLOADED, GridEventType.EVT_CACHE_PRELOAD_STARTED, GridEventType.EVT_CACHE_PRELOAD_STOPPED, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GridCachePreloadingEvent(String cacheName, GridNode node, String msg, int type, int part, GridNode discoNode, int discoEvtType, long discoTs) Constructs cache event.

Method Summary

Methods

Modifier and Type	Method and Description
String	cacheName() Gets cache name.
String	discoveryEventName() Gets name of discovery event that triggered this preloading event.
int	discoveryEventType() Gets type of discovery event that triggered this preloading event.
GridNode	discoveryNode() Gets shadow of the node that triggered this preloading event.
long	discoveryTimestamp() Gets timestamp of discovery event that caused this preloading event.
int	partition() Gets partition for the event.
String	shortDisplay() Gets a shortened version of toString() result.
String	toString()

Methods inherited from class org.gridgain.grid.events.GridEventAdapter

compareTo, equals, hashCode, id, localOrder, message, message, name, node, node, timestamp, type, type

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GridCachePreloadingEvent

public GridCachePreloadingEvent(String cacheName,
                        GridNode node,
                        String msg,
                        int type,
                        int part,
                        GridNode discoNode,
                        int discoEvtType,
                        long discoTs)

Constructs cache event.

Parameters:

cacheName - Cache name.

node - Event node.

msg - Event message.

type - Event type.

part - Partition for the event (usually the partition the key belongs to).

discoNode - Node that triggered this preloading event.

discoEvtType - Discovery event type that triggered this preloading event.

discoTs - Timestamp of discovery event that triggered this preloading event.

Method Detail

cacheName

public String cacheName()

Gets cache name.

Returns:

Cache name.

partition

public int partition()

Gets partition for the event.

Returns:

Partition for the event.

discoveryNode

public GridNode discoveryNode()

Gets shadow of the node that triggered this preloading event.

Returns:

Shadow of the node that triggered this preloading event.

discoveryEventType

public int discoveryEventType()

Gets type of discovery event that triggered this preloading event.

Returns:

Type of discovery event that triggered this preloading event.

See Also:

GridEventAdapter.type()

discoveryEventName

public String discoveryEventName()

Gets name of discovery event that triggered this preloading event.

Returns:

Name of discovery event that triggered this preloading event.

See Also:

GridEventAdapter.name()

discoveryTimestamp

public long discoveryTimestamp()

Gets timestamp of discovery event that caused this preloading event.

Returns:

Timestamp of discovery event that caused this preloading event.

shortDisplay

public String shortDisplay()

Gets a shortened version of toString() result. Suitable for humans to read.

Specified by:

shortDisplay in interface GridEvent

Overrides:

shortDisplay in class GridEventAdapter

Returns:

Shortened version of toString() result.

toString

public String toString()

Overrides:

toString in class GridEventAdapter