• Home
• io.smallrye.common
• smallrye-common-annotation
• 2.9.0
• source code
• Blocking.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.smallrye.common.annotation.Blocking Maven / Gradle / Ivy

package io.smallrye.common.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation used to indicate that the annotated method is inherently blocking and so should not be
 * executed on a non-blockable thread (I/O thread, event loops...).
 * 

 * Frameworks can add support for this annotation and offload the work to another thread if the current thread cannot
 * be blocked. It's particularly useful for frameworks using a reactive execution model. Framework relying on this
 * annotation must specify the exact behavior:
 * 

 * 
what thread is considered non-blockable;
 * 
on which thread is the execution offloaded;
 * 
whether, when the current thread can block, the execution of the annotated method is still offloaded to
 * another thread, or stays on the same thread;
 * 
if the execution of the method is offloaded, whether the initial thread is restored after the method
 * execution.
 * 
 * 

 * When this annotation is used on a {@code class}, all the methods declared by the annotated class are considered
 * blocking.
 * 

 * This annotation is not inheritable, so the user must repeat the annotation when sub-classing the class
 * or overriding the method.
 *
 * @see NonBlocking
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.TYPE })
public @interface Blocking {

    // Just a marker annotation.
}