com.github.dm.jrt.annotation

Annotation Type InputTimeout

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface InputTimeout

Through this annotation it is possible to indicate the timeout for an input channel to have room for additional data.

This annotation is used to decorate methods that are to be invoked in an asynchronous way.
Note that the piece of code inside such methods will be automatically protected so to avoid concurrency issues. Though, other parts of the code inside the same class will be not.
In order to prevent unexpected behaviors, it is advisable to avoid using the same class fields (unless immutable) in protected and non-protected code, or to call synchronous methods through routines as well.

Finally, be aware that a method might need to be made accessible in order to be called. That means that, in case a SecurityManager is installed, a security exception might be raised based on the specific policy implemented.

Remember also that, in order for the annotation to properly work at run time, you will need to add the following rules to your Proguard file (if employing it for shrinking or obfuscation):

     

         -keepattributes RuntimeVisibleAnnotations
         -keepclassmembers class ** {
              @com.github.dm.jrt.annotation.InputTimeout *;
         }
     
 

Created by davide-maestroni on 10/05/2015.

See Also:

InvocationConfiguration

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
long	value The timeout for an input channel to have room for additional data.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
TimeUnit	unit The time unit of the timeout for an input channel to have room for additional data.

Element Detail

value

public abstract long value

The timeout for an input channel to have room for additional data.

Returns:

the timeout.

unit

public abstract TimeUnit unit

The time unit of the timeout for an input channel to have room for additional data.

Returns:

the time unit.

Default:

java.util.concurrent.TimeUnit.MILLISECONDS