Package com.oracle.coherence.concurrent.executor

Class ClusteredExecutorInfo

java.lang.Object

com.oracle.coherence.concurrent.executor.ClusteredExecutorInfo

All Implemented Interfaces:

ClusterMemberAware, Leased, LiveObject, TaskExecutorService.ExecutorInfo, com.tangosol.io.ExternalizableLite, com.tangosol.io.pof.PortableObject, Serializable

public class ClusteredExecutorInfo
extends Object
implements TaskExecutorService.ExecutorInfo, LiveObject, Leased, ClusterMemberAware, com.tangosol.io.pof.PortableObject

A Coherence-based implementation of a TaskExecutorService.ExecutorInfo.

Since:

21.12

Author:

bo

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ClusteredExecutorInfo.CacheAwareContinuation
static class	ClusteredExecutorInfo.ClosingContinuation	A ComposableContinuation to close a ClusteredExecutorInfo, including cleaning up assigned Tasks.
static class	ClusteredExecutorInfo.ClosingGracefullyContinuation	A ComposableContinuation to gracefully close a ClusteredExecutorInfo, allowing already assigned Tasks to complete.
static class	ClusteredExecutorInfo.JoiningContinuation	A ComposableContinuation to commence orchestrating a new Executor with existing Tasks.
static class	ClusteredExecutorInfo.RemoveContinuation	A ComposableContinuation to remove a ClusteredExecutorInfo.
static class	ClusteredExecutorInfo.SetStateProcessor	An InvocableMap.EntryProcessor to compare and set the state of a ClusteredExecutorInfo, returning the previous state.
static class	ClusteredExecutorInfo.TouchProcessor	An InvocableMap.EntryProcessor to update the last update timestamp of a ClusteredExecutorInfo.
static class	ClusteredExecutorInfo.TouchRunnable	A Runnable to asynchronously touch.
static class	ClusteredExecutorInfo.UpdateInfoProcessor	An InvocableMap.EntryProcessor to update the state of an TaskExecutorService.ExecutorInfo.
static class	ClusteredExecutorInfo.UpdateInfoRunnable	A Runnable to asynchronously update the state of ClusteredExecutorInfo using the information based on the current Runtime.

Nested classes/interfaces inherited from interface com.oracle.coherence.concurrent.executor.TaskExecutorService.ExecutorInfo

TaskExecutorService.ExecutorInfo.State

Field Summary

Fields

Modifier and Type	Field	Description
static long	LEASE_DURATION_MS	The duration of a lease for Executors.
protected long	m_cCompleted	The completed tasks count.
protected long	m_cFreeMemory	The free memory as reported by Runtime.freeMemory().
protected long	m_cInProgress	The tasks that are in progress count.
protected long	m_cMaxMemory	The maximum memory as reported by Runtime.maxMemory().
protected long	m_cRejected	The rejected tasks count.
protected long	m_cTotalMemory	The total memory as reported by Runtime.totalMemory().
protected long	m_ldtUpdate	The cluster time when the TaskExecutorService.ExecutorInfo was last updated.
protected OptionsByType<TaskExecutorService.Registration.Option>	m_optionsByType	The TaskExecutorService.Registration.Options for the Executor.
protected String	m_sIdentity	The identity of the TaskExecutorService.Registration.
protected TaskExecutorService.ExecutorInfo.State	m_state	The TaskExecutorService.ExecutorInfo.State of the Executor.

Constructor Summary

Constructors

Constructor	Description
ClusteredExecutorInfo()	Constructs a ClusteredExecutorInfo (for serialization support).
ClusteredExecutorInfo(String sIdentity, long ldtUpdate, long cMaxMemory, long totalMemory, long freeMemory, OptionsByType<TaskExecutorService.Registration.Option> optionsByType)	Constructs a ClusteredExecutorInfo with the specified parameters.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the description of the ClusteredExecutorInfo.
String	getExecutorName()	Return the logical name of this ClusteredExecutorInfo.
long	getFreeMemory()	The last reported free memory by Runtime.freeMemory() available to the ExecutorService.
String	getId()	Obtains the unique identity for the ExecutorService.
long	getLastUpdateTime()	Obtains the time since the epoch when the TaskExecutorService.ExecutorInfo was last updated.
long	getLeaseExpiryTime()	Obtains the time the lease will expiry (in milliseconds since the epoc).
long	getMaxMemory()	The last reported maximum memory by Runtime.maxMemory() available to the ExecutorService.
<T extends TaskExecutorService.Registration.Option> T	getOption(Class<T> clzOfOption, T defaultIfNotFound)	Obtains the TaskExecutorService.Registration.Option of the specified class when the ExecutorService was registered, or the default value if not found.
TaskExecutorService.ExecutorInfo.State	getState()	Obtains the current TaskExecutorService.ExecutorInfo.State of the Executor.
long	getTasksCompletedCount()	Return the number of completed tasks.
long	getTasksInProgressCount()	Return the number of tasks currently in progress.
long	getTasksRejectedCount()	Return the number rejected tasks.
long	getTotalMemory()	The last reported total memory by Runtime.totalMemory() available to the ExecutorService.
com.tangosol.util.UID	getUid()	The UID of the Member for which this object wishes to receive membership events.
ComposableContinuation	onDeleted(com.tangosol.net.CacheService service, com.tangosol.util.InvocableMap.Entry entry, Cause cause)	The LiveObject was deleted.
ComposableContinuation	onInserted(com.tangosol.net.CacheService service, com.tangosol.util.InvocableMap.Entry entry, Cause cause)	The LiveObject was inserted.
boolean	onLeaseExpiry()	A callback invoked as part of an InvocableMap.EntryProcessor to perform custom lease expiry operations when a lease has expired.
boolean	onMemberJoined()	A callback invoked as part of an InvocableMap.EntryProcessor to perform custom operations when the Member has joined the cluster.
boolean	onMemberLeaving()	A callback invoked as part of an InvocableMap.EntryProcessor to perform custom operations when the Member is leaving the cluster.
boolean	onMemberLeft()	A callback invoked as part of an InvocableMap.EntryProcessor to perform custom operations when the Member is leaving the cluster.
ComposableContinuation	onUpdated(com.tangosol.net.CacheService service, com.tangosol.util.InvocableMap.Entry entry, Cause cause)	The LiveObject was updated.
void	readExternal(com.tangosol.io.pof.PofReader in)
void	readExternal(DataInput in)
void	renew()	Renews the lease for some period of time.
void	setFreeMemory(long cFreeMemory)	Sets the free memory as reported by Runtime.freeMemory().
void	setMaxMemory(long cMaxMemory)	Sets the maximum memory as reported by Runtime.maxMemory().
void	setState(TaskExecutorService.ExecutorInfo.State state)	Sets the current TaskExecutorService.ExecutorInfo.State of the Executor.
void	setTasksCompletedCount(long cTasksCompleted)	Sets the number of completed tasks.
void	setTasksFailedCount(long cTasksFailed)	Sets the number of task failures.
void	setTasksInProgressCount(long cTasksInProgress)	Sets the number of tasks currently in progress.
void	setTotalMemory(long cTotalMemory)	Sets the total memory as reported by Runtime.totalMemory().
String	toString()
void	touch()	Touches the last update time for the TaskExecutorService.ExecutorInfo.
void	writeExternal(com.tangosol.io.pof.PofWriter out)
void	writeExternal(DataOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

LEASE_DURATION_MS

public static long LEASE_DURATION_MS

The duration of a lease for Executors.

When TaskExecutorService.ExecutorInfo for an Executor has not been updated for the lease duration time, the Executor is considered to be offline and should automatically be de-registered.

m_state

protected TaskExecutorService.ExecutorInfo.State m_state

The TaskExecutorService.ExecutorInfo.State of the Executor.

m_sIdentity

protected String m_sIdentity

The identity of the TaskExecutorService.Registration.

m_optionsByType

protected OptionsByType<TaskExecutorService.Registration.Option> m_optionsByType

The TaskExecutorService.Registration.Options for the Executor.

m_ldtUpdate

protected long m_ldtUpdate

The cluster time when the TaskExecutorService.ExecutorInfo was last updated.

m_cMaxMemory

protected long m_cMaxMemory

The maximum memory as reported by Runtime.maxMemory().

m_cTotalMemory

protected long m_cTotalMemory

The total memory as reported by Runtime.totalMemory().

m_cFreeMemory

protected long m_cFreeMemory

The free memory as reported by Runtime.freeMemory().

m_cCompleted

protected long m_cCompleted

The completed tasks count.

m_cRejected

protected long m_cRejected

The rejected tasks count.

m_cInProgress

protected long m_cInProgress

The tasks that are in progress count.

Constructor Detail

ClusteredExecutorInfo

public ClusteredExecutorInfo()

Constructs a ClusteredExecutorInfo (for serialization support).

ClusteredExecutorInfo

public ClusteredExecutorInfo(String sIdentity,
                             long ldtUpdate,
                             long cMaxMemory,
                             long totalMemory,
                             long freeMemory,
                             OptionsByType<TaskExecutorService.Registration.Option> optionsByType)

Constructs a ClusteredExecutorInfo with the specified parameters.

Parameters:

sIdentity - the identity

ldtUpdate - the time since the epoc when the TaskExecutorService.ExecutorInfo was last updated

cMaxMemory - the maximum memory as reported by Runtime.maxMemory()

totalMemory - the total memory as reported by Runtime.totalMemory()

freeMemory - the free memory as reported by Runtime.freeMemory()

optionsByType - the TaskExecutorService.Registration.Options for the Executor

Method Detail

touch

public void touch()

Touches the last update time for the TaskExecutorService.ExecutorInfo.

getId

public String getId()

Description copied from interface: TaskExecutorService.ExecutorInfo

Obtains the unique identity for the ExecutorService.

Specified by:

getId in interface TaskExecutorService.ExecutorInfo

Returns:

the unique identity

getState

public TaskExecutorService.ExecutorInfo.State getState()

Obtains the current TaskExecutorService.ExecutorInfo.State of the Executor.

Specified by:

getState in interface TaskExecutorService.ExecutorInfo

Returns:

the current TaskExecutorService.ExecutorInfo.State

getLastUpdateTime

public long getLastUpdateTime()

Description copied from interface: TaskExecutorService.ExecutorInfo

Obtains the time since the epoch when the TaskExecutorService.ExecutorInfo was last updated.

Specified by:

getLastUpdateTime in interface TaskExecutorService.ExecutorInfo

Returns:

the time since the epoch for the last update

getMaxMemory

public long getMaxMemory()

Description copied from interface: TaskExecutorService.ExecutorInfo

The last reported maximum memory by Runtime.maxMemory() available to the ExecutorService.

Specified by:

getMaxMemory in interface TaskExecutorService.ExecutorInfo

Returns:

the maximum memory (in bytes)

getTotalMemory

public long getTotalMemory()

Description copied from interface: TaskExecutorService.ExecutorInfo

The last reported total memory by Runtime.totalMemory() available to the ExecutorService.

Specified by:

getTotalMemory in interface TaskExecutorService.ExecutorInfo

Returns:

the total memory (in bytes)

getFreeMemory

public long getFreeMemory()

Description copied from interface: TaskExecutorService.ExecutorInfo

The last reported free memory by Runtime.freeMemory() available to the ExecutorService.

Specified by:

getFreeMemory in interface TaskExecutorService.ExecutorInfo

Returns:

the free memory (in bytes)

getOption

public <T extends TaskExecutorService.Registration.Option> T getOption(Class<T> clzOfOption,
                                                                       T defaultIfNotFound)

Description copied from interface: TaskExecutorService.ExecutorInfo

Obtains the TaskExecutorService.Registration.Option of the specified class when the ExecutorService was registered, or the default value if not found.

Specified by:

getOption in interface TaskExecutorService.ExecutorInfo

Type Parameters:

T - the type of the TaskExecutorService.Registration.Option

Parameters:

clzOfOption - the class of TaskExecutorService.Registration.Option

defaultIfNotFound - the value to return if not found

Returns:

a TaskExecutorService.Registration.Option

setState

public void setState(TaskExecutorService.ExecutorInfo.State state)

Sets the current TaskExecutorService.ExecutorInfo.State of the Executor.

Parameters:

state - the desired TaskExecutorService.ExecutorInfo.State

getTasksCompletedCount

public long getTasksCompletedCount()

Return the number of completed tasks.

Returns:

the number of completed tasks

getTasksRejectedCount

public long getTasksRejectedCount()

Return the number rejected tasks.

Returns:

the number rejected tasks

getTasksInProgressCount

public long getTasksInProgressCount()

Return the number of tasks currently in progress.

Returns:

the number of tasks currently in progress

setMaxMemory

public void setMaxMemory(long cMaxMemory)

Sets the maximum memory as reported by Runtime.maxMemory().

Parameters:

cMaxMemory - the maximum memory

setTotalMemory

public void setTotalMemory(long cTotalMemory)

Sets the total memory as reported by Runtime.totalMemory().

Parameters:

cTotalMemory - the total memory

setFreeMemory

public void setFreeMemory(long cFreeMemory)

Sets the free memory as reported by Runtime.freeMemory().

Parameters:

cFreeMemory - the free memory

setTasksCompletedCount

public void setTasksCompletedCount(long cTasksCompleted)

Sets the number of completed tasks.

Parameters:

cTasksCompleted - the number of completed tasks

setTasksFailedCount

public void setTasksFailedCount(long cTasksFailed)

Sets the number of task failures.

Parameters:

cTasksFailed - the number of failed tasks

setTasksInProgressCount

public void setTasksInProgressCount(long cTasksInProgress)

Sets the number of tasks currently in progress.

Parameters:

cTasksInProgress - the number of tasks in progress

getExecutorName

public String getExecutorName()

Return the logical name of this ClusteredExecutorInfo.

Returns:

the logical name of this ClusteredExecutorInfo

getDescription

public String getDescription()

Return the description of the ClusteredExecutorInfo.

Returns:

the description of the ClusteredExecutorInfo

Since:

22.06

toString

public String toString()

Overrides:

toString in class Object

getLeaseExpiryTime

public long getLeaseExpiryTime()

Description copied from interface: Leased

Obtains the time the lease will expiry (in milliseconds since the epoc).

Specified by:

getLeaseExpiryTime in interface Leased

Returns:

the time in milliseconds since the epoc

renew

public void renew()

Description copied from interface: Leased

Renews the lease for some period of time.

Specified by:

renew in interface Leased

onLeaseExpiry

public boolean onLeaseExpiry()

Description copied from interface: Leased

A callback invoked as part of an InvocableMap.EntryProcessor to perform custom lease expiry operations when a lease has expired.

Specified by:

onLeaseExpiry in interface Leased

Returns:

true if the Leased state was mutated and should be saved, false otherwise

onInserted

public ComposableContinuation onInserted(com.tangosol.net.CacheService service,
                                         com.tangosol.util.InvocableMap.Entry entry,
                                         Cause cause)

Description copied from interface: LiveObject

The LiveObject was inserted.

Specified by:

onInserted in interface LiveObject

Parameters:

service - the CacheService for the LiveObject

entry - the entry being inserted

cause - the Cause of the Event

Returns:

an optional ComposableContinuation to be performed asynchronously for the LiveObject (may be null)

onUpdated

public ComposableContinuation onUpdated(com.tangosol.net.CacheService service,
                                        com.tangosol.util.InvocableMap.Entry entry,
                                        Cause cause)

Description copied from interface: LiveObject

The LiveObject was updated.

This callback is invoked against the updated value, not the original value. The original value is available via the provided Event.

Specified by:

onUpdated in interface LiveObject

Parameters:

service - the CacheService for the LiveObject

entry - the entry being updated

cause - the Cause of the Event

Returns:

an optional ComposableContinuation to be performed asynchronously for the LiveObject (may be null)

onDeleted

public ComposableContinuation onDeleted(com.tangosol.net.CacheService service,
                                        com.tangosol.util.InvocableMap.Entry entry,
                                        Cause cause)

Description copied from interface: LiveObject

The LiveObject was deleted.

Specified by:

onDeleted in interface LiveObject

Parameters:

service - the CacheService for the LiveObject

entry - the entry being deleted

cause - the Cause of the Event

Returns:

an optional ComposableContinuation to be performed asynchronously for the LiveObject (may be null)

getUid

public com.tangosol.util.UID getUid()

Description copied from interface: ClusterMemberAware

The UID of the Member for which this object wishes to receive membership events. May return null which means do not receive membership events.

Specified by:

getUid in interface ClusterMemberAware

Returns:

a UID

onMemberJoined

public boolean onMemberJoined()

Description copied from interface: ClusterMemberAware

A callback invoked as part of an InvocableMap.EntryProcessor to perform custom operations when the Member has joined the cluster.

Specified by:

onMemberJoined in interface ClusterMemberAware

Returns:

true if the ClusterMemberAware state was mutated and should be saved, false otherwise

See Also:

MemberListener.memberJoined(MemberEvent)

onMemberLeaving

public boolean onMemberLeaving()

Description copied from interface: ClusterMemberAware

A callback invoked as part of an InvocableMap.EntryProcessor to perform custom operations when the Member is leaving the cluster.

Specified by:

onMemberLeaving in interface ClusterMemberAware

Returns:

true if the ClusterMemberAware state was mutated and should be saved, false otherwise

onMemberLeft

public boolean onMemberLeft()

Description copied from interface: ClusterMemberAware

A callback invoked as part of an InvocableMap.EntryProcessor to perform custom operations when the Member is leaving the cluster.

See MemberListener.memberLeft(MemberEvent).

Specified by:

onMemberLeft in interface ClusterMemberAware

Returns:

true if the ClusterMemberAware state was mutated and should be saved, false otherwise

readExternal

public void readExternal(DataInput in)
                  throws IOException

Specified by:

readExternal in interface com.tangosol.io.ExternalizableLite

Throws:

IOException

writeExternal

public void writeExternal(DataOutput out)
                   throws IOException

Specified by:

writeExternal in interface com.tangosol.io.ExternalizableLite

Throws:

IOException

readExternal

public void readExternal(com.tangosol.io.pof.PofReader in)
                  throws IOException

Specified by:

readExternal in interface com.tangosol.io.pof.PortableObject

Throws:

IOException

writeExternal

public void writeExternal(com.tangosol.io.pof.PofWriter out)
                   throws IOException

Specified by:

writeExternal in interface com.tangosol.io.pof.PortableObject

Throws:

IOException