edu.iu.dsc.tws.api.driver

Interface IDriver

All Known Implementing Classes:

BaseDriver, BatchTSetBaseDriver, DefaultDriver, DriverExample, HelloExample.HelloDriver, KMeansConnectedDataflowExample.KMeansDriver, ParallelDataFlowsExample.ParallelDataflowsDriver, StreamTSetBaseDriver, TSetExample.Driver, TwoDataFlowsExample.TwoDataFlowsDriver

public interface IDriver

An instance of this class will be executed in the submitting client, if it is specified in Twister2Job

Method Summary

Modifier and Type	Method and Description
void	allWorkersJoined(java.util.List<JobMasterAPI.WorkerInfo> workerList) this method is invoked when all workers joined the job initially and also, after each scale up operation,
void	execute(Config config, IScaler scaler, IDriverMessenger messenger) After the job is submitted, an instance of this method will be executed in the Job Master
default java.util.Map<java.lang.Integer,java.lang.String>	getMessages() get the messages sent by workers to this driver
default DriverJobState	getState() returns the current state of the driver
void	workerMessageReceived(Any anyMessage, int senderWorkerID) received a protocol buffer message from a worker

Method Detail

execute

void execute(Config config,
             IScaler scaler,
             IDriverMessenger messenger)

After the job is submitted, an instance of this method will be executed in the Job Master

Implementing Driver program can communicate with the workers through provided IDriverMessenger and it can scale up/down the number of workers in the job by using IScaler

workerMessageReceived

void workerMessageReceived(Any anyMessage,
                           int senderWorkerID)

received a protocol buffer message from a worker

Parameters:

anyMessage - received message from the worker

allWorkersJoined

void allWorkersJoined(java.util.List<JobMasterAPI.WorkerInfo> workerList)

this method is invoked when all workers joined the job initially and also, after each scale up operation,

getState

default DriverJobState getState()

returns the current state of the driver

Returns:

the current state

getMessages

default java.util.Map<java.lang.Integer,java.lang.String> getMessages()

get the messages sent by workers to this driver

Returns:

a map containing messages from each worker