Package com.oracle.coherence.concurrent.executor

Class ClusteredTaskCoordinator<T>

java.lang.Object

com.oracle.coherence.concurrent.executor.AbstractTaskCoordinator<T>

com.oracle.coherence.concurrent.executor.ClusteredTaskCoordinator<T>

Type Parameters:

T - the type of the Task result

All Implemented Interfaces:

Task.Coordinator<T>, MapListener, EventListener

public class ClusteredTaskCoordinator<T>
extends AbstractTaskCoordinator<T>
implements MapListener

An implementation of a Task.Coordinator for Coherence-based implementation.

Since:

21.12

Version:

bo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ClusteredTaskCoordinator.ClusteredMemberListener	A MemberListener to monitor the member this ClusteredTaskCoordinator is part of / connected to in case of an *Extend client.

Field Summary

Fields

Modifier and Type	Field	Description
protected final CacheService	f_cacheService	The CacheService used by the executor service.
protected final ClusteredTaskCoordinator<T>.ClusteredMemberListener	f_memberListener	The member listener for cluster member.
protected Task.Properties	m_properties	The sharable Task.Properties for this task.

Fields inherited from class com.oracle.coherence.concurrent.executor.AbstractTaskCoordinator

f_cancelled, f_closed, f_executorService, f_fRetainTask, f_sTaskId, m_lastValue, m_setSubscribers

Fields inherited from interface com.tangosol.util.MapListener

ASYNCHRONOUS, SYNCHRONOUS, VERSION_AWARE

Constructor Summary

Constructors

Constructor	Description
ClusteredTaskCoordinator(CacheService service, ClusteredTaskManager manager, ExecutorService executorService)	Constructs a ClusteredTaskCoordinator.
ClusteredTaskCoordinator(CacheService service, ClusteredTaskManager manager, ExecutorService executorService, Task.Properties properties, Iterator<Task.Subscriber<? super T>> subscribers)	Constructs a ClusteredTaskCoordinator.

Method Summary

Modifier and Type	Method	Description
void	addMemberListener(MemberListener listener)	Adds the specified MemberListener.
boolean	cancel(boolean fMayInterruptIfRunning)	Attempts to cancel execution of the Task.
void	close()	Closes this ClusteredTaskCoordinator and notifies the Task.Subscribers that there will no longer be any further items by calling Task.Subscriber.onComplete().
void	entryDeleted(MapEvent mapEvent)	Invoked when a map entry has been removed.
void	entryInserted(MapEvent mapEvent)	Invoked when a map entry has been inserted.
void	entryUpdated(MapEvent mapEvent)	Invoked when a map entry has been updated.
protected CacheService	getCacheService()	Return the underlying CacheService for the executor service.
Task.Properties	getProperties()	Obtain the properties of the Task being coordinated.
protected void	removeMapListener()	Removes the MapListener previously installed by this ClusteredTaskCoordinator.
void	removeMemberListener(MemberListener listener)	Removes the specified MemberListener.
protected void	subscribeRetainedTask(Task.Subscriber subscriber)	Subscribes to a retained task (a task that has completed execution, but it still held in memory).

Methods inherited from class com.oracle.coherence.concurrent.executor.AbstractTaskCoordinator

closeSubscriber, getTaskId, hasSubscribers, isCancelled, isDone, offer, subscribe

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tangosol.util.MapListener

characteristics, isAsynchronous, isSynchronous, isVersionAware, synchronous

Field Details

m_properties

protected Task.Properties m_properties

The sharable Task.Properties for this task.

f_memberListener

protected final ClusteredTaskCoordinator<T>.ClusteredMemberListener f_memberListener

The member listener for cluster member.

f_cacheService

protected final CacheService f_cacheService

The CacheService used by the executor service.

Constructor Details

ClusteredTaskCoordinator

public ClusteredTaskCoordinator(CacheService service,
 ClusteredTaskManager manager,
 ExecutorService executorService)

Constructs a ClusteredTaskCoordinator. This constructor should only be used to obtain a coordinator for a previously submitted task.

Parameters:

service - the CacheService containing the orchestration metadata caches

manager - the ClusteredTaskManager

executorService - the ExecutorService from the TaskExecutorService for asynchronous publishing

ClusteredTaskCoordinator

public ClusteredTaskCoordinator(CacheService service,
 ClusteredTaskManager manager,
 ExecutorService executorService,
 Task.Properties properties,
 Iterator<Task.Subscriber<? super T>> subscribers)

Constructs a ClusteredTaskCoordinator.

Parameters:

service - the CacheService containing the orchestration metadata caches

manager - the ClusteredTaskManager

executorService - the ExecutorService from the TaskExecutorService for asynchronous publishing

properties - the Task.Properties of the task

subscribers - an optional set of subscribers to pre-register

Method Details

cancel

public boolean cancel(boolean fMayInterruptIfRunning)

Description copied from interface: Task.Coordinator

Attempts to cancel execution of the Task. This attempt will fail if the task has already completed, has already been cancelled, or could not be cancelled for some other reason. If successful, and this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task should be interrupted in an attempt to stop the task.

After this method returns, subsequent calls to isDone() will always return true. Subsequent calls to isDone() will always return true if this method returned true.

Specified by:

cancel in interface Task.Coordinator<T>

Overrides:

cancel in class AbstractTaskCoordinator<T>

Parameters:

fMayInterruptIfRunning - true if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete

Returns:

false if the task could not be cancelled, typically because it has already completed normally; true otherwise

See Also:

• Future.cancel(boolean)

getProperties

public Task.Properties getProperties()

Description copied from interface: Task.Coordinator

Obtain the properties of the Task being coordinated.

Specified by:

getProperties in interface Task.Coordinator<T>

Returns:

the task properties

subscribeRetainedTask

protected void subscribeRetainedTask(Task.Subscriber subscriber)

Description copied from class: AbstractTaskCoordinator

Subscribes to a retained task (a task that has completed execution, but it still held in memory).

Specified by:

subscribeRetainedTask in class AbstractTaskCoordinator<T>

Parameters:

subscriber - the subscriber

close

public void close()

Closes this ClusteredTaskCoordinator and notifies the Task.Subscribers that there will no longer be any further items by calling Task.Subscriber.onComplete().

Overrides:

close in class AbstractTaskCoordinator<T>

entryInserted

public void entryInserted(MapEvent mapEvent)

Description copied from interface: MapListener

Invoked when a map entry has been inserted.

Specified by:

entryInserted in interface MapListener

Parameters:

mapEvent - the MapEvent carrying the insert information

entryUpdated

public void entryUpdated(MapEvent mapEvent)

Description copied from interface: MapListener

Invoked when a map entry has been updated.

Specified by:

entryUpdated in interface MapListener

Parameters:

mapEvent - the MapEvent carrying the update information

entryDeleted

public void entryDeleted(MapEvent mapEvent)

Description copied from interface: MapListener

Invoked when a map entry has been removed.

Specified by:

entryDeleted in interface MapListener

Parameters:

mapEvent - the MapEvent carrying the delete information

addMemberListener

public void addMemberListener(MemberListener listener)

Adds the specified MemberListener.

Parameters:

listener - the MemberListener to add

removeMemberListener

public void removeMemberListener(MemberListener listener)

Removes the specified MemberListener.

Parameters:

listener - the MemberListener to remove

getCacheService

protected CacheService getCacheService()

Return the underlying CacheService for the executor service.

Returns:

the underlying CacheService

removeMapListener

protected void removeMapListener()

Removes the MapListener previously installed by this ClusteredTaskCoordinator.