org.apache.flink.runtime.instance

Class HardwareDescription

java.lang.Object

org.apache.flink.runtime.instance.HardwareDescription

All Implemented Interfaces:

Serializable, IOReadableWritable

public final class HardwareDescription
extends Object
implements IOReadableWritable, Serializable

A hardware description describes the resources available to a task manager.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HardwareDescription() Public default constructor used for serialization process.
HardwareDescription(int numberOfCPUCores, long sizeOfPhysicalMemory, long sizeOfJvmHeap, long sizeOfManagedMemory) Constructs a new hardware description object.

Method Summary

Methods

Modifier and Type	Method and Description
static HardwareDescription	extractFromSystem(long managedMemory)
int	getNumberOfCPUCores() Returns the number of CPU cores available to the JVM on the compute node.
long	getSizeOfJvmHeap() Returns the size of the JVM heap memory
long	getSizeOfManagedMemory() Returns the size of the memory managed by the system for caching, hashing, sorting, ...
long	getSizeOfPhysicalMemory() Returns the size of physical memory in bytes available on the compute node.
void	read(DataInputView in)
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

HardwareDescription

public HardwareDescription()

Public default constructor used for serialization process.

HardwareDescription

public HardwareDescription(int numberOfCPUCores,
                   long sizeOfPhysicalMemory,
                   long sizeOfJvmHeap,
                   long sizeOfManagedMemory)

Constructs a new hardware description object.

Parameters:

numberOfCPUCores - The number of CPU cores available to the JVM on the compute node.

sizeOfPhysicalMemory - The size of physical memory in bytes available on the compute node.

sizeOfJvmHeap - The size of the JVM heap memory.

sizeOfManagedMemory - The size of the memory managed by the system for caching, hashing, sorting, ...

Method Detail

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

getSizeOfJvmHeap

public long getSizeOfJvmHeap()

Returns the size of the JVM heap memory

Returns:

The size of the JVM heap memory

getSizeOfManagedMemory

public long getSizeOfManagedMemory()

Returns the size of the memory managed by the system for caching, hashing, sorting, ...

Returns:

The size of the memory managed by the system.

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

toString

public String toString()

Overrides:

toString in class Object

extractFromSystem

public static HardwareDescription extractFromSystem(long managedMemory)