Package org.apache.ignite.events
Class DiscoveryEvent
- java.lang.Object
- 
- org.apache.ignite.events.EventAdapter
- 
- org.apache.ignite.events.DiscoveryEvent
 
 
- 
- All Implemented Interfaces:
- Serializable,- Comparable<Event>,- Event
 
 public class DiscoveryEvent extends EventAdapter Grid discovery 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).
 IgniteEvents.waitForLocal(org.apache.ignite.lang.IgnitePredicate, int...).Events and PerformanceNote that by default all events in Ignite are enabled and therefore generated and stored by whatever event storage SPI is configured. Ignite 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 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 SPI if they are disabled in Ignite configuration.
- 
- 
Constructor SummaryConstructors Constructor Description DiscoveryEvent()No-arg constructor.DiscoveryEvent(ClusterNode node, String msg, int type, ClusterNode evtNode)Creates new discovery event with given parameters.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description ClusterNodeeventNode()Gets node that caused this event to be generated.voideventNode(ClusterNode evtNode)Sets node this event is referring to.@Nullable Stringmessage()Gets optional message for this event.voidmessageTemplate(String msgTemplate)Template to generatemessage()lazily.StringshortDisplay()Gets a shortened version oftoString()result.org.apache.ignite.internal.processors.tracing.Spanspan()Gets span instance.voidspan(org.apache.ignite.internal.processors.tracing.Span span)Set span.Collection<ClusterNode>topologyNodes()Gets topology nodes from topology snapshot.voidtopologySnapshot(long topVer, Collection<ClusterNode> topSnapshot)Sets the topology snapshot.longtopologyVersion()Gets topology version if this event is raised on topology change and configured discovery SPI implementation supports topology versioning.StringtoString()
 
- 
- 
- 
Constructor Detail- 
DiscoveryEventpublic DiscoveryEvent() No-arg constructor.
 - 
DiscoveryEventpublic DiscoveryEvent(ClusterNode node, String msg, int type, ClusterNode evtNode) Creates new discovery event with given parameters.- Parameters:
- node- Local node.
- msg- Optional event message.
- type- Event type.
- evtNode- Node that caused this event to be generated.
 
 
- 
 - 
Method Detail- 
shortDisplaypublic String shortDisplay() Gets a shortened version oftoString()result. Suitable for humans to read.- Specified by:
- shortDisplayin interface- Event
- Overrides:
- shortDisplayin class- EventAdapter
- Returns:
- Shortened version of toString()result.
 
 - 
eventNodepublic void eventNode(ClusterNode evtNode) Sets node this event is referring to.- Parameters:
- evtNode- Event node.
 
 - 
eventNodepublic ClusterNode eventNode() Gets node that caused this event to be generated. It is potentially different from the node on which this event was recorded. For example, nodeAlocally recorded the event that a remote nodeBjoined the topology. In this case this method will return nodeB.- Returns:
- Event node.
 
 - 
topologyVersionpublic long topologyVersion() Gets topology version if this event is raised on topology change and configured discovery SPI implementation supports topology versioning.- Returns:
- Topology version or 0if configured discovery SPI implementation does not support versioning.
 
 - 
topologyNodespublic Collection<ClusterNode> topologyNodes() Gets topology nodes from topology snapshot. If SPI implementation does not support versioning, the best effort snapshot will be captured.- Returns:
- Topology snapshot.
 
 - 
topologySnapshotpublic void topologySnapshot(long topVer, Collection<ClusterNode> topSnapshot)Sets the topology snapshot.- Parameters:
- topVer- Topology version.
- topSnapshot- Topology snapshot.
 
 - 
messageTemplatepublic void messageTemplate(String msgTemplate) Template to generatemessage()lazily. Will be joined witheventNode()converted to string.- Parameters:
- msgTemplate- Template.
 
 - 
message@Nullable public @Nullable String message() Gets optional message for this event.- Specified by:
- messagein interface- Event
- Overrides:
- messagein class- EventAdapter
- Returns:
- Optional (can be null) message for this event.
 
 - 
spanpublic org.apache.ignite.internal.processors.tracing.Span span() Gets span instance.- Returns:
- Span.
 
 - 
spanpublic void span(org.apache.ignite.internal.processors.tracing.Span span) Set span.- Parameters:
- span- Span.
 
 - 
toStringpublic String toString() - Overrides:
- toStringin class- EventAdapter
 
 
- 
 
-