net.uncontended.precipice.pattern

Class Shotgun<C>

java.lang.Object

net.uncontended.precipice.pattern.Shotgun<C>

All Implemented Interfaces:

CompletionPattern<C>, Pattern, SubmissionPattern<C>

public class Shotgun<C>
extends java.lang.Object
implements SubmissionPattern<C>, CompletionPattern<C>

Constructor Summary

Constructors

Constructor and Description
Shotgun(java.util.Map<CompletionService,C> executorToContext, int submissionCount)
Shotgun(java.util.Map<CompletionService,C> executorToContext, int submissionCount, ShotgunStrategy strategy)

Method Summary

Modifier and Type	Method and Description
void	shutdown() Attempts to shutdown all the services.
<T> ResilientFuture<T>	submit(ResilientPatternAction<T,C> action, long millisTimeout) Submits a ResilientPatternAction that will be run asynchronously.
<T> ResilientFuture<T>	submit(ResilientPatternAction<T,C> action, ResilientCallback<T> callback, long millisTimeout) Submits a ResilientPatternAction that will be run asynchronously similar to SubmissionPattern.submit(ResilientPatternAction, long).
<T> void	submitAndComplete(ResilientPatternAction<T,C> action, ResilientPromise<T> promise, long millisTimeout) Submits a ResilientPatternAction that will be run asynchronously.
<T> void	submitAndComplete(ResilientPatternAction<T,C> action, ResilientPromise<T> promise, ResilientCallback<T> callback, long millisTimeout) Submits a ResilientPatternAction that will be run asynchronously.

Methods inherited from class java.lang.Object

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

Constructor Detail

Shotgun

public Shotgun(java.util.Map<CompletionService,C> executorToContext,
               int submissionCount)

Shotgun

public Shotgun(java.util.Map<CompletionService,C> executorToContext,
               int submissionCount,
               ShotgunStrategy strategy)

Method Detail

submit

public <T> ResilientFuture<T> submit(ResilientPatternAction<T,C> action,
                                     long millisTimeout)

Description copied from interface: SubmissionPattern

Submits a ResilientPatternAction that will be run asynchronously. The result of the action will be delivered to the future returned by this call. An attempt to cancel the action will be made if it does not complete before the timeout.

Specified by:

submit in interface SubmissionPattern<C>

Type Parameters:

T - the type of the result of the action

Parameters:

action - the action to submit

millisTimeout - milliseconds before the action times out

Returns:

a ResilientFuture representing pending completion of the action

submit

public <T> ResilientFuture<T> submit(ResilientPatternAction<T,C> action,
                                     ResilientCallback<T> callback,
                                     long millisTimeout)

Description copied from interface: SubmissionPattern

Submits a ResilientPatternAction that will be run asynchronously similar to SubmissionPattern.submit(ResilientPatternAction, long). However, at the completion of the task, the provided callback will be executed. The callback will be run regardless of the result of the action.

Specified by:

submit in interface SubmissionPattern<C>

Type Parameters:

T - the type of the result of the action

Parameters:

action - the action to submit

callback - to run on action completion

millisTimeout - milliseconds before the action times out

Returns:

a ResilientFuture representing pending completion of the action

submitAndComplete

public <T> void submitAndComplete(ResilientPatternAction<T,C> action,
                                  ResilientPromise<T> promise,
                                  long millisTimeout)

Description copied from interface: CompletionPattern

Submits a ResilientPatternAction that will be run asynchronously. At the completion of the task, the result will be delivered to the promise provided.

Specified by:

submitAndComplete in interface CompletionPattern<C>

Type Parameters:

T - the type of the result of the action

Parameters:

action - the action to submit

promise - a promise to which deliver the result

millisTimeout - milliseconds before the action times out

submitAndComplete

public <T> void submitAndComplete(ResilientPatternAction<T,C> action,
                                  ResilientPromise<T> promise,
                                  ResilientCallback<T> callback,
                                  long millisTimeout)

Description copied from interface: CompletionPattern

Submits a ResilientPatternAction that will be run asynchronously. At the completion of the task, the result will be delivered to the promise provided. And the provided callback will be executed.

Specified by:

submitAndComplete in interface CompletionPattern<C>

Type Parameters:

T - the type of the result of the action

Parameters:

action - the action to submit

promise - a promise to which deliver the result

callback - to run on action completion

millisTimeout - milliseconds before the action times out

shutdown

public void shutdown()

Description copied from interface: Pattern

Attempts to shutdown all the services. Actions after this call will throw a RejectedActionException. Implementations may differ on if pending or executing actions are cancelled.

Specified by:

shutdown in interface Pattern