edu.iu.dsc.tws.api.compute

Interface TaskContext

All Known Implementing Classes:

TaskContextImpl

public interface TaskContext

TaskContext is passed to the task instances when they are being prepared to execute. This class is used for getting information about the task as well as sending messages.

Method Summary

Modifier and Type	Method and Description
void	end(java.lang.String edge) End the current writing
void	endAll() Ends all the edges
java.lang.Object	getConfig(java.lang.String name) Get a configuration with a name
java.util.Map<java.lang.String,java.lang.Object>	getConfigurations() Get the task specific configurations
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getInEdges() Get the in edges of the task.
OperationMode	getOperationMode() Get the operation mode of the task graph
java.util.Map<java.lang.String,java.lang.String>	getOutEdges() Get the out edges of this task
int	getParallelism() Get the parallism of the task
default java.util.Set<TaskInstancePlan>	getTasksByName(java.lang.String name) Instances of tasks for the given name
default java.util.Set<TaskInstancePlan>	getTasksInThisWorkerByName(java.lang.String name) Tasks of given type which have been scheduled in this worker
default WorkerSchedulePlan	getWorker() Get the container of this task
int	getWorkerId() Get the worker id this task is running
java.util.Set<WorkerSchedulePlan>	getWorkers() Set of workers in the current topology
java.util.Map<java.lang.Integer,WorkerSchedulePlan>	getWorkersMap() Map of worker where value is the container id
int	globalTaskId() Task id
boolean	isDone(java.lang.String edge) Return true, if this task is done
void	reset() Reset the context
int	taskId() Get the task id for this task
int	taskIndex() The task index
java.lang.String	taskName() Name of the task
boolean	write(java.lang.String edge, java.lang.Object message) Write a message to the destination
boolean	write(java.lang.String edge, java.lang.Object key, java.lang.Object message) Write a message with a key
boolean	writeBarrier(java.lang.String edge, java.lang.Object message) Write a barrier message to the destination
boolean	writeEnd(java.lang.String edge, java.lang.Object message) Write the last message
boolean	writeEnd(java.lang.String edge, java.lang.Object key, java.lang.Object message) Write the last message

Method Detail

reset

void reset()

Reset the context

taskIndex

int taskIndex()

The task index

Returns:

index

globalTaskId

int globalTaskId()

Task id

Returns:

the task id

taskId

int taskId()

Get the task id for this task

Returns:

task id

taskName

java.lang.String taskName()

Name of the task

getParallelism

int getParallelism()

Get the parallism of the task

Returns:

number of parallel instances

getWorkerId

int getWorkerId()

Get the worker id this task is running

Returns:

worker id

getConfigurations

java.util.Map<java.lang.String,java.lang.Object> getConfigurations()

Get the task specific configurations

Returns:

map of configurations

getConfig

java.lang.Object getConfig(java.lang.String name)

Get a configuration with a name

Parameters:

name - name of the config

Returns:

the config, if not found return null

getOutEdges

java.util.Map<java.lang.String,java.lang.String> getOutEdges()

Get the out edges of this task

Returns:

the output edges

getInEdges

java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getInEdges()

Get the in edges of the task. Generally, each edge would have a single source. But, the join edges have multiple sources. These will be reflected by the Set.

Returns:

a map with edge name -> Set of source task names for that edge

write

boolean write(java.lang.String edge,
              java.lang.Object key,
              java.lang.Object message)

Write a message with a key

Parameters:

edge - the edge

key - key

message - message

Returns:

true if the message is accepted

write

boolean write(java.lang.String edge,
              java.lang.Object message)

Write a message to the destination

Parameters:

edge - edge

message - message

writeBarrier

boolean writeBarrier(java.lang.String edge,
                     java.lang.Object message)

Write a barrier message to the destination

Parameters:

edge - edge

message - message

writeEnd

boolean writeEnd(java.lang.String edge,
                 java.lang.Object message)

Write the last message

Parameters:

edge - edge

message - message

writeEnd

boolean writeEnd(java.lang.String edge,
                 java.lang.Object key,
                 java.lang.Object message)

Write the last message

Parameters:

edge - edge

key - key

message - message

end

void end(java.lang.String edge)

End the current writing

Parameters:

edge - edge

endAll

void endAll()

Ends all the edges

isDone

boolean isDone(java.lang.String edge)

Return true, if this task is done

Parameters:

edge - edge name

Returns:

boolean

getWorkers

java.util.Set<WorkerSchedulePlan> getWorkers()

Set of workers in the current topology

getWorkersMap

java.util.Map<java.lang.Integer,WorkerSchedulePlan> getWorkersMap()

Map of worker where value is the container id

getWorker

default WorkerSchedulePlan getWorker()

Get the container of this task

getTasksByName

default java.util.Set<TaskInstancePlan> getTasksByName(java.lang.String name)

Instances of tasks for the given name

getTasksInThisWorkerByName

default java.util.Set<TaskInstancePlan> getTasksInThisWorkerByName(java.lang.String name)

Tasks of given type which have been scheduled in this worker

getOperationMode

OperationMode getOperationMode()

Get the operation mode of the task graph

Returns:

the operation mode