org.gridgain.grid.events

Class GridGgfsEvent

java.lang.Object

org.gridgain.grid.events.GridEventAdapter

org.gridgain.grid.events.GridGgfsEvent

All Implemented Interfaces:

Serializable, Comparable<GridEvent>, GridEvent

public class GridGgfsEvent
extends GridEventAdapter

GGFS event.

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_GGFS_FILE_CREATED, GridEventType.EVT_GGFS_FILE_RENAMED, GridEventType.EVT_GGFS_FILE_DELETED, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GridGgfsEvent(GridGgfsPath path, GridGgfsPath newPath, GridNode node, int type) Constructs an event instance for path modification event (GridEventType.EVT_GGFS_FILE_RENAMED, GridEventType.EVT_GGFS_DIR_RENAMED).
GridGgfsEvent(GridGgfsPath path, GridNode node, int type) Constructs an event instance.
GridGgfsEvent(GridGgfsPath path, GridNode node, int type, long dataSize) Constructs an event instance for close events: (GridEventType.EVT_GGFS_FILE_CLOSED_READ, GridEventType.EVT_GGFS_FILE_CLOSED_WRITE).
GridGgfsEvent(GridGgfsPath path, GridNode node, int type, Map<String,String> meta) Constructs an event instance for file metadata update events (GridEventType.EVT_GGFS_META_UPDATED).

Method Summary

Methods

Modifier and Type	Method and Description
long	dataSize() Transferred data size for this event.
boolean	isDirectory() Checks if this is a directory-related event.
GridGgfsPath	newPath() New file or directory path for this event (used in GridEventType.EVT_GGFS_FILE_RENAMED event).
GridGgfsPath	path() Path of the file or directory, on which event has occurred.
String	toString()
Map<String,String>	updatedMeta() Updated file metadata properties.

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

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

GridGgfsEvent

public GridGgfsEvent(GridGgfsPath path,
             GridNode node,
             int type)

Constructs an event instance.

Parameters:

path - File or directory path.

node - Node.

type - Event type.

GridGgfsEvent

public GridGgfsEvent(GridGgfsPath path,
             GridGgfsPath newPath,
             GridNode node,
             int type)

Constructs an event instance for path modification event (GridEventType.EVT_GGFS_FILE_RENAMED, GridEventType.EVT_GGFS_DIR_RENAMED).

Parameters:

path - File or directory path.

newPath - New file or directory path.

node - Node.

type - Event type.

GridGgfsEvent

public GridGgfsEvent(GridGgfsPath path,
             GridNode node,
             int type,
             long dataSize)

Constructs an event instance for close events: (GridEventType.EVT_GGFS_FILE_CLOSED_READ, GridEventType.EVT_GGFS_FILE_CLOSED_WRITE).

Parameters:

path - File path.

node - Node.

type - Event type.

dataSize - Transferred data size in bytes.

GridGgfsEvent

public GridGgfsEvent(GridGgfsPath path,
             GridNode node,
             int type,
             Map<String,String> meta)

Constructs an event instance for file metadata update events (GridEventType.EVT_GGFS_META_UPDATED).

Parameters:

path - File path.

node - Node.

type - Event type.

meta - Modified properties.

Method Detail

path

public GridGgfsPath path()

Path of the file or directory, on which event has occurred.

Returns:

File path.

newPath

@Nullable
public GridGgfsPath newPath()

New file or directory path for this event (used in GridEventType.EVT_GGFS_FILE_RENAMED event).

Returns:

New file or directory path or null, if not relevant for this event.

dataSize

public long dataSize()

Transferred data size for this event.

Returns:

Transferred data size in bytes.

updatedMeta

@Nullable
public Map<String,String> updatedMeta()

Updated file metadata properties.

Returns:

Updated metadata properties or null, if not relevant for this event.

isDirectory

public boolean isDirectory()

Checks if this is a directory-related event.

Returns:

True if this event is directory-related.

toString

public String toString()

Overrides:

toString in class GridEventAdapter