org.apache.tez.runtime.api

Interface ProcessorContext

All Superinterfaces:

TaskContext

@InterfaceAudience.Public
public interface ProcessorContext
extends TaskContext

Context handle for the Processor to initialize itself. This interface is not supposed to be implemented by users

Method Summary

Modifier and Type	Method and Description
boolean	canCommit() Check whether this attempt can commit its output
static float	preProcessProgress(float progress) validate that progress is the valid range.
default void	setProgress(float progress) Set the overall progress of this Task Attempt.
void	setProgressInternally(float progress) The actual implementation of the taskAttempt progress.
void	waitForAllInputsReady(Collection<Input> inputs) Blocking call which returns only after all of the specified Inputs are ready for consumption.
boolean	waitForAllInputsReady(Collection<Input> inputs, long timeoutMillis) Blocking call which returns only after all of the specified Inputs are ready for consumption with timeout.
Input	waitForAnyInputReady(Collection<Input> inputs) Blocking call which returns when any of the specified Inputs is ready for consumption.
Input	waitForAnyInputReady(Collection<Input> inputs, long timeoutMillis) Blocking call which returns when any of the specified Inputs is ready for consumption.

Methods inherited from interface org.apache.tez.runtime.api.TaskContext

fatalError, getApplicationId, getContainerConfiguration, getCounters, getDAGAttemptNumber, getDagIdentifier, getDAGName, getExecutionContext, getObjectRegistry, getServiceConsumerMetaData, getServiceProviderMetaData, getTaskAttemptNumber, getTaskIndex, getTaskVertexIndex, getTaskVertexName, getTotalMemoryAvailableToTask, getUniqueIdentifier, getUserPayload, getVertexParallelism, getWorkDirs, notifyProgress, reportFailure, requestInitialMemory, sendEvents

Method Detail

preProcessProgress

static float preProcessProgress(float progress)

validate that progress is the valid range.

Parameters:

progress -

Returns:

the processed value of the progress that is guaranteed to be within the valid range.

setProgress

default void setProgress(float progress)

Set the overall progress of this Task Attempt. This automatically results in invocation of TaskContext.notifyProgress() and so invoking that separately is not required.

Parameters:

progress - Progress in the range from [0.0 - 1.0f]

setProgressInternally

void setProgressInternally(float progress)

The actual implementation of the taskAttempt progress. All implementations needs to override this method

Parameters:

progress -

canCommit

boolean canCommit()
           throws IOException

Check whether this attempt can commit its output

Returns:

true if commit allowed

Throws:

IOException

waitForAnyInputReady

Input waitForAnyInputReady(Collection<Input> inputs)
                    throws InterruptedException

Blocking call which returns when any of the specified Inputs is ready for consumption. There can be multiple parallel invocations of this function - where each invocation blocks on the Inputs that it specifies. If multiple Inputs are ready, any one of them may be returned by this method - including an Input which may have been returned in a previous call. If invoking this method multiple times, it's recommended to remove previously completed Inputs from the invocation list.

Parameters:

inputs - the list of Inputs to monitor

Returns:

the Input which is ready for consumption

Throws:

InterruptedException

waitForAnyInputReady

Input waitForAnyInputReady(Collection<Input> inputs,
                           long timeoutMillis)
                    throws InterruptedException

Blocking call which returns when any of the specified Inputs is ready for consumption. There can be multiple parallel invocations of this function - where each invocation blocks on the Inputs that it specifies. If multiple Inputs are ready, any one of them may be returned by this method - including an Input which may have been returned in a previous call. If invoking this method multiple times, it's recommended to remove previously completed Inputs from the invocation list.

Parameters:

inputs - the list of Inputs to monitor

timeoutMillis - timeout to return in milliseconds. If this value is negative, this function will wait forever until all inputs get ready or interrupted.

Returns:

the Input which is ready for consumption. return null when timeout occurs.

Throws:

InterruptedException

waitForAllInputsReady

void waitForAllInputsReady(Collection<Input> inputs)
                    throws InterruptedException

Blocking call which returns only after all of the specified Inputs are ready for consumption. There can be multiple parallel invocations of this function - where each invocation blocks on the Inputs that it specifies.

Parameters:

inputs - the list of Inputs to monitor

Throws:

InterruptedException

waitForAllInputsReady

boolean waitForAllInputsReady(Collection<Input> inputs,
                              long timeoutMillis)
                       throws InterruptedException

Blocking call which returns only after all of the specified Inputs are ready for consumption with timeout. There can be multiple parallel invocations of this function - where each invocation blocks on the Inputs that it specifies.

Parameters:

inputs - the list of Inputs to monitor

timeoutMillis - timeout to return in milliseconds. If this value is negative, this function will wait forever until all inputs get ready or interrupted.

Returns:

Return true if all inputs are ready. Otherwise, return false.

Throws:

InterruptedException