org.apache.ignite.events.DiscoveryEvent Maven / Gradle / Ivy
Show all versions of ignite-core Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.ignite.events;
import java.util.Collection;
import org.apache.ignite.cluster.ClusterNode;
import org.apache.ignite.internal.util.typedef.F;
import org.apache.ignite.internal.util.typedef.internal.S;
import org.apache.ignite.internal.util.typedef.internal.U;
/**
* 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:
*
* -
* {@link org.apache.ignite.IgniteEvents#remoteQuery(org.apache.ignite.lang.IgnitePredicate, long, int...)} -
* asynchronously querying events occurred on the nodes specified, including remote nodes.
*
* -
* {@link org.apache.ignite.IgniteEvents#localQuery(org.apache.ignite.lang.IgnitePredicate, int...)} -
* querying only local events stored on this local node.
*
* -
* {@link org.apache.ignite.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 {@link org.apache.ignite.IgniteEvents#waitForLocal(org.apache.ignite.lang.IgnitePredicate, int...)}.
* Events and Performance
* Note 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 {@link org.apache.ignite.configuration.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.
* @see EventType#EVT_NODE_METRICS_UPDATED
* @see EventType#EVT_NODE_FAILED
* @see EventType#EVT_NODE_JOINED
* @see EventType#EVT_NODE_LEFT
* @see EventType#EVT_NODE_SEGMENTED
* @see EventType#EVTS_DISCOVERY_ALL
* @see EventType#EVTS_DISCOVERY
*/
public class DiscoveryEvent extends EventAdapter {
/** */
private static final long serialVersionUID = 0L;
/** */
private ClusterNode evtNode;
/** Topology version. */
private long topVer;
/** Collection of nodes corresponding to topology version. */
private Collection topSnapshot;
/** {@inheritDoc} */
@Override public String shortDisplay() {
return name() + ": id8=" + U.id8(evtNode.id()) + ", ip=" + F.first(evtNode.addresses());
}
/**
* No-arg constructor.
*/
public DiscoveryEvent() {
// No-op.
}
/**
* Creates new discovery event with given parameters.
*
* @param node Local node.
* @param msg Optional event message.
* @param type Event type.
* @param evtNode Node that caused this event to be generated.
*/
public DiscoveryEvent(ClusterNode node, String msg, int type, ClusterNode evtNode) {
super(node, msg, type);
this.evtNode = evtNode;
}
/**
* Sets node this event is referring to.
*
* @param evtNode Event node.
*/
public void eventNode(ClusterNode evtNode) {
this.evtNode = evtNode;
}
/**
* Gets node that caused this event to be generated. It is potentially different from the node
* on which this event was recorded. For example, node {@code A} locally recorded the event that a remote node
* {@code B} joined the topology. In this case this method will return node {@code B}.
*
* @return Event node.
*/
public ClusterNode eventNode() {
return evtNode;
}
/**
* Gets topology version if this event is raised on
* topology change and configured discovery SPI implementation
* supports topology versioning.
*
* @return Topology version or {@code 0} if configured discovery SPI implementation
* does not support versioning.
*/
public long topologyVersion() {
return topVer;
}
/**
* Gets topology nodes from topology snapshot. If SPI implementation does not support
* versioning, the best effort snapshot will be captured.
*
* @return Topology snapshot.
*/
public Collection topologyNodes() {
return topSnapshot;
}
/**
* Sets the topology snapshot.
*
* @param topVer Topology version.
* @param topSnapshot Topology snapshot.
*/
public void topologySnapshot(long topVer, Collection topSnapshot) {
this.topVer = topVer;
this.topSnapshot = topSnapshot;
}
/** {@inheritDoc} */
@Override public String toString() {
return S.toString(DiscoveryEvent.class, this,
"nodeId8", U.id8(node().id()),
"msg", message(),
"type", name(),
"tstamp", timestamp());
}
}