public class Context extends Object
Handler execution.
When Vert.x provides an event to a handler or calls the start or stop methods of a Verticle,
the execution is associated with a Context.
Usually a context is an *event-loop context* and is tied to a specific event loop thread. So executions for that context always occur on that exact same event loop thread.
In the case of worker verticles and running inline blocking code a worker context will be associated with the execution which will use a thread from the worker thread pool.
When a handler is set by a thread associated with a specific context, the Vert.x will guarantee that when that handler is executed, that execution will be associated with the same context.
If a handler is set by a thread not associated with a context (i.e. a non Vert.x thread). Then a new context will be created for that handler.
In other words, a context is propagated.
This means that when a verticle is deployed, any handlers it sets will be associated with the same context - the context of the verticle.
This means (in the case of a standard verticle) that the verticle code will always be executed with the exact same thread, so you don't have to worry about multi-threaded acccess to the verticle state and you can code your application as single threaded.
This class also allows arbitrary data to be put(java.lang.Object, java.lang.Object) and get(java.lang.Object) on the context so it can be shared easily
amongst different handlers of, for example, a verticle instance.
This class also provides runOnContext(io.vertx.core.Handler<java.lang.Void>) which allows an action to be executed asynchronously using the same context.
original non RX-ified interface using Vert.x codegen.| Modifier and Type | Field and Description |
|---|---|
static io.vertx.lang.rx.TypeArg<Context> |
__TYPE_ARG |
| Constructor and Description |
|---|
Context(Context delegate) |
Context(Object delegate) |
| Modifier and Type | Method and Description |
|---|---|
JsonObject |
config()
If the context is associated with a Verticle deployment, this returns the configuration that was specified when
the verticle was deployed.
|
String |
deploymentID()
If the context is associated with a Verticle deployment, this returns the deployment ID of that deployment.
|
boolean |
equals(Object o) |
Context |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler called when the context runs an action throwing an uncaught throwable.
When this handler is called,
Vertx.currentContext() will return this context. |
<T> void |
executeBlocking(Callable<T> blockingCodeHandler)
|
<T> void |
executeBlocking(Callable<T> blockingCodeHandler,
boolean ordered)
|
<T> void |
executeBlocking(Callable<T> blockingCodeHandler,
boolean ordered,
Handler<AsyncResult<T>> resultHandler)
|
<T> void |
executeBlocking(Callable<T> blockingCodeHandler,
Handler<AsyncResult<T>> resultHandler)
|
<T> void |
executeBlocking(Handler<Promise<T>> blockingCodeHandler)
Deprecated.
|
<T> void |
executeBlocking(Handler<Promise<T>> blockingCodeHandler,
boolean ordered)
Deprecated.
|
<T> void |
executeBlocking(Handler<Promise<T>> blockingCodeHandler,
boolean ordered,
Handler<AsyncResult<T>> resultHandler)
Deprecated.
|
<T> void |
executeBlocking(Handler<Promise<T>> blockingCodeHandler,
Handler<AsyncResult<T>> resultHandler)
Deprecated.
|
<T> T |
get(Object key)
Get some data from the context.
|
Context |
getDelegate() |
int |
getInstanceCount() |
<T> T |
getLocal(Object key)
Get some local data from the context.
|
int |
hashCode() |
boolean |
isEventLoopContext()
Is the current context an event loop context?
|
static boolean |
isOnEventLoopThread()
Is the current thread an event thread?
|
static boolean |
isOnVertxThread()
Is the current thread a Vert.x thread? That's either a worker thread or an event loop thread
|
static boolean |
isOnWorkerThread()
Is the current thread a worker thread?
|
boolean |
isWorkerContext()
Is the current context a worker context?
|
static Context |
newInstance(Context arg) |
Vertx |
owner() |
List<String> |
processArgs()
The process args
|
void |
put(Object key,
Object value)
Put some data in the context.
|
void |
putLocal(Object key,
Object value)
Put some local data in the context.
|
boolean |
remove(Object key)
Remove some data from the context.
|
boolean |
removeLocal(Object key)
Remove some local data from the context.
|
void |
runOnContext(Handler<Void> action)
Run the specified action asynchronously on the same context, some time after the current execution has completed.
|
<T> Single<T> |
rxExecuteBlocking(Callable<T> blockingCodeHandler)
|
<T> Single<T> |
rxExecuteBlocking(Callable<T> blockingCodeHandler,
boolean ordered)
|
<T> Single<T> |
rxExecuteBlocking(Handler<Promise<T>> blockingCodeHandler)
Deprecated.
|
<T> Single<T> |
rxExecuteBlocking(Handler<Promise<T>> blockingCodeHandler,
boolean ordered)
Deprecated.
|
ThreadingModel |
threadingModel() |
String |
toString() |
public static final io.vertx.lang.rx.TypeArg<Context> __TYPE_ARG
public Context getDelegate()
public static boolean isOnWorkerThread()
NOTE! This is not always the same as calling isWorkerContext(). If you are running blocking code
from an event loop context, then this will return true but isWorkerContext() will return false.
public static boolean isOnEventLoopThread()
NOTE! This is not always the same as calling isEventLoopContext(). If you are running blocking code
from an event loop context, then this will return false but isEventLoopContext() will return true.
public static boolean isOnVertxThread()
public void runOnContext(Handler<Void> action)
action - the action to run@Deprecated public <T> void executeBlocking(Handler<Promise<T>> blockingCodeHandler, boolean ordered, Handler<AsyncResult<T>> resultHandler)
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.
The blocking code should block for a reasonable amount of time (i.e no more than a few seconds). Long blocking operations or polling operations (i.e a thread that spin in a loop polling events in a blocking fashion) are precluded.
When the blocking operation lasts more than the 10 seconds, a message will be printed on the console by the blocked thread checker.
Long blocking operations should use a dedicated thread managed by the application, which can interact with
verticles using the event-bus or runOnContext(io.vertx.core.Handler<java.lang.Void>)
blockingCodeHandler - handler representing the blocking code to runordered - 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 guaranteesresultHandler - handler that will be called when the blocking code is complete@Deprecated public <T> void executeBlocking(Handler<Promise<T>> blockingCodeHandler, boolean ordered)
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.
The blocking code should block for a reasonable amount of time (i.e no more than a few seconds). Long blocking operations or polling operations (i.e a thread that spin in a loop polling events in a blocking fashion) are precluded.
When the blocking operation lasts more than the 10 seconds, a message will be printed on the console by the blocked thread checker.
Long blocking operations should use a dedicated thread managed by the application, which can interact with
verticles using the event-bus or runOnContext(io.vertx.core.Handler<java.lang.Void>)
blockingCodeHandler - handler representing the blocking code to runordered - 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@Deprecated public <T> Single<T> rxExecuteBlocking(Handler<Promise<T>> blockingCodeHandler, boolean ordered)
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.
The blocking code should block for a reasonable amount of time (i.e no more than a few seconds). Long blocking operations or polling operations (i.e a thread that spin in a loop polling events in a blocking fashion) are precluded.
When the blocking operation lasts more than the 10 seconds, a message will be printed on the console by the blocked thread checker.
Long blocking operations should use a dedicated thread managed by the application, which can interact with
verticles using the event-bus or runOnContext(io.vertx.core.Handler<java.lang.Void>)
blockingCodeHandler - handler representing the blocking code to runordered - 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@Deprecated public <T> void executeBlocking(Handler<Promise<T>> blockingCodeHandler, Handler<AsyncResult<T>> resultHandler)
executeBlocking(io.vertx.core.Handler<io.vertx.rxjava.core.Promise<T>>, boolean, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) with order = true.blockingCodeHandler - handler representing the blocking code to runresultHandler - handler that will be called when the blocking code is complete@Deprecated public <T> void executeBlocking(Handler<Promise<T>> blockingCodeHandler)
executeBlocking(io.vertx.core.Handler<io.vertx.rxjava.core.Promise<T>>, boolean, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) with order = true.blockingCodeHandler - handler representing the blocking code to run@Deprecated public <T> Single<T> rxExecuteBlocking(Handler<Promise<T>> blockingCodeHandler)
executeBlocking(io.vertx.core.Handler<io.vertx.rxjava.core.Promise<T>>, boolean, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) with order = true.blockingCodeHandler - handler representing the blocking code to runpublic String deploymentID()
public JsonObject config()
public boolean isEventLoopContext()
NOTE! when running blocking code using Vertx.executeBlocking(io.vertx.core.Handler<io.vertx.rxjava.core.Promise<T>>, boolean, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) from a
standard (not worker) verticle, the context will still an event loop context and this
will return true.
public boolean isWorkerContext()
NOTE! when running blocking code using Vertx.executeBlocking(io.vertx.core.Handler<io.vertx.rxjava.core.Promise<T>>, boolean, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) from a
standard (not worker) verticle, the context will still an event loop context and this
will return false.
public ThreadingModel threadingModel()
public <T> T get(Object key)
key - the key of the datapublic void put(Object key, Object value)
This can be used to share data between different handlers that share a context
key - the key of the datavalue - the datapublic boolean remove(Object key)
key - the key to removepublic <T> T getLocal(Object key)
key - the key of the datapublic void putLocal(Object key, Object value)
This can be used to share data between different handlers that share a context
key - the key of the datavalue - the datapublic boolean removeLocal(Object key)
key - the key to removepublic Vertx owner()
public int getInstanceCount()
public Context exceptionHandler(Handler<Throwable> handler)
Vertx.currentContext() will return this context.handler - the exception handlerpublic <T> void executeBlocking(Callable<T> blockingCodeHandler, Handler<AsyncResult<T>> resultHandler)
executeBlocking(io.vertx.core.Handler<io.vertx.rxjava.core.Promise<T>>, boolean, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) but using a callback.blockingCodeHandler - resultHandler - public <T> void executeBlocking(Callable<T> blockingCodeHandler)
executeBlocking(io.vertx.core.Handler<io.vertx.rxjava.core.Promise<T>>, boolean, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) but using a callback.blockingCodeHandler - public <T> Single<T> rxExecuteBlocking(Callable<T> blockingCodeHandler)
executeBlocking(io.vertx.core.Handler<io.vertx.rxjava.core.Promise<T>>, boolean, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) but using a callback.blockingCodeHandler - public <T> void executeBlocking(Callable<T> blockingCodeHandler, boolean ordered, Handler<AsyncResult<T>> resultHandler)
executeBlocking(io.vertx.core.Handler<io.vertx.rxjava.core.Promise<T>>, boolean, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) but using a callback.blockingCodeHandler - ordered - resultHandler - public <T> void executeBlocking(Callable<T> blockingCodeHandler, boolean ordered)
executeBlocking(io.vertx.core.Handler<io.vertx.rxjava.core.Promise<T>>, boolean, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) but using a callback.blockingCodeHandler - ordered - public <T> Single<T> rxExecuteBlocking(Callable<T> blockingCodeHandler, boolean ordered)
executeBlocking(io.vertx.core.Handler<io.vertx.rxjava.core.Promise<T>>, boolean, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) but using a callback.blockingCodeHandler - ordered - Copyright © 2024 Eclipse. All rights reserved.