org.apache.flink.runtime.taskmanager

Class TaskManagerLocation

java.lang.Object

org.apache.flink.runtime.taskmanager.TaskManagerLocation

All Implemented Interfaces:

Serializable, Comparable<TaskManagerLocation>

public class TaskManagerLocation
extends Object
implements Comparable<TaskManagerLocation>, Serializable

This class encapsulates the connection information of a TaskManager. It describes the host where the TaskManager operates and its server port for data exchange. This class also contains utilities to work with the TaskManager's host name, which is used to localize work assignments.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TaskManagerLocation(ResourceID resourceID, InetAddress inetAddress, int dataPort) Constructs a new instance connection info object.

Method Summary

Modifier and Type	Method and Description
InetAddress	address() Returns the network address the instance's task manager binds its sockets to.
String	addressString() Gets the IP address where the TaskManager operates.
int	compareTo(TaskManagerLocation o)
int	dataPort() Returns the port instance's task manager expects to receive transfer envelopes on.
boolean	equals(Object obj)
String	getFQDNHostname() Returns the fully-qualified domain name the TaskManager.
String	getHostname() Gets the hostname of the TaskManager.
static String	getHostName(InetAddress inetAddress) Gets the hostname of the TaskManager based on the network address.
ResourceID	getResourceID() Gets the ID of the resource in which the TaskManager is started.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskManagerLocation

public TaskManagerLocation(ResourceID resourceID,
                           InetAddress inetAddress,
                           int dataPort)

Constructs a new instance connection info object. The constructor will attempt to retrieve the instance's host name and domain name through the operating system's lookup mechanisms.

Parameters:

inetAddress - the network address the instance's task manager binds its sockets to

dataPort - the port instance's task manager expects to receive transfer envelopes on

Method Detail

getResourceID

public ResourceID getResourceID()

Gets the ID of the resource in which the TaskManager is started. The format of this depends on how the TaskManager is started:

• If the TaskManager is started via YARN, this is the YARN container ID.
• If the TaskManager is started via Mesos, this is the Mesos container ID.
• If the TaskManager is started in standalone mode, or via a MiniCluster, this is a random ID.
• Other deployment modes can set the resource ID in other ways.

Returns:

The ID of the resource in which the TaskManager is started

dataPort

public int dataPort()

Returns the port instance's task manager expects to receive transfer envelopes on.

Returns:

the port instance's task manager expects to receive transfer envelopes on

address

public InetAddress address()

Returns the network address the instance's task manager binds its sockets to.

Returns:

the network address the instance's task manager binds its sockets to

addressString

public String addressString()

Gets the IP address where the TaskManager operates.

Returns:

The IP address.

getFQDNHostname

public String getFQDNHostname()

Returns the fully-qualified domain name the TaskManager. If the name could not be determined, the return value will be a textual representation of the TaskManager's IP address.

Returns:

The fully-qualified domain name of the TaskManager.

getHostname

public String getHostname()

Gets the hostname of the TaskManager. The hostname derives from the fully qualified domain name (FQDN, see getFQDNHostname()):

• If the FQDN is the textual IP address, then the hostname is also the IP address
• If the FQDN has only one segment (such as "localhost", or "host17"), then this is used as the hostname.
• If the FQDN has multiple segments (such as "worker3.subgroup.company.net"), then the first segment (here "worker3") will be used as the hostname.

Returns:

The hostname of the TaskManager.

getHostName

public static String getHostName(InetAddress inetAddress)

Gets the hostname of the TaskManager based on the network address.

Parameters:

inetAddress - the network address that the TaskManager binds its sockets to

Returns:

hostname of the TaskManager

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(@Nonnull
                     TaskManagerLocation o)

Specified by:

compareTo in interface Comparable<TaskManagerLocation>