org.gridgain.grid.events

Class DrCacheFstEvent

java.lang.Object

org.apache.ignite.events.EventAdapter

org.gridgain.grid.events.DrCacheFstEvent

All Implemented Interfaces:

Serializable, Comparable<Event>, Event

public class DrCacheFstEvent
extends EventAdapter

Cache full state transfer event.

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

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

User can also wait for events using method IgniteEvents.waitForLocal(org.apache.ignite.lang.IgnitePredicate, int...).

Events and Performance

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

See Also:

EventType.EVT_DR_CACHE_FST_STARTED, EventType.EVT_DR_CACHE_FST_FINISHED, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DrCacheFstEvent() No-arg constructor.
DrCacheFstEvent(ClusterNode node, String msg, int type, String name, Collection<Byte> dcIds) Creates cache full state transfer event with given parameters.
DrCacheFstEvent(ClusterNode node, String msg, int type, String name, Collection<Byte> dcIds, long entriesCnt) Creates cache full state transfer event with given parameters.

Method Summary

Modifier and Type	Method and Description
String	cacheName() Returns name of the cache that should be transferred to the remote sites.
Collection<Byte>	dcIds() Returns ids of data centers that should store the replica of the cache.
long	getEntriesCnt() Returns total number of entries which were successfully transferred via FST or -1 if inapplicable.
String	toString()

Methods inherited from class org.apache.ignite.events.EventAdapter

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DrCacheFstEvent

public DrCacheFstEvent()

No-arg constructor.

DrCacheFstEvent

public DrCacheFstEvent(ClusterNode node,
                       String msg,
                       int type,
                       String name,
                       Collection<Byte> dcIds)

Creates cache full state transfer event with given parameters.

Parameters:

node - Source node of the event.

msg - Optional message.

type - Event type.

name - Cache name.

dcIds - Ids of data centers.

DrCacheFstEvent

public DrCacheFstEvent(ClusterNode node,
                       String msg,
                       int type,
                       String name,
                       Collection<Byte> dcIds,
                       long entriesCnt)

Creates cache full state transfer event with given parameters.

Parameters:

node - Source node of the event.

msg - Optional message.

type - Event type.

name - Cache name.

dcIds - Ids of data centers.

entriesCnt - Total number of entries which were successfully transferred via FST.

Method Detail

cacheName

public String cacheName()

Returns name of the cache that should be transferred to the remote sites.

Returns:

Name of the cache.

dcIds

public Collection<Byte> dcIds()

Returns ids of data centers that should store the replica of the cache.

Returns:

Ids of the data centers.

getEntriesCnt

public long getEntriesCnt()

Returns total number of entries which were successfully transferred via FST or -1 if inapplicable.

toString

public String toString()

Overrides:

toString in class EventAdapter