io.vertx.core

## Interface WorkerExecutor

- All Superinterfaces:
    Measured

      public interface WorkerExecutor
      extends Measured

  An executor for executing blocking code in Vert.x .

  It provides the same `executeBlocking` operation than `Context` and `Vertx` but on a separate worker pool.

  Author:
    Julien Viet

- - ### Method Summary

    All Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `Future<Void>` | `close()` Like `close(Handler)` but returns a `Future` of the asynchronous result
    `void` | `close(Handler<AsyncResult<Void>> handler)` Close the executor.
    `default <T> Future<T>` | `executeBlocking(Handler<Promise<T>> blockingCodeHandler)` Like `executeBlocking(Handler, boolean, Handler)` called with ordered = true.
    `<T> Future<T>` | `executeBlocking(Handler<Promise<T>> blockingCodeHandler, boolean ordered)` Same as `executeBlocking(Handler, boolean, Handler)` but with an `handler` called when the operation completes
    `<T> void` | `executeBlocking(Handler<Promise<T>> blockingCodeHandler, boolean ordered, Handler<AsyncResult<T>> resultHandler)` Safely execute some blocking code.
    `default <T> void` | `executeBlocking(Handler<Promise<T>> blockingCodeHandler, Handler<AsyncResult<T>> resultHandler)` Like `executeBlocking(Handler, boolean, Handler)` called with ordered = true.

    - ### Methods inherited from interface io.vertx.core.metrics.Measured

      `isMetricsEnabled`

- - ### Method Detail

    - #### executeBlocking

          <T> void executeBlocking(Handler<Promise<T>> blockingCodeHandler,
                                   boolean ordered,
                                   Handler<AsyncResult<T>> resultHandler)

      Safely execute some blocking code.

      Executes the blocking code in the handler `blockingCodeHandler` using a thread from the worker pool.

      When the code is complete the handler `resultHandler` will be called with the result on the original context (i.e. on the original event loop of the caller).

      A `Future` instance is passed into `blockingCodeHandler`. When the blocking code successfully completes, the handler should call the `Promise.complete(T)` or `Promise.complete(Object)` method, or the `Promise.fail(java.lang.Throwable)` method if it failed.

      In the `blockingCodeHandler` the current context remains the original context and therefore any task scheduled in the `blockingCodeHandler` will be executed on the this context and not on the worker thread.

      Type Parameters:
        `T` - the type of the result
      Parameters:
        `blockingCodeHandler` - handler representing the blocking code to run
        `resultHandler` - handler that will be called when the blocking code is complete
        `ordered` - if true then if executeBlocking is called several times on the same context, the executions for that context will be executed serially, not in parallel. if false then they will be no ordering guarantees

    - #### executeBlocking

          default <T> void executeBlocking(Handler<Promise<T>> blockingCodeHandler,
                                           Handler<AsyncResult<T>> resultHandler)

      Like `executeBlocking(Handler, boolean, Handler)` called with ordered = true.

    - #### executeBlocking

          <T> Future<T> executeBlocking(Handler<Promise<T>> blockingCodeHandler,
                                        boolean ordered)

      Same as `executeBlocking(Handler, boolean, Handler)` but with an `handler` called when the operation completes

    - #### executeBlocking

          default <T> Future<T> executeBlocking(Handler<Promise<T>> blockingCodeHandler)

      Like `executeBlocking(Handler, boolean, Handler)` called with ordered = true.

    - #### close

          void close(Handler<AsyncResult<Void>> handler)

      Close the executor.
      Parameters:
        `handler` - the completion handler

    - #### close

          Future<Void> close()

      Like `close(Handler)` but returns a `Future` of the asynchronous result

Copyright © 2021 Eclipse. All rights reserved.