org.gridgain.grid.spi.discovery.tcp.messages

Class GridTcpDiscoveryHeartbeatMessage

java.lang.Object

org.gridgain.grid.spi.discovery.tcp.messages.GridTcpDiscoveryAbstractMessage

org.gridgain.grid.spi.discovery.tcp.messages.GridTcpDiscoveryHeartbeatMessage

All Implemented Interfaces:

Externalizable, Serializable

public class GridTcpDiscoveryHeartbeatMessage
extends GridTcpDiscoveryAbstractMessage

Heartbeat message.

It is sent by coordinator node across the ring once a configured period. In case if topology does not use metrics store, message makes two passes.

1. During first pass, all nodes add their metrics to the message and update local metrics with metrics currently present in the message.
2. During second pass, all nodes update all metrics present in the message and remove their own metrics from the message.

When message reaches coordinator second time it is discarded (it finishes the second pass).

If topology uses metrics store then message makes only one pass and metrics map is always empty. Nodes exchange their metrics using metrics store.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GridTcpDiscoveryHeartbeatMessage() Public default no-arg constructor for Externalizable interface.
GridTcpDiscoveryHeartbeatMessage(UUID creatorNodeId) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasMetrics()
boolean	hasMetrics(UUID nodeId)
Map<UUID,GridNodeMetrics>	metrics() Gets metrics map.
void	readExternal(ObjectInput in)
void	removeMetrics(UUID nodeId) Removes metrics for particular node from the message.
void	setMetrics(UUID nodeId, GridNodeMetrics metrics) Sets metrics for particular node.
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class org.gridgain.grid.spi.discovery.tcp.messages.GridTcpDiscoveryAbstractMessage

creatorNodeId, equals, hashCode, id, senderNodeId, senderNodeId, topologyVersion, topologyVersion, verified, verifierNodeId, verify

Methods inherited from class java.lang.Object

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

Constructor Detail

GridTcpDiscoveryHeartbeatMessage

public GridTcpDiscoveryHeartbeatMessage()

Public default no-arg constructor for Externalizable interface.

GridTcpDiscoveryHeartbeatMessage

public GridTcpDiscoveryHeartbeatMessage(UUID creatorNodeId)

Constructor.

Parameters:

creatorNodeId - Creator node.

Method Detail

setMetrics

public void setMetrics(UUID nodeId,
              GridNodeMetrics metrics)

Sets metrics for particular node.

Parameters:

nodeId - Node ID.

metrics - Node metrics.

removeMetrics

public void removeMetrics(UUID nodeId)

Removes metrics for particular node from the message.

Parameters:

nodeId - Node ID.

metrics

public Map<UUID,GridNodeMetrics> metrics()

Gets metrics map.

Returns:

Metrics map.

hasMetrics

public boolean hasMetrics()

Returns:

True if this message contains metrics.

hasMetrics

public boolean hasMetrics(UUID nodeId)

Returns:

True if this message contains metrics.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class GridTcpDiscoveryAbstractMessage

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class GridTcpDiscoveryAbstractMessage

Throws:

IOException

ClassNotFoundException

toString

public String toString()

Overrides:

toString in class GridTcpDiscoveryAbstractMessage