io.vertx.rxjava3.core

Class WorkerExecutor

java.lang.Object

io.vertx.rxjava3.core.WorkerExecutor

All Implemented Interfaces:

Measured

public class WorkerExecutor
extends Object
implements 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.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field and Description
static io.vertx.lang.rx.TypeArg<WorkerExecutor>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
WorkerExecutor(Object delegate)
WorkerExecutor(WorkerExecutor delegate)

Method Summary

Modifier and Type	Method and Description
Completable	close() Close the executor.
boolean	equals(Object o)
<T> Maybe<T>	executeBlocking(Callable<T> blockingCodeHandler) Like executeBlocking(io.vertx.core.Handler<io.vertx.rxjava3.core.Promise<T>>, boolean) but using a callback.
<T> Maybe<T>	executeBlocking(Callable<T> blockingCodeHandler, boolean ordered) Like executeBlocking(io.vertx.core.Handler<io.vertx.rxjava3.core.Promise<T>>, boolean) but using a callback.
<T> Maybe<T>	executeBlocking(Handler<Promise<T>> blockingCodeHandler) Deprecated.
<T> Maybe<T>	executeBlocking(Handler<Promise<T>> blockingCodeHandler, boolean ordered) Deprecated.
WorkerExecutor	getDelegate()
int	hashCode()
boolean	isMetricsEnabled() Whether the metrics are enabled for this measured object
static WorkerExecutor	newInstance(WorkerExecutor arg)
Completable	rxClose() Close the executor.
<T> Maybe<T>	rxExecuteBlocking(Callable<T> blockingCodeHandler) Like executeBlocking(io.vertx.core.Handler<io.vertx.rxjava3.core.Promise<T>>, boolean) but using a callback.
<T> Maybe<T>	rxExecuteBlocking(Callable<T> blockingCodeHandler, boolean ordered) Like executeBlocking(io.vertx.core.Handler<io.vertx.rxjava3.core.Promise<T>>, boolean) but using a callback.
<T> Maybe<T>	rxExecuteBlocking(Handler<Promise<T>> blockingCodeHandler) Deprecated.
<T> Maybe<T>	rxExecuteBlocking(Handler<Promise<T>> blockingCodeHandler, boolean ordered) Deprecated.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.vertx.rxjava3.core.metrics.Measured

newInstance

Field Detail

__TYPE_ARG

public static final io.vertx.lang.rx.TypeArg<WorkerExecutor> __TYPE_ARG

Constructor Detail

WorkerExecutor

public WorkerExecutor(WorkerExecutor delegate)

WorkerExecutor

public WorkerExecutor(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public WorkerExecutor getDelegate()

Specified by:

getDelegate in interface Measured

isMetricsEnabled

public boolean isMetricsEnabled()

Whether the metrics are enabled for this measured object

Specified by:

isMetricsEnabled in interface Measured

Returns:

true if metrics are enabled

executeBlocking

@Deprecated
public <T> Maybe<T> executeBlocking(Handler<Promise<T>> blockingCodeHandler,
                                                boolean ordered)

Deprecated.

Safely execute some blocking code.

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

The returned future will be completed with the result on the original context (i.e. on the original event loop of the caller) or failed when the handler throws an exception.

A Future instance is passed into blockingCodeHandler. When the blocking code successfully completes, the handler should call the Promise.complete(T) or Promise.complete(T) 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 this context and not on the worker thread.

Parameters:

blockingCodeHandler - handler representing the blocking code to run

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

Returns:

rxExecuteBlocking

@Deprecated
public <T> Maybe<T> rxExecuteBlocking(Handler<Promise<T>> blockingCodeHandler,
                                                  boolean ordered)

Deprecated.

Safely execute some blocking code.

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

The returned future will be completed with the result on the original context (i.e. on the original event loop of the caller) or failed when the handler throws an exception.

A Future instance is passed into blockingCodeHandler. When the blocking code successfully completes, the handler should call the Promise.complete(T) or Promise.complete(T) 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 this context and not on the worker thread.

Parameters:

blockingCodeHandler - handler representing the blocking code to run

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

Returns:

executeBlocking

@Deprecated
public <T> Maybe<T> executeBlocking(Handler<Promise<T>> blockingCodeHandler)

Deprecated.

Like executeBlocking(io.vertx.core.Handler<io.vertx.rxjava3.core.Promise<T>>, boolean) called with ordered = true.

Parameters:

blockingCodeHandler -

Returns:

rxExecuteBlocking

@Deprecated
public <T> Maybe<T> rxExecuteBlocking(Handler<Promise<T>> blockingCodeHandler)

Deprecated.

Like executeBlocking(io.vertx.core.Handler<io.vertx.rxjava3.core.Promise<T>>, boolean) called with ordered = true.

Parameters:

blockingCodeHandler -

Returns:

close

public Completable close()

Close the executor.

Returns:

rxClose

public Completable rxClose()

Close the executor.

Returns:

executeBlocking

public <T> Maybe<T> executeBlocking(Callable<T> blockingCodeHandler)

Like executeBlocking(io.vertx.core.Handler<io.vertx.rxjava3.core.Promise<T>>, boolean) but using a callback.

Parameters:

blockingCodeHandler -

Returns:

rxExecuteBlocking

public <T> Maybe<T> rxExecuteBlocking(Callable<T> blockingCodeHandler)

Like executeBlocking(io.vertx.core.Handler<io.vertx.rxjava3.core.Promise<T>>, boolean) but using a callback.

Parameters:

blockingCodeHandler -

Returns:

executeBlocking

public <T> Maybe<T> executeBlocking(Callable<T> blockingCodeHandler,
                                    boolean ordered)

Like executeBlocking(io.vertx.core.Handler<io.vertx.rxjava3.core.Promise<T>>, boolean) but using a callback.

Parameters:

blockingCodeHandler -

ordered -

Returns:

rxExecuteBlocking

public <T> Maybe<T> rxExecuteBlocking(Callable<T> blockingCodeHandler,
                                      boolean ordered)

Like executeBlocking(io.vertx.core.Handler<io.vertx.rxjava3.core.Promise<T>>, boolean) but using a callback.

Parameters:

blockingCodeHandler -

ordered -

Returns:

newInstance

public static WorkerExecutor newInstance(WorkerExecutor arg)