com.blacklocus.qs

Interface QueueItemHandler<Q,T,R>

All Known Subinterfaces:

MessageHandler<T,R>

All Known Implementing Classes:

AbstractMessageHandler, AbstractQueueItemHandler

public interface QueueItemHandler<Q,T,R>

More generalized form of MessageHandler

Method Summary

Modifier and Type	Method and Description
T	convert(Q queueItem) Convert the given queue item on the queue item processing thread.
void	onComplete(Q queueItem, T convertedQueueItem, R result) Called whether the processing results in success or failure on the queue item processing thread.
void	onError(Q queueItem, T convertedQueueItem, java.lang.Throwable throwable) Called when an Exception occurs while processing the given queue item on the queue item processing thread.
void	onSuccess(Q queueItem, T convertedQueueItem, R result) Called when processing completes successfully on the queue item processing thread.
R	process(T convertedQueueItem) Return the result of processing a queue item of the given converted type on the queue item processing thread.
void	withFuture(Q queueItem, java.util.concurrent.Future<org.apache.commons.lang3.tuple.Pair<Q,R>> future) Called after the queue item is retrieved off of the queue and handed off to an Executor for processing.

Method Detail

convert

T convert(Q queueItem)
   throws java.lang.Exception

Convert the given queue item on the queue item processing thread.

Parameters:

queueItem - a queue item to convert

Throws:

java.lang.Exception

process

R process(T convertedQueueItem)
   throws java.lang.Exception

Return the result of processing a queue item of the given converted type on the queue item processing thread.

Parameters:

convertedQueueItem - the converted target queue item

Throws:

java.lang.Exception

onSuccess

void onSuccess(Q queueItem,
               T convertedQueueItem,
               R result)

Called when processing completes successfully on the queue item processing thread.

Parameters:

queueItem - the original queue item that was successfully processed

convertedQueueItem - the converted target queue item

result - the result returned from successful queue item handling

onError

void onError(Q queueItem,
             T convertedQueueItem,
             java.lang.Throwable throwable)

Called when an Exception occurs while processing the given queue item on the queue item processing thread.

Parameters:

queueItem - the queue item received

convertedQueueItem - the converted target queue item, may be null if convert failed

throwable - the error that occurred while trying to process the queue item

onComplete

void onComplete(Q queueItem,
                T convertedQueueItem,
                R result)

Called whether the processing results in success or failure on the queue item processing thread.

Parameters:

queueItem - the original queue item being handled

convertedQueueItem - the converted target queue item, may be null if convert failed

result - the result returned from successful queue item handling or null if it failed

withFuture

void withFuture(Q queueItem,
                java.util.concurrent.Future<org.apache.commons.lang3.tuple.Pair<Q,R>> future)

Called after the queue item is retrieved off of the queue and handed off to an Executor for processing. This method will be called on the queue reading thread so if it blocks then it will block all subsequent queue reading. Thus, use caution when your implementation of process() might block for a while.

Parameters:

queueItem - the queue item to be processed

future - the Future created after submitting the handling task to the executor