io.jooby

Enum ExecutionMode

java.lang.Object

java.lang.Enum<ExecutionMode>

io.jooby.ExecutionMode

All Implemented Interfaces:

Serializable, Comparable<ExecutionMode>

public enum ExecutionMode
extends Enum<ExecutionMode>

Execution mode.

Author:

edgar

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Default execution mode.
EVENT_LOOP Execute route handler in the event loop thread (non-blocking).
WORKER Execute handler in a worker/io thread (blocking).

Method Summary

Modifier and Type	Method and Description
static ExecutionMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExecutionMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EVENT_LOOP

public static final ExecutionMode EVENT_LOOP

Execute route handler in the event loop thread (non-blocking). Handler must never block. Examples:

 {
   mode(EVENT_LOOP);

   get("/non-blocking", ctx -> "I'm running on event-loop thread (no blocking allowed)");

   // Dispatch to worker thread, blocking routes
   dispatch(() -> {

     get("/blocking", ctx -> {
       // remote call: service, database, etc..
       return "Safe to block";
     });
   });
 }
 

WORKER

public static final ExecutionMode WORKER

Execute handler in a worker/io thread (blocking). Handler is allowed to block. Examples:

 {

   mode(WORKER);

   get("/worker", ctx -> {
     // remote call: another service, database, etc..
     return "Safe to block";
   });
 }

 

DEFAULT

public static final ExecutionMode DEFAULT

Default execution mode. Automatically choose between EVENT_LOOP and WORKER. If route handler returns a `reactive` type, then Jooby run the route handler in the event-loop thread. Otherwise, run the handler in the worker thread. A reactive type is one of: - CompletableFuture. - A reactive stream Publisher - Rx types: Observable, Flowable, Single, Maybe, etc.. - Reactor types: Flux and Mono. Examples:

 {

   get("/non-blocking", ctx -> {
     return CompletableFuture.supplyAsync(() -> {
       return "I'm non-blocking";
     });
   });

   get("/blocking", ctx -> {
     return "I'm blocking";
   });
 }
 

Method Detail

values

public static ExecutionMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ExecutionMode c : ExecutionMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExecutionMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null