Package com.tangosol.coherence.commonj

Class WorkManager.AbstractWork

java.lang.Object

com.tangosol.util.Base

com.tangosol.net.AbstractInvocable

com.tangosol.coherence.commonj.WorkManager.AbstractWork

All Implemented Interfaces:

ExternalizableLite, PortableObject, Invocable, InvocableInOrder, PriorityTask, Serializable, Runnable

Direct Known Subclasses:

WorkManager.ReleaseWork, WorkManager.RequestStatus, WorkManager.ScheduleWork, WorkManager.SendFeedback

Enclosing class:

WorkManager

protected abstract static class WorkManager.AbstractWork
extends AbstractInvocable
implements ExternalizableLite, PortableObject

Base class for Invocable tasks related to the WorkManager. Note, that aside of the ScheduleWork task all other tasks have to be scheduled immediately.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.tangosol.util.Base

Base.LoggingWriter

Field Summary

Fields

Modifier and Type	Field	Description
protected long	m_lWorkId	The work id.
protected int	m_nMemberId	The Work originator Member id.

Fields inherited from class com.tangosol.util.Base

LOG_ALWAYS, LOG_CONFIG, LOG_DEBUG, LOG_ERR, LOG_INFO, LOG_MAX, LOG_MIN, LOG_QUIET, LOG_WARN, POWER_0, POWER_G, POWER_K, POWER_M, POWER_T, UNIT_D, UNIT_H, UNIT_M, UNIT_MS, UNIT_NS, UNIT_S, UNIT_US

Fields inherited from interface com.tangosol.net.PriorityTask

SCHEDULE_FIRST, SCHEDULE_IMMEDIATE, SCHEDULE_STANDARD, TIMEOUT_DEFAULT, TIMEOUT_NONE

Constructor Summary

Constructors

Constructor	Description
AbstractWork()	Default constructor (necessary for a lite serialization).
AbstractWork(long lWorkId, int nMemberId)	Construct the AbstractWork to be executed on behalf of the specified member (a Work originator).

Method Summary

Modifier and Type	Method	Description
Member	getMember()	Return a Work originator's Member object.
int	getMemberId()	Return a Work originator's Member id.
int	getSchedulingPriority()	Obtain this task's scheduling priority.
long	getWorkId()	Return a Work id.
void	readExternal(PofReader in)	Restore the contents of a user type instance by reading its state using the specified PofReader object.
void	readExternal(DataInput in)	Restore the contents of this object by loading the object's state from the passed DataInput object.
void	writeExternal(PofWriter out)	Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
void	writeExternal(DataOutput out)	Save the contents of this object by storing the object's state into the passed DataOutput object.

Methods inherited from class com.tangosol.net.AbstractInvocable

getExecutionTimeoutMillis, getRequestTimeoutMillis, getResult, getService, init, isRespondInOrder, runCanceled, setResult

Methods inherited from class com.tangosol.util.Base

azzert, azzert, azzert, azzertFailed, breakLines, breakLines, capitalize, checkNotEmpty, checkNotNull, checkRange, computeSafeWaitTime, decimalValue, dup, dup, ensureBigDecimal, ensureClassLoader, ensureRuntimeException, ensureRuntimeException, equals, equalsDeep, err, err, err, err, err, escape, formatDateTime, getCallerStackFrame, getCommonMonitor, getCommonMonitor, getCommonMonitor, getContextClassLoader, getContextClassLoader, getDeepMessage, getErr, getLastSafeTimeMillis, getLog, getMaxDecDigits, getMaxHexDigits, getOriginalException, getOut, getProcessRandom, getRandom, getRandomBinary, getRandomBinary, getRandomString, getSafeTimeMillis, getStackFrame, getStackFrames, getStackTrace, getStackTrace, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, mergeArray, mergeBooleanArray, mergeByteArray, mergeCharArray, mergeDoubleArray, mergeFloatArray, mergeIntArray, mergeLongArray, mod, mod, octalValue, out, out, out, out, out, pad, parseBandwidth, parseBandwidth, parseDelimitedString, parseHex, parseHex, parseMemorySize, parseMemorySize, parsePercentage, parseTime, parseTime, parseTimeNanos, parseTimeNanos, printStackTrace, randomize, randomize, randomize, randomize, read, read, read, read, read, read, read, replace, setErr, setLog, setLogEcho, setOut, sleep, toBandwidthString, toBandwidthString, toCharEscape, toCrc, toCrc, toCrc, toCrc, toCrc, toDecString, toDelimitedString, toDelimitedString, toDelimitedString, toDelimitedString, toHex, toHex, toHexDump, toHexEscape, toHexEscape, toHexEscape, toHexEscape, toHexString, toMemorySizeString, toMemorySizeString, toQuotedCharEscape, toQuotedStringEscape, toSqlString, toString, toString, toStringEscape, toUnicodeEscape, trace, trace, trace, trace, trace, trace, trace, trace, trace, truncateString, truncateString, wait

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tangosol.net.Invocable

run

Field Detail

m_lWorkId

protected long m_lWorkId

The work id.

m_nMemberId

protected int m_nMemberId

The Work originator Member id.

Constructor Detail

AbstractWork

public AbstractWork()

Default constructor (necessary for a lite serialization).

AbstractWork

public AbstractWork(long lWorkId,
                    int nMemberId)

Construct the AbstractWork to be executed on behalf of the specified member (a Work originator).

Parameters:

lWorkId - the Work id

nMemberId - the target Member id

Method Detail

getSchedulingPriority

public int getSchedulingPriority()

Obtain this task's scheduling priority. Valid values are one of the SCHEDULE_* constants.

This implementation returns SCHEDULE_STANDARD.

Specified by:

getSchedulingPriority in interface PriorityTask

Overrides:

getSchedulingPriority in class AbstractInvocable

Returns:

this task's scheduling priority

getWorkId

public long getWorkId()

Return a Work id.

Returns:

a Work id

getMemberId

public int getMemberId()

Return a Work originator's Member id.

Returns:

a Member id

getMember

public Member getMember()

Return a Work originator's Member object.

Returns:

a Member object or null

readExternal

public void readExternal(DataInput in)
                  throws IOException

Restore the contents of this object by loading the object's state from the passed DataInput object.

Specified by:

readExternal in interface ExternalizableLite

Parameters:

in - the DataInput stream to read data from in order to restore the state of this object

Throws:

IOException - if an I/O exception occurs

NotActiveException - if the object is not in its initial state, and therefore cannot be deserialized into

writeExternal

public void writeExternal(DataOutput out)
                   throws IOException

Save the contents of this object by storing the object's state into the passed DataOutput object.

Specified by:

writeExternal in interface ExternalizableLite

Parameters:

out - the DataOutput stream to write the state of this object to

Throws:

IOException - if an I/O exception occurs

readExternal

public void readExternal(PofReader in)
                  throws IOException

Restore the contents of a user type instance by reading its state using the specified PofReader object.

Specified by:

readExternal in interface PortableObject

Parameters:

in - the PofReader from which to read the object's state

Throws:

IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter out)
                   throws IOException

Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Specified by:

writeExternal in interface PortableObject

Parameters:

out - the PofWriter to which to write the object's state

Throws:

IOException - if an I/O error occurs