RuntimeEnvironment (flink-runtime 0.8.0-hadoop1 API)

java.lang.Object
- org.apache.flink.runtime.execution.RuntimeEnvironment

All Implemented Interfaces:: Runnable, Environment, BufferProvider, LocalBufferPoolOwner

public class RuntimeEnvironment
extends Object
implements Environment, BufferProvider, LocalBufferPoolOwner, Runnable

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.flink.runtime.io.network.bufferprovider.BufferProvider
  BufferProvider.BufferAvailabilityRegistration

Constructor Summary

Constructors
Constructor and Description
`RuntimeEnvironment(Task owner, TaskDeploymentDescriptor tdd, ClassLoader userCodeClassLoader, MemoryManager memoryManager, IOManager ioManager, InputSplitProvider inputSplitProvider, AccumulatorProtocol accumulatorProtocolProxy, BroadcastVariableManager bcVarManager)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCopyTaskForCacheFile(String name, FutureTask<Path> copyTask)`
`void`	`addCopyTasksForCacheFile(Map<String,FutureTask<Path>> copyTasks)`
`void`	`cancelExecution()`
`void`	`clearLocalBufferPool()` Clears the local buffer pool and returns all buffers to the global buffer pool.
`<T extends IOReadableWritable> InputGate<T>`	`createAndRegisterInputGate()` Creates a new InputGate and registers it with the Environment.
`OutputGate`	`createAndRegisterOutputGate()` Creates a new OutputGate and registers it with the Environment.
`AccumulatorProtocol`	`getAccumulatorProtocolProxy()` Returns the proxy object for the accumulator protocol.
`BroadcastVariableManager`	`getBroadcastVariableManager()`
`int`	`getBufferSize()` Returns the size of buffers (in bytes) available at this buffer provider.
`Map<String,FutureTask<Path>>`	`getCopyTask()`
`int`	`getCurrentNumberOfSubtasks()` Returns the current number of subtasks the respective task is split into.
`Thread`	`getExecutingThread()` Returns the thread which is assigned to execute the user code.
`int`	`getIndexInSubtaskGroup()` Returns the index of this subtask in the subtask group.
`Set<ChannelID>`	`getInputChannelIDs()` Returns the IDs of all input channels connected to this environment.
`Set<ChannelID>`	`getInputChannelIDsOfGate(GateID gateID)` Returns the IDs of all the input channels connected to the gate with the given ID.
`InputGate<? extends IOReadableWritable>`	`getInputGate(int pos)` Returns the registered input gate with index `pos`.
`Set<GateID>`	`getInputGateIDs()` Returns the IDs of all input gates connected to this environment.
`InputSplitProvider`	`getInputSplitProvider()` Returns the input split provider assigned to this environment.
`AbstractInvokable`	`getInvokable()` Returns the invokable object that represents the Nephele task.
`IOManager`	`getIOManager()` Returns the current `IOManager`.
`Configuration`	`getJobConfiguration()` Returns the job configuration object which was attached to the original `JobGraph`.
`JobID`	`getJobID()` Returns the ID of the job from the original job graph.
`JobVertexID`	`getJobVertexId()` Gets the ID of the jobVertex that this task corresponds to.
`MemoryManager`	`getMemoryManager()` Returns the current `MemoryManager`.
`GateID`	`getNextUnboundInputGateID()` Returns the next unbound input gate ID or `null` if no such ID exists
`int`	`getNumberOfChannels()` Returns the number of byte-buffered channels that will retrieve their buffers from the local buffer pool.
`int`	`getNumberOfInputChannels()` Returns the number of input channels attached to this environment.
`int`	`getNumberOfInputGates()` Returns the number of input gates registered with this environment.
`int`	`getNumberOfOutputChannels()` Returns the number of output channels attached to this environment.
`int`	`getNumberOfOutputGates()` Returns the number of output gates registered with this environment.
`BufferProvider`	`getOutputBufferProvider()` Returns the buffer provider for this environment.
`Set<ChannelID>`	`getOutputChannelIDs()` Returns the IDs of all output channels connected to this environment.
`Set<ChannelID>`	`getOutputChannelIDsOfGate(GateID gateID)` Returns the IDs of all the output channels connected to the gate with the given ID.
`OutputGate`	`getOutputGate(int index)` Returns the registered output gate with index `pos`.
`Set<GateID>`	`getOutputGateIDs()` Returns the IDs of all output gates connected to this environment.
`Configuration`	`getTaskConfiguration()` Returns the task configuration object which was attached to the original JobVertex.
`String`	`getTaskName()` Returns the name of the task running in this environment.
`ClassLoader`	`getUserClassLoader()` Returns the user code class loader
`List<InputGate<? extends IOReadableWritable>>`	`inputGates()`
`void`	`logBufferUtilization()` Logs the current status of the local buffer pool.
`List<OutputGate>`	`outputGates()`
`BufferProvider.BufferAvailabilityRegistration`	`registerBufferAvailabilityListener(BufferAvailabilityListener listener)` Registers the given `BufferAvailabilityListener` with an empty buffer pool.
`void`	`registerGlobalBufferPool(GlobalBufferPool globalBufferPool)`
`void`	`reportAsynchronousEvent()` Reports an asynchronous event and interrupts each blocking method of this buffer provider in order to allow the blocked thread to respond to the event.
`Buffer`	`requestBuffer(int minBufferSize)` Requests a buffer with a minimum size of `minBufferSize`.
`Buffer`	`requestBufferBlocking(int minBufferSize)` Requests a buffer with a minimum size of `minBufferSize`.
`void`	`run()`
`void`	`setDesignatedNumberOfBuffers(int numBuffers)` Sets the designated number of buffers the local buffer pool owner is allowed to fetch from the global buffer pool and manage locally by means of the `LocalBufferPool`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RuntimeEnvironment
```
public RuntimeEnvironment(Task owner,
                          TaskDeploymentDescriptor tdd,
                          ClassLoader userCodeClassLoader,
                          MemoryManager memoryManager,
                          IOManager ioManager,
                          InputSplitProvider inputSplitProvider,
                          AccumulatorProtocol accumulatorProtocolProxy,
                          BroadcastVariableManager bcVarManager)
                   throws Exception
```
    Throws:
    
    Exception
- Method Detail
  - getInvokable
```
public AbstractInvokable getInvokable()
```
    Returns the invokable object that represents the Nephele task.
    
    Returns:
    
    the invokable object that represents the Nephele task
  - getJobID
```
public JobID getJobID()
```
    Description copied from interface: Environment
    
    Returns the ID of the job from the original job graph. It is used by the library cache manager to find the required libraries for executing the assigned Nephele task.
    
    Specified by:
    
    getJobID in interface Environment
    
    Returns:
    
    the ID of the job from the original job graph
  - getJobVertexId
```
public JobVertexID getJobVertexId()
```
    Description copied from interface: Environment
    
    Gets the ID of the jobVertex that this task corresponds to.
    
    Specified by:
    
    getJobVertexId in interface Environment
    
    Returns:
    
    The JobVertexID of this task.
  - getNextUnboundInputGateID
```
public GateID getNextUnboundInputGateID()
```
    Description copied from interface: Environment
    
    Returns the next unbound input gate ID or null if no such ID exists
    
    Specified by:
    
    getNextUnboundInputGateID in interface Environment
    
    Returns:
    
    the next unbound input gate ID or null if no such ID exists
  - createAndRegisterOutputGate
```
public OutputGate createAndRegisterOutputGate()
```
    Description copied from interface: Environment
    
    Creates a new OutputGate and registers it with the Environment.
    
    Specified by:
    
    createAndRegisterOutputGate in interface Environment
    
    Returns:
    
    the newly created output gate
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
  - createAndRegisterInputGate
```
public <T extends IOReadableWritable> InputGate<T> createAndRegisterInputGate()
```
    Description copied from interface: Environment
    
    Creates a new InputGate and registers it with the Environment.
    
    Specified by:
    
    createAndRegisterInputGate in interface Environment
  - getNumberOfOutputGates
```
public int getNumberOfOutputGates()
```
    Description copied from interface: Environment
    
    Returns the number of output gates registered with this environment.
    
    Specified by:
    
    getNumberOfOutputGates in interface Environment
    
    Returns:
    
    the number of output gates registered with this environment
  - getNumberOfInputGates
```
public int getNumberOfInputGates()
```
    Description copied from interface: Environment
    
    Returns the number of input gates registered with this environment.
    
    Specified by:
    
    getNumberOfInputGates in interface Environment
    
    Returns:
    
    the number of input gates registered with this environment
  - getNumberOfOutputChannels
```
public int getNumberOfOutputChannels()
```
    Description copied from interface: Environment
    
    Returns the number of output channels attached to this environment.
    
    Specified by:
    
    getNumberOfOutputChannels in interface Environment
    
    Returns:
    
    the number of output channels attached to this environment
  - getNumberOfInputChannels
```
public int getNumberOfInputChannels()
```
    Description copied from interface: Environment
    
    Returns the number of input channels attached to this environment.
    
    Specified by:
    
    getNumberOfInputChannels in interface Environment
    
    Returns:
    
    the number of input channels attached to this environment
  - getInputGate
```
public InputGate<? extends IOReadableWritable> getInputGate(int pos)
```
    Returns the registered input gate with index pos.
    
    Parameters:
    
    pos - the index of the input gate to return
    
    Returns:
    
    the input gate at index pos or null if no such index exists
  - getOutputGate
```
public OutputGate getOutputGate(int index)
```
    Returns the registered output gate with index pos.
    
    Parameters:
    
    index - the index of the output gate to return
    
    Returns:
    
    the output gate at index pos or null if no such index exists
  - getExecutingThread
```
public Thread getExecutingThread()
```
    Returns the thread which is assigned to execute the user code.
    
    Returns:
    
    the thread which is assigned to execute the user code
  - cancelExecution
```
public void cancelExecution()
```
  - getIOManager
```
public IOManager getIOManager()
```
    Description copied from interface: Environment
    
    Returns the current IOManager.
    
    Specified by:
    
    getIOManager in interface Environment
    
    Returns:
    
    the current IOManager.
  - getMemoryManager
```
public MemoryManager getMemoryManager()
```
    Description copied from interface: Environment
    
    Returns the current MemoryManager.
    
    Specified by:
    
    getMemoryManager in interface Environment
    
    Returns:
    
    the current MemoryManager.
  - getBroadcastVariableManager
```
public BroadcastVariableManager getBroadcastVariableManager()
```
    Specified by:
    
    getBroadcastVariableManager in interface Environment
  - getTaskConfiguration
```
public Configuration getTaskConfiguration()
```
    Description copied from interface: Environment
    
    Returns the task configuration object which was attached to the original JobVertex.
    
    Specified by:
    
    getTaskConfiguration in interface Environment
    
    Returns:
    
    the task configuration object which was attached to the original JobVertex.
  - getJobConfiguration
```
public Configuration getJobConfiguration()
```
    Description copied from interface: Environment
    
    Returns the job configuration object which was attached to the original JobGraph.
    
    Specified by:
    
    getJobConfiguration in interface Environment
    
    Returns:
    
    the job configuration object which was attached to the original JobGraph
  - getCurrentNumberOfSubtasks
```
public int getCurrentNumberOfSubtasks()
```
    Description copied from interface: Environment
    
    Returns the current number of subtasks the respective task is split into.
    
    Specified by:
    
    getCurrentNumberOfSubtasks in interface Environment
    
    Returns:
    
    the current number of subtasks the respective task is split into
  - getIndexInSubtaskGroup
```
public int getIndexInSubtaskGroup()
```
    Description copied from interface: Environment
    
    Returns the index of this subtask in the subtask group.
    
    Specified by:
    
    getIndexInSubtaskGroup in interface Environment
    
    Returns:
    
    the index of this subtask in the subtask group
  - getTaskName
```
public String getTaskName()
```
    Description copied from interface: Environment
    
    Returns the name of the task running in this environment.
    
    Specified by:
    
    getTaskName in interface Environment
    
    Returns:
    
    the name of the task running in this environment
  - getInputSplitProvider
```
public InputSplitProvider getInputSplitProvider()
```
    Description copied from interface: Environment
    
    Returns the input split provider assigned to this environment.
    
    Specified by:
    
    getInputSplitProvider in interface Environment
    
    Returns:
    
    the input split provider or null if no such provider has been assigned to this environment.
  - getOutputChannelIDs
```
public Set<ChannelID> getOutputChannelIDs()
```
    Description copied from interface: Environment
    
    Returns the IDs of all output channels connected to this environment.
    
    Specified by:
    
    getOutputChannelIDs in interface Environment
    
    Returns:
    
    the IDs of all output channels connected to this environment
  - getInputChannelIDs
```
public Set<ChannelID> getInputChannelIDs()
```
    Description copied from interface: Environment
    
    Returns the IDs of all input channels connected to this environment.
    
    Specified by:
    
    getInputChannelIDs in interface Environment
    
    Returns:
    
    the IDs of all input channels connected to this environment
  - getInputGateIDs
```
public Set<GateID> getInputGateIDs()
```
    Description copied from interface: Environment
    
    Returns the IDs of all input gates connected to this environment.
    
    Specified by:
    
    getInputGateIDs in interface Environment
    
    Returns:
    
    the IDs of all input gates connected to this environment
  - getOutputGateIDs
```
public Set<GateID> getOutputGateIDs()
```
    Description copied from interface: Environment
    
    Returns the IDs of all output gates connected to this environment.
    
    Specified by:
    
    getOutputGateIDs in interface Environment
    
    Returns:
    
    the IDs of all output gates connected to this environment
  - getOutputChannelIDsOfGate
```
public Set<ChannelID> getOutputChannelIDsOfGate(GateID gateID)
```
    Description copied from interface: Environment
    
    Returns the IDs of all the output channels connected to the gate with the given ID.
    
    Specified by:
    
    getOutputChannelIDsOfGate in interface Environment
    
    Parameters:
    
    gateID - the gate ID
    
    Returns:
    
    the IDs of all the output channels connected to the gate with the given ID
  - getInputChannelIDsOfGate
```
public Set<ChannelID> getInputChannelIDsOfGate(GateID gateID)
```
    Description copied from interface: Environment
    
    Returns the IDs of all the input channels connected to the gate with the given ID.
    
    Specified by:
    
    getInputChannelIDsOfGate in interface Environment
    
    Parameters:
    
    gateID - the gate ID
    
    Returns:
    
    the IDs of all the input channels connected to the gate with the given ID
  - outputGates
```
public List<OutputGate> outputGates()
```
  - inputGates
```
public List<InputGate<? extends IOReadableWritable>> inputGates()
```
  - getAccumulatorProtocolProxy
```
public AccumulatorProtocol getAccumulatorProtocolProxy()
```
    Description copied from interface: Environment
    
    Returns the proxy object for the accumulator protocol.
    
    Specified by:
    
    getAccumulatorProtocolProxy in interface Environment
  - getUserClassLoader
```
public ClassLoader getUserClassLoader()
```
    Description copied from interface: Environment
    
    Returns the user code class loader
    
    Specified by:
    
    getUserClassLoader in interface Environment
    
    Returns:
    
    user code class loader
  - addCopyTasksForCacheFile
```
public void addCopyTasksForCacheFile(Map<String,FutureTask<Path>> copyTasks)
```
  - addCopyTaskForCacheFile
```
public void addCopyTaskForCacheFile(String name,
                                    FutureTask<Path> copyTask)
```
  - getCopyTask
```
public Map<String,FutureTask<Path>> getCopyTask()
```
    Specified by:
    
    getCopyTask in interface Environment
  - getOutputBufferProvider
```
public BufferProvider getOutputBufferProvider()
```
    Description copied from interface: Environment
    
    Returns the buffer provider for this environment.
    The returned buffer provider is used by the output side of the network stack.
    
    Specified by:
    
    getOutputBufferProvider in interface Environment
    
    Returns:
    
    Buffer provider for the output side of the network stack
    
    See Also:
    
    RecordWriter
  - requestBuffer
```
public Buffer requestBuffer(int minBufferSize)
                     throws IOException
```
    Description copied from interface: BufferProvider
    
    Requests a buffer with a minimum size of minBufferSize. The method returns immediately, even if the request could not be fulfilled.
    
    Specified by:
    
    requestBuffer in interface BufferProvider
    
    Parameters:
    
    minBufferSize - minimum size of the requested buffer (in bytes)
    
    Returns:
    
    buffer with at least the requested size or null if no such buffer is currently available
    
    Throws:
    
    IOException
  - requestBufferBlocking
```
public Buffer requestBufferBlocking(int minBufferSize)
                             throws IOException,
                                    InterruptedException
```
    Description copied from interface: BufferProvider
    
    Requests a buffer with a minimum size of minBufferSize. The method blocks until the request has been fulfilled or BufferProvider.reportAsynchronousEvent() has been called.
    
    Specified by:
    
    requestBufferBlocking in interface BufferProvider
    
    Parameters:
    
    minBufferSize - minimum size of the requested buffer (in bytes)
    
    Returns:
    
    buffer with at least the requested size
    
    Throws:
    
    IOException
    
    InterruptedException
  - getBufferSize
```
public int getBufferSize()
```
    Description copied from interface: BufferProvider
    
    Returns the size of buffers (in bytes) available at this buffer provider.
    
    Specified by:
    
    getBufferSize in interface BufferProvider
    
    Returns:
    
    size of buffers (in bytes) available at this buffer provider
  - registerBufferAvailabilityListener
```
public BufferProvider.BufferAvailabilityRegistration registerBufferAvailabilityListener(BufferAvailabilityListener listener)
```
    Description copied from interface: BufferProvider
    
    Registers the given BufferAvailabilityListener with an empty buffer pool.
    The registration only succeeds, if the buffer pool is empty and has not been destroyed yet.
    The registered listener will receive a notification when at least one buffer has become available again. After the notification, the listener will be unregistered.
    
    Specified by:
    
    registerBufferAvailabilityListener in interface BufferProvider
    
    Parameters:
    
    listener - the listener to be registered
    
    Returns:
    
    true if the registration has been successful; false if the registration failed, because the buffer pool was not empty or has already been destroyed
  - getNumberOfChannels
```
public int getNumberOfChannels()
```
    Description copied from interface: LocalBufferPoolOwner
    
    Returns the number of byte-buffered channels that will retrieve their buffers from the local buffer pool.
    
    Specified by:
    
    getNumberOfChannels in interface LocalBufferPoolOwner
    
    Returns:
    
    the number of byte-buffered channels that will retrieve their buffers from the local buffer pool
  - setDesignatedNumberOfBuffers
```
public void setDesignatedNumberOfBuffers(int numBuffers)
```
    Description copied from interface: LocalBufferPoolOwner
    
    Sets the designated number of buffers the local buffer pool owner is allowed to fetch from the global buffer pool and manage locally by means of the LocalBufferPool.
    
    Specified by:
    
    setDesignatedNumberOfBuffers in interface LocalBufferPoolOwner
    
    Parameters:
    
    numBuffers - the numBuffers the local buffer pool owner is allowed to fetch from the global buffer pool
  - clearLocalBufferPool
```
public void clearLocalBufferPool()
```
    Description copied from interface: LocalBufferPoolOwner
    
    Clears the local buffer pool and returns all buffers to the global buffer pool.
    
    Specified by:
    
    clearLocalBufferPool in interface LocalBufferPoolOwner
  - registerGlobalBufferPool
```
public void registerGlobalBufferPool(GlobalBufferPool globalBufferPool)
```
    Specified by:
    
    registerGlobalBufferPool in interface LocalBufferPoolOwner
  - logBufferUtilization
```
public void logBufferUtilization()
```
    Description copied from interface: LocalBufferPoolOwner
    
    Logs the current status of the local buffer pool. This method is intended mainly for debugging purposes.
    
    Specified by:
    
    logBufferUtilization in interface LocalBufferPoolOwner
  - reportAsynchronousEvent
```
public void reportAsynchronousEvent()
```
    Description copied from interface: BufferProvider
    
    Reports an asynchronous event and interrupts each blocking method of this buffer provider in order to allow the blocked thread to respond to the event.
    
    Specified by:
    
    reportAsynchronousEvent in interface BufferProvider
    
    Specified by:
    
    reportAsynchronousEvent in interface LocalBufferPoolOwner

Class RuntimeEnvironment

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.io.network.bufferprovider.BufferProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuntimeEnvironment

Method Detail

getInvokable

getJobID

getJobVertexId

getNextUnboundInputGateID

createAndRegisterOutputGate

run

createAndRegisterInputGate

getNumberOfOutputGates

getNumberOfInputGates

getNumberOfOutputChannels

getNumberOfInputChannels

getInputGate

getOutputGate

getExecutingThread

cancelExecution

getIOManager

getMemoryManager

getBroadcastVariableManager

getTaskConfiguration

getJobConfiguration

getCurrentNumberOfSubtasks

getIndexInSubtaskGroup

getTaskName

getInputSplitProvider

getOutputChannelIDs

getInputChannelIDs

getInputGateIDs

getOutputGateIDs

getOutputChannelIDsOfGate

getInputChannelIDsOfGate

outputGates

inputGates

getAccumulatorProtocolProxy

getUserClassLoader

addCopyTasksForCacheFile

addCopyTaskForCacheFile

getCopyTask

getOutputBufferProvider

requestBuffer

requestBufferBlocking

getBufferSize

registerBufferAvailabilityListener

getNumberOfChannels

setDesignatedNumberOfBuffers

clearLocalBufferPool

registerGlobalBufferPool

logBufferUtilization

reportAsynchronousEvent