Package org.apache.ignite.internal.util.worker

Class GridWorker

java.lang.Object

org.apache.ignite.internal.util.worker.GridWorker

All Implemented Interfaces:

Runnable, WorkProgressDispatcher

Direct Known Subclasses:

Checkpointer, CommunicationWorker, DmsDataWriterWorker, FileHandleManagerImpl.WALWriter, GridJobWorker, GridTaskWorker, SchemaIndexCachePartitionWorker, SchemaOperationWorker, StripedExecutor.Stripe

public abstract class GridWorker
extends Object
implements Runnable, WorkProgressDispatcher

Extension to standard Runnable interface. Adds proper details to be used with Executor implementations. Only for internal use.

Field Summary

Fields

Modifier and Type	Field	Description
protected AtomicBoolean	isCancelled	Whether or not this runnable is cancelled.
protected IgniteLogger	log	Ignite logger.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GridWorker(@Nullable String igniteInstanceName, String name, IgniteLogger log)	Creates new grid worker with given parameters.
protected	GridWorker(String igniteInstanceName, String name, IgniteLogger log, @Nullable GridWorkerListener lsnr)	Creates new grid worker with given parameters.

Method Summary

Modifier and Type	Method	Description
void	blockingSectionBegin()	Protects the worker from timeout penalties if subsequent instructions in the calling thread does not update heartbeat timestamp timely, e.g. due to blocking operations, up to the nearest WorkProgressDispatcher.blockingSectionEnd() call.
void	blockingSectionEnd()	Closes the protection section previously opened by WorkProgressDispatcher.blockingSectionBegin().
protected abstract void	body()	The implementation should provide the execution body for this runnable.
void	cancel()	Cancels this runnable.
protected void	cleanup()	Optional method that will be called after runnable is finished.
long	heartbeatTs()	Last heatbeat timestamp.
String	igniteInstanceName()	Gets name of the Ignite instance this runnable belongs to.
boolean	isCancelled()	Tests whether or not this runnable is cancelled.
boolean	isDone()	Tests whether or not this runnable is finished.
void	join()	Joins this runnable.
String	name()	Gets this runnable name.
protected void	onCancel(boolean firstCancelRequest)	Callback on runner cancellation.
protected void	onCancelledBeforeWorkerScheduled()	Callback on special case, when task is cancelled before is has been scheduled.
protected void	onIdle()	Can be called from runner() thread to perform idleness handling.
void	run()
@Nullable Thread	runner()
String	toString()
void	updateHeartbeat()	Notifying dispatcher that work is in progress and thread didn't freeze.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final IgniteLogger log

Ignite logger.

isCancelled

protected final AtomicBoolean isCancelled

Whether or not this runnable is cancelled.

Constructor Detail

GridWorker

protected GridWorker(String igniteInstanceName,
                     String name,
                     IgniteLogger log,
                     @Nullable
                     @Nullable GridWorkerListener lsnr)

Creates new grid worker with given parameters.

Parameters:

igniteInstanceName - Name of the Ignite instance this runnable is used in.

name - Worker name. Note that in general thread name and worker (runnable) name are two different things. The same worker can be executed by multiple threads and therefore for logging and debugging purposes we separate the two.

log - Grid logger to be used.

lsnr - Listener for life-cycle events.

GridWorker

protected GridWorker(@Nullable
                     @Nullable String igniteInstanceName,
                     String name,
                     IgniteLogger log)

Creates new grid worker with given parameters.

Parameters:

igniteInstanceName - Name of the Ignite instance this runnable is used in.

name - Worker name. Note that in general thread name and worker (runnable) name are two different things. The same worker can be executed by multiple threads and therefore for logging and debugging purposes we separate the two.

log - Grid logger to be used.

Method Detail

run

public final void run()

Specified by:

run in interface Runnable

body

protected abstract void body()
                      throws InterruptedException,
                             IgniteInterruptedCheckedException

The implementation should provide the execution body for this runnable.

Throws:

InterruptedException - Thrown in case of interruption.

IgniteInterruptedCheckedException - If interrupted.

cleanup

protected void cleanup()

Optional method that will be called after runnable is finished. Default implementation is no-op.

runner

@Nullable
public @Nullable Thread runner()

Returns:

Runner thread, null if the worker has not yet started executing.

igniteInstanceName

public String igniteInstanceName()

Gets name of the Ignite instance this runnable belongs to.

Returns:

Name of the Ignite instance this runnable belongs to.

name

public String name()

Gets this runnable name.

Returns:

This runnable name.

cancel

public void cancel()

Cancels this runnable.

join

public void join()
          throws InterruptedException

Joins this runnable.

Throws:

InterruptedException - Thrown in case of interruption.

isCancelled

public boolean isCancelled()

Tests whether or not this runnable is cancelled.

Returns:

true if this runnable is cancelled - false otherwise.

See Also:

Future.isCancelled()

isDone

public boolean isDone()

Tests whether or not this runnable is finished.

Returns:

true if this runnable is finished - false otherwise.

heartbeatTs

public long heartbeatTs()

Last heatbeat timestamp.

Specified by:

heartbeatTs in interface WorkProgressDispatcher

updateHeartbeat

public void updateHeartbeat()

Notifying dispatcher that work is in progress and thread didn't freeze.

Specified by:

updateHeartbeat in interface WorkProgressDispatcher

blockingSectionBegin

public void blockingSectionBegin()

Protects the worker from timeout penalties if subsequent instructions in the calling thread does not update heartbeat timestamp timely, e.g. due to blocking operations, up to the nearest WorkProgressDispatcher.blockingSectionEnd() call. Nested calls are not supported.

Specified by:

blockingSectionBegin in interface WorkProgressDispatcher

blockingSectionEnd

public void blockingSectionEnd()

Closes the protection section previously opened by WorkProgressDispatcher.blockingSectionBegin().

Specified by:

blockingSectionEnd in interface WorkProgressDispatcher

onIdle

protected void onIdle()

Can be called from runner() thread to perform idleness handling.

onCancel

protected void onCancel(boolean firstCancelRequest)

Callback on runner cancellation.

Parameters:

firstCancelRequest - Flag indicating that worker cancellation was requested for the first time.

onCancelledBeforeWorkerScheduled

protected void onCancelledBeforeWorkerScheduled()

Callback on special case, when task is cancelled before is has been scheduled.

toString

public String toString()

Overrides:

toString in class Object