org.apache.ignite.spi.discovery.tcp.messages

Class TcpDiscoveryHeartbeatMessage

java.lang.Object

org.apache.ignite.spi.discovery.tcp.messages.TcpDiscoveryAbstractMessage

org.apache.ignite.spi.discovery.tcp.messages.TcpDiscoveryHeartbeatMessage

All Implemented Interfaces:

Externalizable, Serializable

@TcpDiscoveryRedirectToClient
public class TcpDiscoveryHeartbeatMessage
extends TcpDiscoveryAbstractMessage

Heartbeat message.

It is sent by coordinator node across the ring once a configured period. 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).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TcpDiscoveryHeartbeatMessage.MetricsSet

Field Summary

Fields inherited from class org.apache.ignite.spi.discovery.tcp.messages.TcpDiscoveryAbstractMessage

CLIENT_FLAG_POS, CLIENT_RECON_SUCCESS_FLAG_POS, RESPONDED_FLAG_POS

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addClientNodeId(UUID clientNodeId) Adds client node ID.
Collection<UUID>	clientNodeIds() Gets client node IDs for particular node.
boolean	hasMetrics()
boolean	hasMetrics(UUID nodeId)
Map<UUID,TcpDiscoveryHeartbeatMessage.MetricsSet>	metrics() Gets metrics map.
void	readExternal(ObjectInput in)
void	removeMetrics(UUID nodeId) Removes metrics for particular node from the message.
void	setClientMetrics(UUID nodeId, UUID clientNodeId, ClusterMetrics metrics) Sets metrics for a client node.
void	setMetrics(UUID nodeId, ClusterMetrics metrics) Sets metrics for particular node.
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class org.apache.ignite.spi.discovery.tcp.messages.TcpDiscoveryAbstractMessage

client, client, creatorNodeId, destinationClientNodeId, destinationClientNodeId, equals, getFlag, hashCode, id, pendingIndex, pendingIndex, senderNodeId, senderNodeId, setFlag, topologyVersion, topologyVersion, verified, verifierNodeId, verify

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpDiscoveryHeartbeatMessage

public TcpDiscoveryHeartbeatMessage()

Public default no-arg constructor for Externalizable interface.

TcpDiscoveryHeartbeatMessage

public TcpDiscoveryHeartbeatMessage(UUID creatorNodeId)

Constructor.

Parameters:

creatorNodeId - Creator node.

Method Detail

setMetrics

public void setMetrics(UUID nodeId,
              ClusterMetrics metrics)

Sets metrics for particular node.

Parameters:

nodeId - Node ID.

metrics - Node metrics.

setClientMetrics

public void setClientMetrics(UUID nodeId,
                    UUID clientNodeId,
                    ClusterMetrics metrics)

Sets metrics for a client node.

Parameters:

nodeId - Server node ID.

clientNodeId - Client 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,TcpDiscoveryHeartbeatMessage.MetricsSet> 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.

clientNodeIds

public Collection<UUID> clientNodeIds()

Gets client node IDs for particular node.

Returns:

Client node IDs.

addClientNodeId

public void addClientNodeId(UUID clientNodeId)

Adds client node ID.

Parameters:

clientNodeId - Client node ID.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class TcpDiscoveryAbstractMessage

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class TcpDiscoveryAbstractMessage

Throws:

IOException

ClassNotFoundException

toString

public String toString()

Overrides:

toString in class TcpDiscoveryAbstractMessage