edu.iu.dsc.tws.api.resource

Interface IWorkerController

All Known Implementing Classes:

JMWorkerController, MesosWorkerController, MockWorkerController, MPIWorkerController, ZKWorkerController

public interface IWorkerController

an interface to get the list of workers in a job and their addresses

Method Summary

Modifier and Type	Method and Description
java.util.List<JobMasterAPI.WorkerInfo>	getAllWorkers() get all workers in the job.
default CheckpointingClient	getCheckpointingClient()
default IWorkerFailureListener	getFailureListener() Get the failure listener
java.util.List<JobMasterAPI.WorkerInfo>	getJoinedWorkers() get all joined workers in this job, including the ones finished execution if there are some workers that have not joined yet, they may not be included in this list.
int	getNumberOfWorkers() return the number of all workers in this job, including non-started ones and finished ones
JobMasterAPI.WorkerInfo	getWorkerInfo() return the WorkerInfo object for this worker
JobMasterAPI.WorkerInfo	getWorkerInfoForID(int id) return the WorkerInfo object for the given ID
void	waitOnBarrier() wait for all workers in the job to arrive at this barrier After waiting for the timeout specified in ControllerContext.maxWaitTimeOnBarrier if some workers still could not arrive at the barrier, throw an exception
void	waitOnBarrier(long timeLimit) wait for all workers in the job to arrive at this barrier After waiting for the timeLimit, if some workers still could not arrive at the barrier, throw an exception
void	waitOnInitBarrier() this barrier is used when initializing the workers.
int	workerRestartCount() get worker restartCount zero means starting for the first time

Method Detail

getWorkerInfo

JobMasterAPI.WorkerInfo getWorkerInfo()

return the WorkerInfo object for this worker

getWorkerInfoForID

JobMasterAPI.WorkerInfo getWorkerInfoForID(int id)

return the WorkerInfo object for the given ID

getNumberOfWorkers

int getNumberOfWorkers()

return the number of all workers in this job, including non-started ones and finished ones

workerRestartCount

int workerRestartCount()

get worker restartCount zero means starting for the first time

getJoinedWorkers

java.util.List<JobMasterAPI.WorkerInfo> getJoinedWorkers()

get all joined workers in this job, including the ones finished execution if there are some workers that have not joined yet, they may not be included in this list. users can compare the total number of workers to the size of this list and understand whether there are non-joined workers

getAllWorkers

java.util.List<JobMasterAPI.WorkerInfo> getAllWorkers()
                                               throws TimeoutException

get all workers in the job. If some workers has not joined the job yet, wait for them. After waiting for the timeout specified in ControllerContext.maxWaitTimeForAllToJoin if some workers still could not join, throw an exception

return all workers in the job including the ones that have already left, if any

Throws:

TimeoutException

waitOnBarrier

void waitOnBarrier()
            throws TimeoutException,
                   JobFaultyException

wait for all workers in the job to arrive at this barrier After waiting for the timeout specified in ControllerContext.maxWaitTimeOnBarrier if some workers still could not arrive at the barrier, throw an exception

Throws:

TimeoutException

JobFaultyException

waitOnBarrier

void waitOnBarrier(long timeLimit)
            throws TimeoutException,
                   JobFaultyException

wait for all workers in the job to arrive at this barrier After waiting for the timeLimit, if some workers still could not arrive at the barrier, throw an exception

Throws:

TimeoutException

JobFaultyException

waitOnInitBarrier

void waitOnInitBarrier()
                throws TimeoutException

this barrier is used when initializing the workers. when there is a failure in the job, workers synchronize with this barrier this must not be used in other parts of the system

Throws:

TimeoutException

getFailureListener

default IWorkerFailureListener getFailureListener()

Get the failure listener

Returns:

the failure listener

getCheckpointingClient

default CheckpointingClient getCheckpointingClient()