org.apache.flink.runtime.instance

Class HardwareDescriptionFactory

java.lang.Object

org.apache.flink.runtime.instance.HardwareDescriptionFactory

public class HardwareDescriptionFactory
extends Object

A factory to construct HardwareDescription objects. In particular, the factory can automatically generate a HardwareDescription object from the system it is executed on.

This class is thread-safe.

Method Summary

Methods

Modifier and Type	Method and Description
static HardwareDescription	construct(int numberOfCPUCores, long sizeOfPhysicalMemory, long sizeOfFreeMemory) Constructs a new hardware description object.
static HardwareDescription	extractFromSystem() Extracts a hardware description object from the system.

Methods inherited from class java.lang.Object

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

Method Detail

extractFromSystem

public static HardwareDescription extractFromSystem()

Extracts a hardware description object from the system.

Returns:

the hardware description object or null if at least one value for the hardware description cannot be determined

construct

public static HardwareDescription construct(int numberOfCPUCores,
                            long sizeOfPhysicalMemory,
                            long sizeOfFreeMemory)

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

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

Returns:

the hardware description object