org.sodeac.common.message.dispatcher.impl

Class TaskControlImpl

java.lang.Object

org.sodeac.common.message.dispatcher.impl.TaskControlImpl

All Implemented Interfaces:

ITaskControl

public class TaskControlImpl
extends Object
implements ITaskControl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TaskControlImpl.PeriodicServiceTimestampPredicate Predicate to test for set periodic reschedule service timestamp
static class	TaskControlImpl.RescheduleTimestampPredicate Predicate to test for IChannel.rescheduleTask(String, long, long, long)
static class	TaskControlImpl.ScheduleTimestampPredicate Predicate to test for IChannel#scheduleTask(org.sodeac.messagedispatcher.api.IQueueTask) ...
class	TaskControlImpl.SetTimestampRequest

Nested classes/interfaces inherited from interface org.sodeac.common.message.dispatcher.api.ITaskControl

ITaskControl.ExecutionTimestampSource

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TaskControlImpl(IPropertyBlock taskPropertyBlock)

Method Summary

Modifier and Type	Method and Description
long	getExecutionTimestamp()
long	getExecutionTimeStampIntern()
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()
void	postRun()
void	preRun()
void	preRunPeriodicTask()
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
boolean	setExecutionTimeStamp(long executionTimeStamp, ITaskControl.ExecutionTimestampSource type, Predicate<TaskControlImpl.SetTimestampRequest> predicate)
void	setExecutionTimeStampSource(ITaskControl.ExecutionTimestampSource executionTimeStampSource)
long	setHeartbeatTimeout(long heartBeatTimeOut) setter for heartbeat timeout value
boolean	setStopOnTimeoutFlag(boolean value) 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
void	timeOutService()

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskControlImpl

protected TaskControlImpl(IPropertyBlock taskPropertyBlock)

Method Detail

preRun

public void preRun()

preRunPeriodicTask

public void preRunPeriodicTask()

postRun

public void postRun()

setDone

public boolean setDone()

Description copied from interface: ITaskControl

mark task as done

Specified by:

setDone in interface ITaskControl

Returns:

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

timeout

public void timeout()

Description copied from interface: ITaskControl

notify, that this task runs to long

Specified by:

timeout in interface ITaskControl

timeOutService

public void timeOutService()

isInTimeout

public boolean isInTimeout()

Specified by:

isInTimeout in interface ITaskControl

Returns:

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

getExecutionTimestamp

public long getExecutionTimestamp()

Specified by:

getExecutionTimestamp in interface ITaskControl

Returns:

timestamp of execution plan for next run

getExecutionTimestampSource

public ITaskControl.ExecutionTimestampSource getExecutionTimestampSource()

Specified by:

getExecutionTimestampSource in interface ITaskControl

Returns:

SourceType of executionTimestamp

setExecutionTimeStampSource

public void setExecutionTimeStampSource(ITaskControl.ExecutionTimestampSource executionTimeStampSource)

getExecutionTimeStampIntern

public long getExecutionTimeStampIntern()

setExecutionTimestamp

public boolean setExecutionTimestamp(long executionTimeStamp,
                                     boolean force)

Description copied from interface: ITaskControl

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

Specified by:

setExecutionTimestamp in interface ITaskControl

Parameters:

executionTimeStamp - timestamp for next run

force - force to set new execution timestamp

Returns:

success state

setExecutionTimeStamp

public boolean setExecutionTimeStamp(long executionTimeStamp,
                                     ITaskControl.ExecutionTimestampSource type,
                                     Predicate<TaskControlImpl.SetTimestampRequest> predicate)

getTimeout

public long getTimeout()

Description copied from interface: ITaskControl

getter for timout value

Specified by:

getTimeout in interface ITaskControl

Returns:

timeout value

setTimeout

public long setTimeout(long timeOut)

Description copied from interface: ITaskControl

setter for timeout value

Specified by:

setTimeout in interface ITaskControl

Parameters:

timeOut - new timeout value

Returns:

overwritten timeout value

getHeartbeatTimeout

public long getHeartbeatTimeout()

Description copied from interface: ITaskControl

getter for heartbeat timeout value

Specified by:

getHeartbeatTimeout in interface ITaskControl

Returns:

heartbeat timeout value

setHeartbeatTimeout

public long setHeartbeatTimeout(long heartBeatTimeOut)

Description copied from interface: ITaskControl

setter for heartbeat timeout value

Specified by:

setHeartbeatTimeout in interface ITaskControl

Parameters:

heartBeatTimeOut - new heartbeat timeout value

Returns:

overwritten heartbeat timeout value

isDone

public boolean isDone()

Specified by:

isDone in interface ITaskControl

Returns:

true, of task is done, otherwise false

setStopOnTimeoutFlag

public boolean setStopOnTimeoutFlag(boolean value)

Description copied from interface: ITaskControl

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

Specified by:

setStopOnTimeoutFlag in interface ITaskControl

Parameters:

value - new stopOnTimeoutFlag value

Returns:

old stopOnTimeout value

getStopOnTimeoutFlag

public boolean getStopOnTimeoutFlag()

Description copied from interface: ITaskControl

getter for stopOnTimeout flag

Specified by:

getStopOnTimeoutFlag in interface ITaskControl

Returns:

stopOnTimeout flag