com.gh.bmd.jrt.annotation.Timeout Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jroutine Show documentation
Parallel programming on the go
There is a newer version: 5.9.0
/**
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.gh.bmd.jrt.annotation;

import com.gh.bmd.jrt.builder.RoutineConfiguration.TimeoutAction;

import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.concurrent.TimeUnit;

/**
 * This annotation is used to customize 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 avoid unexpected behavior, it is advisable to avoid using the same class fields
 * (unless immutable) in protected and non-protected code, or to call synchronous methods through
 * the framework as well.

 * Through this annotation it is possible to indicate the timeout for a readable result to become
 * available, and the action to be taken when it elapses.
 * 

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

 * When used to annotate a class instead of a method, its attributes are applied to all the class
 * methods unless specific values are set in the method annotation.
 * 

 * 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.gh.bmd.jrt.annotation.Timeout *;
 *         }
 *     
 * 
 * 
 * Created by davide on 9/21/14.
 */
@Inherited
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Timeout {

    /**
     * The type of action to take on output channel timeout.
     *
     * @return the action type.
     */
    TimeoutAction action() default TimeoutAction.DEADLOCK;

    /**
     * The time unit of the timeout for an invocation instance to produce a result.
     *
     * @return the time unit.
     */
    TimeUnit unit() default TimeUnit.MILLISECONDS;

    /**
     * The timeout for an invocation instance to produce a result.
     *
     * @return the timeout.
     */
    long value();
}