edu.iu.dsc.tws.api.resource

Class WorkerEnvironment

java.lang.Object

edu.iu.dsc.tws.api.resource.WorkerEnvironment

public final class WorkerEnvironment
extends java.lang.Object

Worker environment encapsulating the details about the workers.

Method Summary

Modifier and Type	Method and Description
void	close() Close the worker environment
TWSChannel	getChannel()
Communicator	getCommunicator()
Config	getConfig()
JobAPI.Job	getJob()
int	getNumberOfWorkers()
IPersistentVolume	getPersistentVolume()
static java.lang.Object	getSharedValue(java.lang.String key)
static <T> T	getSharedValue(java.lang.String key, java.lang.Class<T> clazz)
IVolatileVolume	getVolatileVolume()
IWorkerController	getWorkerController()
static WorkerEnvironment	getWorkerEnv()
int	getWorkerId()
java.util.List<JobMasterAPI.WorkerInfo>	getWorkerList()
static WorkerEnvironment	init(Config config, JobAPI.Job job, IWorkerController workerController, IPersistentVolume persistentVolume, IVolatileVolume volatileVolume) Initialize the worker environment, this is a singleton and every job should call this method
static void	putSharedValue(java.lang.String key, java.lang.Object value)
static void	putWeakSharedValue(java.lang.String key, java.lang.Object value) This method will wrap the value with a WeakReference before inserting into the key-value store.
static void	removeSharedValue(java.lang.String key)

Methods inherited from class java.lang.Object

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

Method Detail

getConfig

public Config getConfig()

getWorkerId

public int getWorkerId()

getJob

public JobAPI.Job getJob()

getNumberOfWorkers

public int getNumberOfWorkers()

getWorkerList

public java.util.List<JobMasterAPI.WorkerInfo> getWorkerList()

getWorkerController

public IWorkerController getWorkerController()

getPersistentVolume

public IPersistentVolume getPersistentVolume()

getVolatileVolume

public IVolatileVolume getVolatileVolume()

getCommunicator

public Communicator getCommunicator()

getChannel

public TWSChannel getChannel()

close

public void close()

Close the worker environment

init

public static WorkerEnvironment init(Config config,
                                     JobAPI.Job job,
                                     IWorkerController workerController,
                                     IPersistentVolume persistentVolume,
                                     IVolatileVolume volatileVolume)

Initialize the worker environment, this is a singleton and every job should call this method

Parameters:

config - configuration

job - job object for this Twister2 job

workerController - worker controller

persistentVolume - persistent volume

volatileVolume - volatile volume

Returns:

the worker environment

putSharedValue

public static void putSharedValue(java.lang.String key,
                                  java.lang.Object value)

putWeakSharedValue

public static void putWeakSharedValue(java.lang.String key,
                                      java.lang.Object value)

This method will wrap the value with a WeakReference before inserting into the key-value store.

removeSharedValue

public static void removeSharedValue(java.lang.String key)

getSharedValue

public static java.lang.Object getSharedValue(java.lang.String key)

getSharedValue

public static <T> T getSharedValue(java.lang.String key,
                                   java.lang.Class<T> clazz)

getWorkerEnv

public static WorkerEnvironment getWorkerEnv()