org.sodeac.common.message.dispatcher.api

Interface ITaskControl

All Known Implementing Classes:

TaskControlImpl

public interface ITaskControl

acts as state container for taskexecutions

Author:

Sebastian Palarus

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ITaskControl.ExecutionTimestampSource

Method Summary

Modifier and Type	Method and Description
long	getExecutionTimestamp()
ITaskControl.ExecutionTimestampSource	getExecutionTimestampSource()
long	getHeartbeatTimeout() getter for heartbeat timeout value
boolean	getStopOnTimeoutFlag() getter for stopOnTimeout flag
long	getTimeout() getter for timout value
boolean	isDone()
boolean	isInTimeout()
boolean	setDone() mark task as done
boolean	setExecutionTimestamp(long executionTimestamp, boolean force) setter for timestamp of execution plan for next run additionally task is marked done == false
long	setHeartbeatTimeout(long heartbeatTimeout) setter for heartbeat timeout value
boolean	setStopOnTimeoutFlag(boolean stopOnTimeoutFlag) setter for stopOnTimeout flag If a task runs in a timeout, the worker is no longer in use, but normally continuing running to finish the runMethode.
long	setTimeout(long timeout) setter for timeout value
void	timeout() notify, that this task runs to long

Method Detail

isDone

boolean isDone()

Returns:

true, of task is done, otherwise false

setDone

boolean setDone()

mark task as done

Returns:

true, if task is already marked as done, otherwise false

getExecutionTimestamp

long getExecutionTimestamp()

Returns:

timestamp of execution plan for next run

getExecutionTimestampSource

ITaskControl.ExecutionTimestampSource getExecutionTimestampSource()

Returns:

SourceType of executionTimestamp

setExecutionTimestamp

boolean setExecutionTimestamp(long executionTimestamp,
                              boolean force)

setter for timestamp of execution plan for next run
additionally task is marked done == false

Parameters:

executionTimestamp - timestamp for next run

force - force to set new execution timestamp

Returns:

success state

getTimeout

long getTimeout()

getter for timout value

Returns:

timeout value

setTimeout

long setTimeout(long timeout)

setter for timeout value

Parameters:

timeout - new timeout value

Returns:

overwritten timeout value

getHeartbeatTimeout

long getHeartbeatTimeout()

getter for heartbeat timeout value

Returns:

heartbeat timeout value

setHeartbeatTimeout

long setHeartbeatTimeout(long heartbeatTimeout)

setter for heartbeat timeout value

Parameters:

heartbeatTimeout - new heartbeat timeout value

Returns:

overwritten heartbeat timeout value

timeout

void timeout()

notify, that this task runs to long

isInTimeout

boolean isInTimeout()

Returns:

true if task runs to long (timeout or heartbeat timeout), otherwise false

setStopOnTimeoutFlag

boolean setStopOnTimeoutFlag(boolean stopOnTimeoutFlag)

setter for stopOnTimeout flag If a task runs in a timeout, the worker is no longer in use, but normally continuing running to finish the runMethode. A long running task should ask for timeout by invoking isInTimeOut() periodically to clean up and skip continuing. But, if worker is blocked by network operation for example, the guardian can stop worker thread by setting stopOnTimeoutFlag true. Attention !!! You should be familiar with all things can happens by stopping a thread. You can handle some issues if IChannelTask implements IOnTaskStop

Parameters:

stopOnTimeoutFlag - new stopOnTimeoutFlag value

Returns:

old stopOnTimeout value

getStopOnTimeoutFlag

boolean getStopOnTimeoutFlag()

getter for stopOnTimeout flag

Returns:

stopOnTimeout flag