Vert.x 4.5.13 · io.vertx.core.impl.VertxInternal · APIdia, the JavaDoc alternative

Modifier and Type	Method and Description
public void	addCloseHook(Closeable hook)
public AddressResolver	Returns: the address resolver addressResolver()
public BlockedThreadChecker	blockedThreadChecker()
public CloseFuture	closeFuture()
public List<ContextLocal<?>>	Returns: an immutable list of this vertx instance context locals contextLocals()
public ContextInternal	Returns: event loop context createEventLoopContext(Deployment deployment, CloseFuture closeFuture, WorkerPool workerPool, ClassLoader tccl)
public ContextInternal	Returns: event loop context createEventLoopContext(EventLoop eventLoop, WorkerPool workerPool, ClassLoader tccl)
public ContextInternal	Returns: event loop context createEventLoopContext()
public HttpClient	Returns: the client createHttpPoolClient(HttpClientOptions the http client options to use clientOptions, PoolOptions the pool options to use poolOptions, CloseFuture the close future closeFuture) Create a HTTP/HTTPS client using the specified options and close future
public default <C> C	createSharedClient(String clientKey, String clientName, CloseFuture closeFuture, Function<CloseFuture, C> supplier)
public WorkerExecutorInternal	createSharedWorkerExecutor(String name) Redeclares io.vertx.core.Vertx.createSharedWorkerExecutor. Like `createSharedWorkerExecutor(String, int)` but with the `VertxOptions#setWorkerPoolSize` `poolSize`.
public WorkerExecutorInternal	createSharedWorkerExecutor(String name, int poolSize) Redeclares io.vertx.core.Vertx.createSharedWorkerExecutor. Like `createSharedWorkerExecutor(String, int, long)` but with the `VertxOptions#setMaxWorkerExecuteTime` `maxExecuteTime`.
public WorkerExecutorInternal	createSharedWorkerExecutor(String name, int poolSize, long maxExecuteTime) Redeclares io.vertx.core.Vertx.createSharedWorkerExecutor. Like `createSharedWorkerExecutor(String, int, long, TimeUnit)` but with the `VertxOptions#setMaxWorkerExecuteTimeUnit(TimeUnit)` `maxExecuteTimeUnit`.
public WorkerExecutorInternal	createSharedWorkerExecutor(String the name of the worker executor name, int the size of the pool poolSize, long the value of max worker execute time maxExecuteTime, TimeUnit the value of unit of max worker execute time maxExecuteTimeUnit) Redeclares io.vertx.core.Vertx.createSharedWorkerExecutor. Create a named worker executor, the executor should be closed when it's not needed anymore to release resources.
public WorkerPool	createSharedWorkerPool(String name, int poolSize, long maxExecuteTime, TimeUnit maxExecuteTimeUnit)
public ContextInternal	Returns: virtual thread context createVirtualThreadContext(Deployment deployment, CloseFuture closeFuture, ClassLoader tccl)
public ContextInternal	Returns: virtual thread context createVirtualThreadContext(EventLoop eventLoop, ClassLoader tccl)
public ContextInternal	Returns: virtual thread context createVirtualThreadContext()
public WebSocketClient	Returns: the client createWebSocketClient(WebSocketClientOptions the options to use options, CloseFuture the close future closeFuture) Create a WebSocket client using the specified options and close future
public ContextInternal	Returns: worker context createWorkerContext(Deployment deployment, CloseFuture closeFuture, WorkerPool workerPool, ClassLoader tccl)
public ContextInternal	Returns: worker context createWorkerContext(EventLoop eventLoop, WorkerPool workerPool, ClassLoader tccl)
public ContextInternal	Returns: worker context createWorkerContext()
public default <T> void	executeBlockingInternal(Handler<Promise<T>> blockingCodeHandler, Handler<AsyncResult<T>> resultHandler) Deprecated Like `executeBlocking(Handler, Handler)` but using the internal worker thread pool.
public default <T> Future<T>	executeBlockingInternal(Callable<T> blockingCodeHandler)
public default <T> void	executeBlockingInternal(Handler<Promise<T>> blockingCodeHandler, boolean ordered, Handler<AsyncResult<T>> resultHandler) Deprecated
public default <T> Future<T>	executeBlockingInternal(Callable<T> blockingCodeHandler, boolean ordered)
public void	failDuringFailover(boolean fail)
public void	failoverCompleteHandler(FailoverCompleteHandler failoverCompleteHandler)
public FileResolver	Returns: the file resolver fileResolver()
public EventLoopGroup	getAcceptorEventLoopGroup()
public ClusterManager	getClusterManager()
public ContextInternal	Returns: the context getContext() Get the current context
public Deployment	getDeployment(String deploymentID)
public EventLoopGroup	getEventLoopGroup()
public WorkerPool	getInternalWorkerPool()
public ContextInternal	getOrCreateContext() Redeclares io.vertx.core.Vertx.getOrCreateContext. Gets the current context, or creates one if there isn't one
public WorkerPool	getWorkerPool()
public HAManager	haManager()
public boolean	isKilled()
public boolean	Returns: whether virtual threads are available isVirtualThreadAvailable()
public long	maxEventLoopExecTime()
public TimeUnit	maxEventLoopExecTimeUnit()
public VertxMetrics	metricsSPI()
public AddressResolverGroup<InetSocketAddress>	Returns: the Netty `AddressResolverGroup` to use in a Netty `Bootstrap` nettyAddressResolverGroup()
public <T> PromiseInternal<T>	Returns: a promise associated with the context returned by `getOrCreateContext()`. promise()
public <T> PromiseInternal<T>	Returns: a promise associated with the context returned by `getOrCreateContext()` or the `handler` if that handler is already an instance of `PromiseInternal` promise(Handler<AsyncResult<T>> handler)
public void	removeCloseHook(Closeable hook)
public void	resolveAddress(String the hostname to resolve hostname, Handler<AsyncResult<InetAddress>> the result handler resultHandler) Resolve an address (e.g. `vertx.io` into the first found A (IPv4) or AAAA (IPv6) record.
public File	resolveFile(String fileName)
public Map<ServerID, HttpServerImpl>	sharedHttpServers()
public Map<ServerID, NetServerImpl>	sharedNetServers()
public <S extends TCPServerBase> Map<ServerID, S>	sharedTCPServers(Class<S> type)
public void	simulateKill()
public VertxTracer<I, O>	Returns: the tracer tracer()
public Transport	transport()
public WorkerPool	wrapWorkerPool(ExecutorService executor)

Method Detail

addCloseHook	back to summary
public void addCloseHook(Closeable hook)

addressResolver	back to summary
public AddressResolver addressResolver() Returns:AddressResolver the address resolver

blockedThreadChecker	back to summary
public BlockedThreadChecker blockedThreadChecker()

closeFuture	back to summary
public CloseFuture closeFuture()

contextLocals	back to summary
public List<ContextLocal<?>> contextLocals() Returns:List<ContextLocal<?>> an immutable list of this vertx instance context locals

createEventLoopContext	back to summary
public ContextInternal createEventLoopContext(Deployment deployment, CloseFuture closeFuture, WorkerPool workerPool, ClassLoader tccl) Returns:ContextInternal event loop context

createEventLoopContext	back to summary
public ContextInternal createEventLoopContext(EventLoop eventLoop, WorkerPool workerPool, ClassLoader tccl) Returns:ContextInternal event loop context

createEventLoopContext	back to summary
public ContextInternal createEventLoopContext() Returns:ContextInternal event loop context

createHttpPoolClient	back to summary
public HttpClient createHttpPoolClient(HttpClientOptions clientOptions, PoolOptions poolOptions, CloseFuture closeFuture) Create a HTTP/HTTPS client using the specified options and close future Parameters clientOptions:HttpClientOptions the http client options to use poolOptions:PoolOptions the pool options to use closeFuture:CloseFuture the close future Returns:HttpClient the client

createHttpPoolClient

back to summary

public HttpClient createHttpPoolClient(HttpClientOptions clientOptions, PoolOptions poolOptions, CloseFuture closeFuture)

Create a HTTP/HTTPS client using the specified options and close future

Parameters

clientOptions:HttpClientOptions: the http client options to use
poolOptions:PoolOptions: the pool options to use
closeFuture:CloseFuture: the close future

Returns:HttpClient

the client

createSharedClient	back to summary
public default <C> C createSharedClient(String clientKey, String clientName, CloseFuture closeFuture, Function<CloseFuture, C> supplier)

createSharedWorkerExecutor back to summary

createSharedWorkerExecutor	back to summary
public WorkerExecutorInternal createSharedWorkerExecutor(String name) Redeclares io.vertx.core.Vertx.createSharedWorkerExecutor. Doc from io.vertx.core.Vertx.createSharedWorkerExecutor. Like `createSharedWorkerExecutor(String, int)` but with the `VertxOptions#setWorkerPoolSize` `poolSize`. Annotations @Override

public WorkerExecutorInternal createSharedWorkerExecutor(String name)

Redeclares io.vertx.core.Vertx.createSharedWorkerExecutor.

Doc from io.vertx.core.Vertx.createSharedWorkerExecutor.

Like createSharedWorkerExecutor(String, int) but with the VertxOptions#setWorkerPoolSize poolSize.

Annotations

@Override

createSharedWorkerExecutor back to summary

createSharedWorkerExecutor	back to summary
public WorkerExecutorInternal createSharedWorkerExecutor(String name, int poolSize) Redeclares io.vertx.core.Vertx.createSharedWorkerExecutor. Doc from io.vertx.core.Vertx.createSharedWorkerExecutor. Like `createSharedWorkerExecutor(String, int, long)` but with the `VertxOptions#setMaxWorkerExecuteTime` `maxExecuteTime`. Annotations @Override

public WorkerExecutorInternal createSharedWorkerExecutor(String name, int poolSize)

Redeclares io.vertx.core.Vertx.createSharedWorkerExecutor.

Doc from io.vertx.core.Vertx.createSharedWorkerExecutor.

Like createSharedWorkerExecutor(String, int, long) but with the VertxOptions#setMaxWorkerExecuteTime maxExecuteTime.

Annotations

@Override

createSharedWorkerExecutor back to summary

createSharedWorkerExecutor	back to summary
public WorkerExecutorInternal createSharedWorkerExecutor(String name, int poolSize, long maxExecuteTime) Redeclares io.vertx.core.Vertx.createSharedWorkerExecutor. Doc from io.vertx.core.Vertx.createSharedWorkerExecutor. Like `createSharedWorkerExecutor(String, int, long, TimeUnit)` but with the `VertxOptions#setMaxWorkerExecuteTimeUnit(TimeUnit)` `maxExecuteTimeUnit`. Annotations @Override

public WorkerExecutorInternal createSharedWorkerExecutor(String name, int poolSize, long maxExecuteTime)

Redeclares io.vertx.core.Vertx.createSharedWorkerExecutor.

Doc from io.vertx.core.Vertx.createSharedWorkerExecutor.

Like createSharedWorkerExecutor(String, int, long, TimeUnit) but with the VertxOptions#setMaxWorkerExecuteTimeUnit(TimeUnit) maxExecuteTimeUnit.

Annotations

@Override

createSharedWorkerExecutor back to summary

createSharedWorkerExecutor	back to summary
public WorkerExecutorInternal createSharedWorkerExecutor(String name, int poolSize, long maxExecuteTime, TimeUnit maxExecuteTimeUnit) Redeclares io.vertx.core.Vertx.createSharedWorkerExecutor. Doc from io.vertx.core.Vertx.createSharedWorkerExecutor. Create a named worker executor, the executor should be closed when it's not needed anymore to release resources. This method can be called mutiple times with the same `name`. Executors with the same name will share the same worker pool. The worker pool size , max execute time and unit of max execute time are set when the worker pool is created and won't change after. The worker pool is released when all the `WorkerExecutor` sharing the same name are closed. Parameters name:String the name of the worker executor poolSize:int the size of the pool maxExecuteTime:long the value of max worker execute time maxExecuteTimeUnit:TimeUnit the value of unit of max worker execute time Returns:WorkerExecutorInternal the named worker executor Annotations @Override

public WorkerExecutorInternal createSharedWorkerExecutor(String name, int poolSize, long maxExecuteTime, TimeUnit maxExecuteTimeUnit)

Redeclares io.vertx.core.Vertx.createSharedWorkerExecutor.

Doc from io.vertx.core.Vertx.createSharedWorkerExecutor.

Create a named worker executor, the executor should be closed when it's not needed anymore to release resources.

This method can be called mutiple times with the same name. Executors with the same name will share the same worker pool. The worker pool size , max execute time and unit of max execute time are set when the worker pool is created and won't change after.

The worker pool is released when all the WorkerExecutor sharing the same name are closed.

Parameters

name:String: the name of the worker executor
poolSize:int: the size of the pool
maxExecuteTime:long: the value of max worker execute time
maxExecuteTimeUnit:TimeUnit: the value of unit of max worker execute time

Returns:WorkerExecutorInternal

the named worker executor

Annotations

@Override

createSharedWorkerPool	back to summary
public WorkerPool createSharedWorkerPool(String name, int poolSize, long maxExecuteTime, TimeUnit maxExecuteTimeUnit)

createVirtualThreadContext	back to summary
public ContextInternal createVirtualThreadContext(Deployment deployment, CloseFuture closeFuture, ClassLoader tccl) Returns:ContextInternal virtual thread context

createVirtualThreadContext	back to summary
public ContextInternal createVirtualThreadContext(EventLoop eventLoop, ClassLoader tccl) Returns:ContextInternal virtual thread context

createVirtualThreadContext	back to summary
public ContextInternal createVirtualThreadContext() Returns:ContextInternal virtual thread context

createWebSocketClient	back to summary
public WebSocketClient createWebSocketClient(WebSocketClientOptions options, CloseFuture closeFuture) Create a WebSocket client using the specified options and close future Parameters options:WebSocketClientOptions the options to use closeFuture:CloseFuture the close future Returns:WebSocketClient the client

createWebSocketClient

back to summary

public WebSocketClient createWebSocketClient(WebSocketClientOptions options, CloseFuture closeFuture)

Create a WebSocket client using the specified options and close future

Parameters

options:WebSocketClientOptions: the options to use
closeFuture:CloseFuture: the close future

Returns:WebSocketClient

the client

createWorkerContext	back to summary
public ContextInternal createWorkerContext(Deployment deployment, CloseFuture closeFuture, WorkerPool workerPool, ClassLoader tccl) Returns:ContextInternal worker context

createWorkerContext	back to summary
public ContextInternal createWorkerContext(EventLoop eventLoop, WorkerPool workerPool, ClassLoader tccl) Returns:ContextInternal worker context

createWorkerContext	back to summary
public ContextInternal createWorkerContext() Returns:ContextInternal worker context

executeBlockingInternal back to summary

executeBlockingInternal	back to summary
public default <T> void executeBlockingInternal(Handler<Promise<T>> blockingCodeHandler, Handler<AsyncResult<T>> resultHandler) Deprecated Like `executeBlocking(Handler, Handler)` but using the internal worker thread pool. Annotations @Deprecated

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

Deprecated

Like executeBlocking(Handler, Handler) but using the internal worker thread pool.

Annotations

@Deprecated

executeBlockingInternal	back to summary
public default <T> Future<T> executeBlockingInternal(Callable<T> blockingCodeHandler)

executeBlockingInternal	back to summary
public default <T> void executeBlockingInternal(Handler<Promise<T>> blockingCodeHandler, boolean ordered, Handler<AsyncResult<T>> resultHandler) Deprecated Annotations @Deprecated

executeBlockingInternal	back to summary
public default <T> Future<T> executeBlockingInternal(Callable<T> blockingCodeHandler, boolean ordered)

failDuringFailover	back to summary
public void failDuringFailover(boolean fail)

failoverCompleteHandler	back to summary
public void failoverCompleteHandler(FailoverCompleteHandler failoverCompleteHandler)

fileResolver	back to summary
public FileResolver fileResolver() Returns:FileResolver the file resolver

getAcceptorEventLoopGroup	back to summary
public EventLoopGroup getAcceptorEventLoopGroup()

getClusterManager	back to summary
public ClusterManager getClusterManager()

getContext	back to summary
public ContextInternal getContext() Get the current context Returns:ContextInternal the context

getContext

back to summary

public ContextInternal getContext()

Get the current context

Returns:ContextInternal: the context

getDeployment	back to summary
public Deployment getDeployment(String deploymentID)

getEventLoopGroup	back to summary
public EventLoopGroup getEventLoopGroup()

getInternalWorkerPool	back to summary
public WorkerPool getInternalWorkerPool()

getOrCreateContext	back to summary
public ContextInternal getOrCreateContext() Redeclares io.vertx.core.Vertx.getOrCreateContext. Doc from io.vertx.core.Vertx.getOrCreateContext. Gets the current context, or creates one if there isn't one Returns:ContextInternal The current context (created if didn't exist) Annotations @Override

getOrCreateContext

back to summary

public ContextInternal getOrCreateContext()

Redeclares io.vertx.core.Vertx.getOrCreateContext.

Doc from io.vertx.core.Vertx.getOrCreateContext.

Gets the current context, or creates one if there isn't one

Returns:ContextInternal

The current context (created if didn't exist)

Annotations

@Override

getWorkerPool	back to summary
public WorkerPool getWorkerPool()

haManager	back to summary
public HAManager haManager()

isKilled	back to summary
public boolean isKilled()

isVirtualThreadAvailable	back to summary
public boolean isVirtualThreadAvailable() Returns:boolean whether virtual threads are available

maxEventLoopExecTime	back to summary
public long maxEventLoopExecTime()

maxEventLoopExecTimeUnit	back to summary
public TimeUnit maxEventLoopExecTimeUnit()

metricsSPI	back to summary
public VertxMetrics metricsSPI()

nettyAddressResolverGroup	back to summary
public AddressResolverGroup<InetSocketAddress> nettyAddressResolverGroup() Returns:AddressResolverGroup<InetSocketAddress> the Netty `AddressResolverGroup` to use in a Netty `Bootstrap`

promise	back to summary
public <T> PromiseInternal<T> promise() Returns:PromiseInternal<T> a promise associated with the context returned by `getOrCreateContext()`.

promise	back to summary
public <T> PromiseInternal<T> promise(Handler<AsyncResult<T>> handler) Returns:PromiseInternal<T> a promise associated with the context returned by `getOrCreateContext()` or the `handler` if that handler is already an instance of `PromiseInternal`

removeCloseHook	back to summary
public void removeCloseHook(Closeable hook)

resolveAddress back to summary

resolveAddress	back to summary
public void resolveAddress(String hostname, Handler<AsyncResult<InetAddress>> resultHandler) Resolve an address (e.g. `vertx.io` into the first found A (IPv4) or AAAA (IPv6) record. Parameters hostname:String the hostname to resolve resultHandler:Handler<AsyncResult<InetAddress>> the result handler

public void resolveAddress(String hostname, Handler<AsyncResult<InetAddress>> resultHandler)

Resolve an address (e.g. vertx.io into the first found A (IPv4) or AAAA (IPv6) record.

Parameters

hostname:String: the hostname to resolve
resultHandler:Handler<AsyncResult<InetAddress>>: the result handler

resolveFile	back to summary
public File resolveFile(String fileName)

sharedHttpServers	back to summary
public Map<ServerID, HttpServerImpl> sharedHttpServers()

sharedNetServers	back to summary
public Map<ServerID, NetServerImpl> sharedNetServers()

sharedTCPServers	back to summary
public <S extends TCPServerBase> Map<ServerID, S> sharedTCPServers(Class<S> type)

simulateKill	back to summary
public void simulateKill()

tracer	back to summary
public VertxTracer<I, O> tracer() Returns:VertxTracer<I, O> the tracer

transport	back to summary
public Transport transport()

wrapWorkerPool	back to summary
public WorkerPool wrapWorkerPool(ExecutorService executor)

public Interface VertxInternal

Method Summary

Method Detail