Package com.tangosol.util.processor

Class AsynchronousProcessor<K,V,R>

java.lang.Object

com.tangosol.util.AsynchronousAgent<T>

com.tangosol.util.processor.AbstractAsynchronousProcessor<K,V,R,Map<K,R>>

com.tangosol.util.processor.AsynchronousProcessor<K,V,R>

Type Parameters:

K - the type of the Map entry key

V - the type of the Map entry value

R - the type of value returned by the EntryProcessor

All Implemented Interfaces:

FlowControl, InvocableMap.EntryProcessor<K,V,R>, Serializable, Future<Map<K,R>>

Direct Known Subclasses:

ContinuousQueryCache.ConverterAsynchronousProcessor

public class AsynchronousProcessor<K,V,R>
extends AbstractAsynchronousProcessor<K,V,R,Map<K,R>>

An EntryProcessor wrapper class that allows for an asynchronous invocation of the underlying processor. When used as a Future (without extending), this implementation will collect the results of asynchronous invocation into a Map, providing the result semantics identical to the EntryProcessor.processAll contract.

More advanced use would require extending this class and overriding onResult(java.util.Map.Entry<K, R>), onComplete(), and onException(java.lang.Throwable) methods.

It is very important that the overriding implementations of these methods must be non-blocking. For example, any use of NamedCache API is completely disallowed, with the only exception of asynchronous agents.

The underlying entry processor is guaranteed to have been fully executed when onComplete() is called.

Note 1: Neither this class nor its extensions need to be serializable. Only the underlying processor is serialized and sent to corresponding servers for execution.
Note 2: This feature is not available on Coherence*Extend clients.

Author:

gg/mf 2012.12.21

See Also:

SingleEntryAsynchronousProcessor, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Throwable	m_eReason	Reason for the failed operation.
protected List<Map.Entry<K,R>>	m_listResultEntries	List of result value entries.

Fields inherited from class com.tangosol.util.processor.AbstractAsynchronousProcessor

f_processor

Fields inherited from class com.tangosol.util.AsynchronousAgent

m_control, m_iOrderId

Constructor Summary

Constructors

Constructor	Description
AsynchronousProcessor(InvocableMap.EntryProcessor<K,V,R> processor)	Construct an AsynchronousProcessor for a given processor.
AsynchronousProcessor(InvocableMap.EntryProcessor<K,V,R> processor, int iUnitOrderId)	Construct an AsynchronousProcessor for a given processor.
AsynchronousProcessor(InvocableMap.EntryProcessor<K,V,R> processor, int iUnitOrderId, Executor executor)	Construct an AsynchronousProcessor for a given processor.
AsynchronousProcessor(InvocableMap.EntryProcessor<K,V,R> processor, Executor executor)	Construct an AsynchronousProcessor for a given processor.

Method Summary

Modifier and Type	Method	Description
void	onComplete()	Called after the processor has been notified about all possible partial results or failures and no more are forthcoming.
void	onException(Throwable eReason)	Called if any part of the operation failed for any reason.
void	onResult(Map.Entry<K,R> entry)	Called when there is a partial result of the asynchronous execution.

Methods inherited from class com.tangosol.util.processor.AbstractAsynchronousProcessor

getProcessor, getUnitOfOrderId, process, processAll

Methods inherited from class com.tangosol.util.AsynchronousAgent

bind, cancel, checkBacklog, complete, completeExceptionally, drainBacklog, flush, get, get, getCompletableFuture, getException, getResult, isCancelled, isCompletedExceptionally, isDone

Methods inherited from class java.lang.Object

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

Field Detail

m_eReason

protected volatile Throwable m_eReason

Reason for the failed operation.

m_listResultEntries

protected List<Map.Entry<K,R>> m_listResultEntries

List of result value entries. The reason we keep the result entries as a List rather than a Set or a Map is to skip unnecessary "equals" checks and defer potentially unneeded deserialization.

Constructor Detail

AsynchronousProcessor

public AsynchronousProcessor(InvocableMap.EntryProcessor<K,V,R> processor)

Construct an AsynchronousProcessor for a given processor.

Parameters:

processor - the underlying InvocableMap.EntryProcessor

AsynchronousProcessor

public AsynchronousProcessor(InvocableMap.EntryProcessor<K,V,R> processor,
                             Executor executor)

Construct an AsynchronousProcessor for a given processor.

Parameters:

processor - the underlying InvocableMap.EntryProcessor

executor - an optional Executor to complete the future on, if not provided the Daemons.commonPool() is used

AsynchronousProcessor

public AsynchronousProcessor(InvocableMap.EntryProcessor<K,V,R> processor,
                             int iUnitOrderId)

Construct an AsynchronousProcessor for a given processor.

Parameters:

processor - the underlying InvocableMap.EntryProcessor

iUnitOrderId - the unit-of-order id for this processor

AsynchronousProcessor

public AsynchronousProcessor(InvocableMap.EntryProcessor<K,V,R> processor,
                             int iUnitOrderId,
                             Executor executor)

Construct an AsynchronousProcessor for a given processor.

Parameters:

processor - the underlying InvocableMap.EntryProcessor

iUnitOrderId - the unit-of-order id for this processor

executor - an optional Executor to complete the future on, if not provided the Daemons.commonPool() is used

Method Detail

onResult

public void onResult(Map.Entry<K,R> entry)

Description copied from class: AbstractAsynchronousProcessor

Called when there is a partial result of the asynchronous execution.

For a given request, calls to this method and AbstractAsynchronousProcessor.onException(java.lang.Throwable) may come concurrently.

For ordering guarantees across different processor invocations see AbstractAsynchronousProcessor.getUnitOfOrderId().

Note: Overriding implementations of this method must be non-blocking.

Specified by:

onResult in class AbstractAsynchronousProcessor<K,V,R,Map<K,R>>

Parameters:

entry - an entry holding the key and a result of the operation for the given key

onException

public void onException(Throwable eReason)

Description copied from class: AbstractAsynchronousProcessor

Called if any part of the operation failed for any reason. For operations that span multiple partitions this method could be called more than once. However, unless subclasses override this method, any failure will "complete" the operation.

Note: Overriding implementations of this method must be non-blocking.

Specified by:

onException in class AbstractAsynchronousProcessor<K,V,R,Map<K,R>>

Parameters:

eReason - the reason of failure

onComplete

public void onComplete()

Description copied from class: AbstractAsynchronousProcessor

Called after the processor has been notified about all possible partial results or failures and no more are forthcoming. As long as this processor was submitted to any of InvocableMap's methods, this method is guaranteed to be called once and only once.

Possible call back sequences are:

  cache.invoke
    ...
    onResult
    onComplete

  cache.invoke
    ...
    onException
    onComplete

  cache.invokeAll
    ...
     onResult
     onException
     onException
     onResult
     onComplete
 

For ordering guarantees across processors see AbstractAsynchronousProcessor.getUnitOfOrderId().

Note: Overriding implementations of this method must be non-blocking.

Specified by:

onComplete in class AbstractAsynchronousProcessor<K,V,R,Map<K,R>>