InvocationConfiguration (Javadoc

java.lang.Object
- com.github.dm.jrt.builder.InvocationConfiguration

```
public final class InvocationConfiguration
extends Object
```
Class storing the invocation configuration.
Each instance is immutable, thus, in order to modify a configuration parameter, a new builder must be created starting from the specific configuration.
The configuration has an asynchronous runner associated.
The default runner is shared among all the routines, but a custom one can be set through the builder.
A specific priority can be set. Every invocation will age each time an higher priority one takes the precedence, so that older invocations slowly increases their priority. Such mechanism has been implemented to avoid starvation of low priority invocations. Hence, when assigning priority values, it is important to keep in mind that the difference between two priorities corresponds to the maximum age the lower priority invocation will have, before getting precedence over the higher priority one.
Additionally, a recycling mechanism is provided so that, when an invocation successfully completes, the instance is retained for future executions. Moreover, the maximum running invocation instances at one time can be limited by calling the specific builder method. When the limit is reached and an additional instance is required, the call is delayed until one becomes available.
Finally, the number of input and output data buffered in the corresponding channel can be limited in order to avoid excessive memory consumption. In case the maximum number is reached when passing an input or output, the call blocks until enough data are consumed or the specified timeout elapses. In the latter case, a TimeoutException will be thrown.
By default the timeout is set to 0 to avoid unexpected deadlocks.
The order of input and output data is not guaranteed. Nevertheless, it is possible to force data to be delivered in the same order as they are passed to the channels, at the cost of a slightly increase in memory usage and computation.
Created by davide-maestroni on 11/15/2014.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InvocationConfiguration.AgingPriority` Interface exposing constants which can be used as a common set of priorities. Note that, since the priority value can be any in an integer range, it is always possible to customize the values so to create a personalized set.
`static class`	`InvocationConfiguration.Builder<TYPE>` Builder of invocation configurations.
`static interface`	`InvocationConfiguration.Configurable<TYPE>` Interface defining a configurable object.
`static interface`	`InvocationConfiguration.NotAgingPriority` Interface exposing constants which can be used as a set of priorities ignoring the aging of executions. Note that, since the priority value can be any in an integer range, it is always possible to customize the values so to create a personalized set.
`static class`	`InvocationConfiguration.OrderType` Enumeration defining how data are ordered inside a channel.
`static class`	`InvocationConfiguration.TimeoutActionType` Enumeration indicating the type of action to be taken on output channel timeout.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT` Constant indicating the default value of an integer attribute.
`static InvocationConfiguration`	`DEFAULT_CONFIGURATION` Empty configuration constant. The configuration has all the options set to their default.

Method Summary

Methods
Modifier and Type	Method and Description
`static InvocationConfiguration.Builder<InvocationConfiguration>`	`builder()` Returns an invocation configuration builder.
`InvocationConfiguration.Builder<InvocationConfiguration>`	`builderFrom()` Returns an invocation configuration builder initialized with this configuration.
`static InvocationConfiguration.Builder<InvocationConfiguration>`	`builderFrom(InvocationConfiguration initialConfiguration)` Returns an invocation configuration builder initialized with the specified configuration.
`boolean`	`equals(Object o)`
`int`	`getCoreInstancesOr(int valueIfNotSet)` Returns the maximum number of retained invocation instances (DEFAULT by default).
`int`	`getInputMaxSizeOr(int valueIfNotSet)` Returns the maximum number of buffered input data (DEFAULT by default).
`InvocationConfiguration.OrderType`	`getInputOrderTypeOr(InvocationConfiguration.OrderType valueIfNotSet)` Returns the input data order (null by default).
`TimeDuration`	`getInputTimeoutOr(TimeDuration valueIfNotSet)` Returns the maximum timeout while waiting for an input to be passed to the input channel (null by default).
`Log.Level`	`getLogLevelOr(Log.Level valueIfNotSet)` Returns the log level (null by default).
`Log`	`getLogOr(Log valueIfNotSet)` Returns the log instance (null by default).
`int`	`getMaxInstancesOr(int valueIfNotSet)` Returns the maximum number of parallel running invocation instances (DEFAULT by default).
`int`	`getOutputMaxSizeOr(int valueIfNotSet)` Returns the maximum number of buffered output data (DEFAULT by default).
`InvocationConfiguration.OrderType`	`getOutputOrderTypeOr(InvocationConfiguration.OrderType valueIfNotSet)` Returns the output data order (null by default).
`TimeDuration`	`getOutputTimeoutOr(TimeDuration valueIfNotSet)` Returns the maximum timeout while waiting for an output to be passed to the result channel (null by default).
`int`	`getPriorityOr(int valueIfNotSet)` Returns the invocation priority (DEFAULT by default).
`InvocationConfiguration.TimeoutActionType`	`getReadTimeoutActionOr(InvocationConfiguration.TimeoutActionType valueIfNotSet)` Returns the action to be taken if the timeout elapses before a readable result is available (null by default).
`TimeDuration`	`getReadTimeoutOr(TimeDuration valueIfNotSet)` Returns the timeout for an invocation instance to produce a readable result (null by default).
`Runner`	`getRunnerOr(Runner valueIfNotSet)` Returns the runner used for asynchronous invocations (null by default).
`int`	`hashCode()`
`Logger`	`newLogger(Object context)` Creates a new logger.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT
```
public static final int DEFAULT
```
    Constant indicating the default value of an integer attribute.
    
    See Also:
    Constant Field Values
  - DEFAULT_CONFIGURATION
```
public static final InvocationConfiguration DEFAULT_CONFIGURATION
```
    Empty configuration constant.
    The configuration has all the options set to their default.
- Method Detail
  - builder
```
@NotNull
public static InvocationConfiguration.Builder<InvocationConfiguration> builder()
```
    Returns an invocation configuration builder.
    
    Returns:
    the builder.
  - builderFrom
```
@NotNull
public static InvocationConfiguration.Builder<InvocationConfiguration> builderFrom(@Nullable
                                                                           InvocationConfiguration initialConfiguration)
```
    Returns an invocation configuration builder initialized with the specified configuration.
    
    Parameters:
    initialConfiguration - the initial configuration.
    
    Returns:
    the builder.
  - builderFrom
```
@NotNull
public InvocationConfiguration.Builder<InvocationConfiguration> builderFrom()
```
    Returns an invocation configuration builder initialized with this configuration.
    
    Returns:
    the builder.
  - getCoreInstancesOr
```
public int getCoreInstancesOr(int valueIfNotSet)
```
    Returns the maximum number of retained invocation instances (DEFAULT by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the maximum number.
  - getInputMaxSizeOr
```
public int getInputMaxSizeOr(int valueIfNotSet)
```
    Returns the maximum number of buffered input data (DEFAULT by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the maximum size.
  - getInputOrderTypeOr
```
public InvocationConfiguration.OrderType getInputOrderTypeOr(@Nullable
                                                    InvocationConfiguration.OrderType valueIfNotSet)
```
    Returns the input data order (null by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the order type.
  - getInputTimeoutOr
```
public TimeDuration getInputTimeoutOr(@Nullable
                             TimeDuration valueIfNotSet)
```
    Returns the maximum timeout while waiting for an input to be passed to the input channel (null by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the timeout.
  - getLogLevelOr
```
public Log.Level getLogLevelOr(@Nullable
                      Log.Level valueIfNotSet)
```
    Returns the log level (null by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the log level.
  - getLogOr
```
public Log getLogOr(@Nullable
           Log valueIfNotSet)
```
    Returns the log instance (null by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the log instance.
  - getMaxInstancesOr
```
public int getMaxInstancesOr(int valueIfNotSet)
```
    Returns the maximum number of parallel running invocation instances (DEFAULT by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the maximum number.
  - getOutputMaxSizeOr
```
public int getOutputMaxSizeOr(int valueIfNotSet)
```
    Returns the maximum number of buffered output data (DEFAULT by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the maximum size.
  - getOutputOrderTypeOr
```
public InvocationConfiguration.OrderType getOutputOrderTypeOr(@Nullable
                                                     InvocationConfiguration.OrderType valueIfNotSet)
```
    Returns the output data order (null by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the order type.
  - getOutputTimeoutOr
```
public TimeDuration getOutputTimeoutOr(@Nullable
                              TimeDuration valueIfNotSet)
```
    Returns the maximum timeout while waiting for an output to be passed to the result channel (null by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the timeout.
  - getPriorityOr
```
public int getPriorityOr(int valueIfNotSet)
```
    Returns the invocation priority (DEFAULT by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the priority.
  - getReadTimeoutActionOr
```
public InvocationConfiguration.TimeoutActionType getReadTimeoutActionOr(@Nullable
                                                               InvocationConfiguration.TimeoutActionType valueIfNotSet)
```
    Returns the action to be taken if the timeout elapses before a readable result is available (null by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the action type.
  - getReadTimeoutOr
```
public TimeDuration getReadTimeoutOr(@Nullable
                            TimeDuration valueIfNotSet)
```
    Returns the timeout for an invocation instance to produce a readable result (null by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the timeout.
  - getRunnerOr
```
public Runner getRunnerOr(@Nullable
                 Runner valueIfNotSet)
```
    Returns the runner used for asynchronous invocations (null by default).
    
    Parameters:
    valueIfNotSet - the default value if none was set.
    
    Returns:
    the runner instance.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - newLogger
```
@NotNull
public Logger newLogger(@NotNull
                       Object context)
```
    Creates a new logger.
    
    Parameters:
    context - the context.
    
    Returns:
    the new logger.

Class InvocationConfiguration

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT

DEFAULT_CONFIGURATION

Method Detail

builder

builderFrom

builderFrom

getCoreInstancesOr

getInputMaxSizeOr

getInputOrderTypeOr

getInputTimeoutOr

getLogLevelOr

getLogOr

getMaxInstancesOr

getOutputMaxSizeOr

getOutputOrderTypeOr

getOutputTimeoutOr

getPriorityOr

getReadTimeoutActionOr

getReadTimeoutOr

getRunnerOr

hashCode

equals

toString

newLogger