Module io.helidon.common.concurrency.limits

Package io.helidon.common.concurrency.limits

Interface LimitAlgorithm.Outcome

All Known Subinterfaces:

LimitAlgorithm.Outcome.Accepted, LimitAlgorithm.Outcome.Deferred

Enclosing interface:

LimitAlgorithm

public static interface LimitAlgorithm.Outcome

Represents the outcome of a limit algorithm decision.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LimitAlgorithm.Outcome.Accepted	Behavior of an LimitAlgorithm.Outcome representing an accepted work item.
static interface	LimitAlgorithm.Outcome.Deferred	Behavior of an LimitAlgorithm.Outcome representing a deferred decision.
static enum	LimitAlgorithm.Outcome.Disposition	Disposition of the work item.
static enum	LimitAlgorithm.Outcome.Timing	When the algorithm made its decision relative to the moment when it was asked about a particular work item.

Method Summary

Modifier and Type	Method	Description
String	algorithmType()	Name of the limit algorithm which decided whether to allow or prevent processing of the work item.
static LimitAlgorithm.Outcome	deferredAcceptance(String originName, String algorithmType, LimitAlgorithm.Token token, long waitStartNanos, long waitEndNanos)	Creates a new LimitAlgorithm.Outcome representing a deferred acceptance of a work item.
static LimitAlgorithm.Outcome	deferredRejection(String originName, String algorithmType, long waitStartNanos, long waitEndNanos)	Creates a new LimitAlgorithm.Outcome representing a deferred rejection of a work item.
LimitAlgorithm.Outcome.Disposition	disposition()	The LimitAlgorithm.Outcome.Disposition of the work item.
static LimitAlgorithm.Outcome	immediateAcceptance(String originName, String algorithmType, LimitAlgorithm.Token token)	Creates a new LimitAlgorithm.Outcome representing an immediate acceptance of a work item.
static LimitAlgorithm.Outcome	immediateRejection(String originName, String algorithmType)	Creates a new LimitAlgorithm.Outcome representing an immediate rejection of a work item.
String	originName()	Origin (e.g., socket name) of the work item.
LimitAlgorithm.Outcome.Timing	timing()	The LimitAlgorithm.Outcome.Timing of the decision about the work item.

Method Details

immediateAcceptance

static LimitAlgorithm.Outcome immediateAcceptance(String originName,
 String algorithmType,
 LimitAlgorithm.Token token)

Creates a new LimitAlgorithm.Outcome representing an immediate acceptance of a work item.

Parameters:

originName - origin name

algorithmType - algorithm type

token - LimitAlgorithm.Token

Returns:

immediate acceptance outcome

deferredAcceptance

static LimitAlgorithm.Outcome deferredAcceptance(String originName,
 String algorithmType,
 LimitAlgorithm.Token token,
 long waitStartNanos,
 long waitEndNanos)

Creates a new LimitAlgorithm.Outcome representing a deferred acceptance of a work item.

Parameters:

originName - origin name

algorithmType - algorithm type

token - LimitAlgorithm.Token

waitStartNanos - start time of the wait for the decision

waitEndNanos - end time of the wait for the decision

Returns:

deferred acceptance outcome

immediateRejection

static LimitAlgorithm.Outcome immediateRejection(String originName,
 String algorithmType)

Creates a new LimitAlgorithm.Outcome representing an immediate rejection of a work item. }

Parameters:

originName - origin name

algorithmType - algorithm type

Returns:

immediate rejection outcome

deferredRejection

static LimitAlgorithm.Outcome deferredRejection(String originName,
 String algorithmType,
 long waitStartNanos,
 long waitEndNanos)

Creates a new LimitAlgorithm.Outcome representing a deferred rejection of a work item.

Parameters:

originName - origin name

algorithmType - algorithm type

waitStartNanos - start time of the wait for the decision

waitEndNanos - end time of the wait for the decision

Returns:

deferred rejection outcome

originName

String originName()

Origin (e.g., socket name) of the work item.

Returns:

origin

algorithmType

String algorithmType()

Name of the limit algorithm which decided whether to allow or prevent processing of the work item.

Returns:

algorithm name

disposition

LimitAlgorithm.Outcome.Disposition disposition()

The LimitAlgorithm.Outcome.Disposition of the work item.

Returns:

disposition

timing

LimitAlgorithm.Outcome.Timing timing()

The LimitAlgorithm.Outcome.Timing of the decision about the work item.

Returns:

timing of the decision