io.vertx.core.impl

Class ContextImpl

java.lang.Object

io.vertx.core.impl.ContextImpl

All Implemented Interfaces:

Context

Direct Known Subclasses:

EventLoopContext, WorkerContext

public abstract class ContextImpl
extends Object
implements Context

Author:

Tim Fox

Field Summary

Fields

Modifier and Type	Field and Description
protected JsonObject	config
protected io.vertx.core.impl.VertxThread	contextThread
protected String	deploymentID
protected Executor	orderedInternalPoolExec
VertxInternal	owner
protected Executor	workerExec

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContextImpl(VertxInternal vertx, Executor orderedInternalPoolExec, Executor workerExec, String deploymentID, JsonObject config, ClassLoader tccl)

Method Summary

Modifier and Type	Method and Description
void	addCloseHook(Closeable hook)
protected abstract void	checkCorrectThread()
JsonObject	config() If the context is associated with a Verticle deployment, this returns the configuration that was specified when the verticle was deployed.
abstract Map<String,Object>	contextData()
String	deploymentID() If the context is associated with a Verticle deployment, this returns the deployment ID of that deployment.
io.netty.channel.EventLoop	eventLoop()
protected abstract void	executeAsync(Handler<Void> task)
<T> void	executeBlocking(Action<T> action, boolean internal, Handler<AsyncResult<T>> resultHandler)
<T> void	executeBlocking(Handler<Future<T>> blockingCodeHandler, Handler<AsyncResult<T>> resultHandler)
protected void	executeEnd()
protected void	executeStart()
void	executeSync(ContextTask task)
<T> T	get(String key) Get some data from the context.
Deployment	getDeployment()
abstract boolean	isEventLoopContext()
abstract boolean	isMultiThreaded()
boolean	isWorker()
Vertx	owner()
List<String>	processArgs() The process args
void	put(String key, Object value) Put some data in the context.
boolean	remove(String key) Remove some data from the context.
void	removeCloseHook(Closeable hook)
void	runCloseHooks(Handler<AsyncResult<Void>> completionHandler)
void	runOnContext(Handler<Void> task) Run the specified action asynchronously on the same context, some time after the current execution has completed.
static void	setContext(ContextImpl context)
void	setDeployment(Deployment deployment)
protected Runnable	wrapTask(ContextTask cTask, Handler<Void> hTask, boolean checkThread)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

owner

public final VertxInternal owner

deploymentID

protected final String deploymentID

config

protected final JsonObject config

orderedInternalPoolExec

protected final Executor orderedInternalPoolExec

workerExec

protected final Executor workerExec

contextThread

protected io.vertx.core.impl.VertxThread contextThread

Constructor Detail

ContextImpl

protected ContextImpl(VertxInternal vertx,
                      Executor orderedInternalPoolExec,
                      Executor workerExec,
                      String deploymentID,
                      JsonObject config,
                      ClassLoader tccl)

Method Detail

setContext

public static void setContext(ContextImpl context)

setDeployment

public void setDeployment(Deployment deployment)

getDeployment

public Deployment getDeployment()

addCloseHook

public void addCloseHook(Closeable hook)

removeCloseHook

public void removeCloseHook(Closeable hook)

runCloseHooks

public void runCloseHooks(Handler<AsyncResult<Void>> completionHandler)

executeAsync

protected abstract void executeAsync(Handler<Void> task)

isEventLoopContext

public abstract boolean isEventLoopContext()

Specified by:

isEventLoopContext in interface Context

Returns:

true if this is an event loop context, false otherwise

isMultiThreaded

public abstract boolean isMultiThreaded()

Specified by:

isMultiThreaded in interface Context

Returns:

true if this is a multi-threaded worker context, false otherwise

contextData

public abstract Map<String,Object> contextData()

get

public <T> T get(String key)

Description copied from interface: Context

Get some data from the context.

Specified by:

get in interface Context

Type Parameters:

T - the type of the data

Parameters:

key - the key of the data

Returns:

the data

put

public void put(String key,
                Object value)

Description copied from interface: Context

Put some data in the context.

This can be used to share data between different handlers that share a context

Specified by:

put in interface Context

Parameters:

key - the key of the data

value - the data

remove

public boolean remove(String key)

Description copied from interface: Context

Remove some data from the context.

Specified by:

remove in interface Context

Parameters:

key - the key to remove

Returns:

true if removed successfully, false otherwise

isWorker

public boolean isWorker()

Specified by:

isWorker in interface Context

Returns:

true if this is an worker context, false otherwise

executeSync

public void executeSync(ContextTask task)

checkCorrectThread

protected abstract void checkCorrectThread()

runOnContext

public void runOnContext(Handler<Void> task)

Description copied from interface: Context

Run the specified action asynchronously on the same context, some time after the current execution has completed.

Specified by:

runOnContext in interface Context

Parameters:

task - the action to run

deploymentID

public String deploymentID()

Description copied from interface: Context

If the context is associated with a Verticle deployment, this returns the deployment ID of that deployment.

Specified by:

deploymentID in interface Context

Returns:

the deployment ID of the deployment or null if not a Verticle deployment

config

public JsonObject config()

Description copied from interface: Context

If the context is associated with a Verticle deployment, this returns the configuration that was specified when the verticle was deployed.

Specified by:

config in interface Context

Returns:

the configuration of the deployment or null if not a Verticle deployment

processArgs

public List<String> processArgs()

Description copied from interface: Context

The process args

Specified by:

processArgs in interface Context

eventLoop

public io.netty.channel.EventLoop eventLoop()

owner

public Vertx owner()

Specified by:

owner in interface Context

Returns:

The Vertx instance that created the context

executeBlocking

public <T> void executeBlocking(Action<T> action,
                                boolean internal,
                                Handler<AsyncResult<T>> resultHandler)

executeBlocking

public <T> void executeBlocking(Handler<Future<T>> blockingCodeHandler,
                                Handler<AsyncResult<T>> resultHandler)

executeStart

protected void executeStart()

executeEnd

protected void executeEnd()

wrapTask

protected Runnable wrapTask(ContextTask cTask,
                            Handler<Void> hTask,
                            boolean checkThread)