org.apache.flink.runtime.instance

Class HardwareDescription

java.lang.Object

org.apache.flink.runtime.instance.HardwareDescription

All Implemented Interfaces:

IOReadableWritable

public final class HardwareDescription
extends Object
implements IOReadableWritable

A hardware description reflects the hardware environment which is actually present on the task manager's compute nodes. Unlike the InstanceType the hardware description is determined by the compute node itself and not loaded from a predefined configuration profile. In particular, the hardware description includes the size of free memory which is actually available to the JVM and can be used to allocate large memory portions.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
HardwareDescription() Public default constructor used for serialization process.

Method Summary

Methods

Modifier and Type	Method and Description
int	getNumberOfCPUCores() Returns the number of CPU cores available to the JVM on the compute node.
long	getSizeOfFreeMemory() Returns the size of free memory in bytes available to the JVM on the compute node.
long	getSizeOfPhysicalMemory() Returns the size of physical memory in bytes available on the compute node.
void	read(DataInputView in)
void	write(DataOutputView out)

Methods inherited from class java.lang.Object

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

Constructor Detail

HardwareDescription

public HardwareDescription()

Public default constructor used for serialization process.

Method Detail

write

public void write(DataOutputView out)
           throws IOException

Specified by:

write in interface IOReadableWritable

Throws:

IOException

read

public void read(DataInputView in)
          throws IOException

Specified by:

read in interface IOReadableWritable

Throws:

IOException

getNumberOfCPUCores

public int getNumberOfCPUCores()

Returns the number of CPU cores available to the JVM on the compute node.

Returns:

the number of CPU cores available to the JVM on the compute node

getSizeOfPhysicalMemory

public long getSizeOfPhysicalMemory()

Returns the size of physical memory in bytes available on the compute node.

Returns:

the size of physical memory in bytes available on the compute node

getSizeOfFreeMemory

public long getSizeOfFreeMemory()

Returns the size of free memory in bytes available to the JVM on the compute node.

Returns:

the size of free memory in bytes available to the JVM on the compute node