org.apache.flink.runtime.topology

Class NetworkNode

java.lang.Object

org.apache.flink.runtime.topology.NetworkNode

All Implemented Interfaces:

IOReadableWritable

Direct Known Subclasses:

Instance

public class NetworkNode
extends Object
implements IOReadableWritable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NetworkNode(String name, NetworkNode parentNode, NetworkTopology networkTopology)

Method Summary

Methods

Modifier and Type	Method and Description
NetworkNode	getChildNode(int index)
int	getDepth()
int	getDistance(NetworkNode networkNode) Determines the distance to the given network node.
int	getDistance(String nodeName)
int	getHeight()
String	getName()
NetworkTopology	getNetworkTopology() Returns the network topology that is associated with this network node.
int	getNumberOfChildNodes()
NetworkNode	getParentNode()
boolean	isLeafNode()
boolean	isRootNode()
void	read(DataInputView in)
void	remove()
String	toString()
void	write(DataOutputView out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NetworkNode

protected NetworkNode(String name,
           NetworkNode parentNode,
           NetworkTopology networkTopology)

Method Detail

remove

public void remove()

isRootNode

public boolean isRootNode()

isLeafNode

public boolean isLeafNode()

getName

public String getName()

getDepth

public int getDepth()

getHeight

public int getHeight()

getNumberOfChildNodes

public int getNumberOfChildNodes()

getChildNode

public NetworkNode getChildNode(int index)

getParentNode

public NetworkNode getParentNode()

getNetworkTopology

public NetworkTopology getNetworkTopology()

Returns the network topology that is associated with this network node.

Returns:

the network topology that is associated with this network node

getDistance

public int getDistance(NetworkNode networkNode)

Determines the distance to the given network node. The distance is determined as the number of internal network nodes that must be traversed in order to send a packet from one node to the other plus one.

Parameters:

networkNode - the node to determine the distance for

Returns:

the distance to the given network node or Integer.MAX_VALUE if the given node is not part of this node's network topology

getDistance

public int getDistance(String nodeName)

read

public void read(DataInputView in)
          throws IOException

Specified by:

read in interface IOReadableWritable

Throws:

IOException

write

public void write(DataOutputView out)
           throws IOException

Specified by:

write in interface IOReadableWritable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object