io.vertx.core.impl

Interface VertxInternal

All Superinterfaces:

Measured, Vertx

All Known Implementing Classes:

VertxImpl

public interface VertxInternal
extends Vertx

This interface provides services for vert.x core internal use only It is not part of the public API and should not be used by developers creating vert.x applications

Author:

Tim Fox

Method Summary

Modifier and Type	Method and Description
void	addCloseHook(Closeable hook)
AddressResolver	addressResolver()
BlockedThreadChecker	blockedThreadChecker()
EventLoopContext	createEventLoopContext()
EventLoopContext	createEventLoopContext(Deployment deployment, CloseHooks closeHooks, WorkerPool workerPool, ClassLoader tccl)
EventLoopContext	createEventLoopContext(io.netty.channel.EventLoop eventLoop, WorkerPool workerPool, ClassLoader tccl)
HttpClient	createHttpClient(HttpClientOptions options, CloseFuture closeFuture) Create a HTTP/HTTPS client using the specified options and close future
NetClient	createNetClient(NetClientOptions options, CloseFuture closeFuture) Create a TCP/SSL client using the specified options and close future
WorkerExecutorInternal	createSharedWorkerExecutor(String name) Like Vertx.createSharedWorkerExecutor(String, int) but with the VertxOptions.setWorkerPoolSize(int) poolSize.
WorkerExecutorInternal	createSharedWorkerExecutor(String name, int poolSize) Like Vertx.createSharedWorkerExecutor(String, int, long) but with the VertxOptions.setMaxWorkerExecuteTime(long) maxExecuteTime.
WorkerExecutorInternal	createSharedWorkerExecutor(String name, int poolSize, long maxExecuteTime) Like Vertx.createSharedWorkerExecutor(String, int, long, TimeUnit) but with the ns unit.
WorkerExecutorInternal	createSharedWorkerExecutor(String name, int poolSize, long maxExecuteTime, TimeUnit maxExecuteTimeUnit) 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.
WorkerPool	createSharedWorkerPool(String name, int poolSize, long maxExecuteTime, TimeUnit maxExecuteTimeUnit)
WorkerContext	createWorkerContext()
WorkerContext	createWorkerContext(Deployment deployment, CloseHooks closeHooks, WorkerPool pool, ClassLoader tccl)
<T> void	executeBlockingInternal(Handler<Promise<T>> blockingCodeHandler, boolean ordered, Handler<AsyncResult<T>> resultHandler)
<T> void	executeBlockingInternal(Handler<Promise<T>> blockingCodeHandler, Handler<AsyncResult<T>> resultHandler) Like Vertx.executeBlocking(Handler, Handler) but using the internal worker thread pool.
void	failDuringFailover(boolean fail)
void	failoverCompleteHandler(FailoverCompleteHandler failoverCompleteHandler)
io.netty.channel.EventLoopGroup	getAcceptorEventLoopGroup()
ClusterManager	getClusterManager()
ContextInternal	getContext() Get the current context
Deployment	getDeployment(String deploymentID)
io.netty.channel.EventLoopGroup	getEventLoopGroup()
ContextInternal	getOrCreateContext() Gets the current context, or creates one if there isn't one
ExecutorService	getWorkerPool()
HAManager	haManager()
boolean	isKilled()
long	maxEventLoopExecTime()
TimeUnit	maxEventLoopExecTimeUnit()
VertxMetrics	metricsSPI()
io.netty.resolver.AddressResolverGroup<InetSocketAddress>	nettyAddressResolverGroup()
<T> PromiseInternal<T>	promise()
<T> PromiseInternal<T>	promise(Handler<AsyncResult<T>> handler)
void	removeCloseHook(Closeable hook)
void	resolveAddress(String hostname, Handler<AsyncResult<InetAddress>> resultHandler) Resolve an address (e.g.
File	resolveFile(String fileName)
Map<ServerID,HttpServerImpl>	sharedHttpServers()
Map<ServerID,NetServerImpl>	sharedNetServers()
<S extends TCPServerBase> Map<ServerID,S>	sharedTCPServers(Class<S> type)
void	simulateKill()
Transport	transport()

Methods inherited from interface io.vertx.core.Vertx

cancelTimer, close, close, clusteredVertx, clusteredVertx, createDatagramSocket, createDatagramSocket, createDnsClient, createDnsClient, createDnsClient, createHttpClient, createHttpClient, createHttpServer, createHttpServer, createNetClient, createNetClient, createNetServer, createNetServer, currentContext, deploymentIDs, deployVerticle, deployVerticle, deployVerticle, deployVerticle, deployVerticle, deployVerticle, deployVerticle, deployVerticle, deployVerticle, deployVerticle, deployVerticle, deployVerticle, eventBus, exceptionHandler, exceptionHandler, executeBlocking, executeBlocking, executeBlocking, executeBlocking, fileSystem, isClustered, isNativeTransportEnabled, nettyEventLoopGroup, periodicStream, registerVerticleFactory, runOnContext, setPeriodic, setTimer, sharedData, timerStream, undeploy, undeploy, unregisterVerticleFactory, verticleFactories, vertx, vertx

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

isMetricsEnabled

Method Detail

promise

<T> PromiseInternal<T> promise()

Returns:

a promise associated with the context returned by getOrCreateContext().

promise

<T> PromiseInternal<T> promise(Handler<AsyncResult<T>> handler)

Returns:

a promise associated with the context returned by getOrCreateContext() or the handler if that handler is already an instance of PromiseInternal

maxEventLoopExecTime

long maxEventLoopExecTime()

maxEventLoopExecTimeUnit

TimeUnit maxEventLoopExecTimeUnit()

getOrCreateContext

ContextInternal getOrCreateContext()

Description copied from interface: Vertx

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

Specified by:

getOrCreateContext in interface Vertx

Returns:

The current context (created if didn't exist)

getEventLoopGroup

io.netty.channel.EventLoopGroup getEventLoopGroup()

getAcceptorEventLoopGroup

io.netty.channel.EventLoopGroup getAcceptorEventLoopGroup()

getWorkerPool

ExecutorService getWorkerPool()

sharedHttpServers

Map<ServerID,HttpServerImpl> sharedHttpServers()

sharedNetServers

Map<ServerID,NetServerImpl> sharedNetServers()

sharedTCPServers

<S extends TCPServerBase> Map<ServerID,S> sharedTCPServers(Class<S> type)

metricsSPI

VertxMetrics metricsSPI()

transport

Transport transport()

createNetClient

NetClient createNetClient(NetClientOptions options,
                          CloseFuture closeFuture)

Create a TCP/SSL client using the specified options and close future

Parameters:

options - the options to use

closeFuture - the close future

Returns:

the client

createHttpClient

HttpClient createHttpClient(HttpClientOptions options,
                            CloseFuture closeFuture)

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

Parameters:

options - the options to use

closeFuture - the close future

Returns:

the client

getContext

ContextInternal getContext()

Get the current context

Returns:

the context

createEventLoopContext

EventLoopContext createEventLoopContext(Deployment deployment,
                                        CloseHooks closeHooks,
                                        WorkerPool workerPool,
                                        ClassLoader tccl)

Returns:

event loop context

createEventLoopContext

EventLoopContext createEventLoopContext(io.netty.channel.EventLoop eventLoop,
                                        WorkerPool workerPool,
                                        ClassLoader tccl)

createEventLoopContext

EventLoopContext createEventLoopContext()

createWorkerContext

WorkerContext createWorkerContext(Deployment deployment,
                                  CloseHooks closeHooks,
                                  WorkerPool pool,
                                  ClassLoader tccl)

Returns:

worker loop context

createWorkerContext

WorkerContext createWorkerContext()

createSharedWorkerExecutor

WorkerExecutorInternal createSharedWorkerExecutor(String name)

Description copied from interface: Vertx

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

Specified by:

createSharedWorkerExecutor in interface Vertx

createSharedWorkerExecutor

WorkerExecutorInternal createSharedWorkerExecutor(String name,
                                                  int poolSize)

Description copied from interface: Vertx

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

Specified by:

createSharedWorkerExecutor in interface Vertx

createSharedWorkerExecutor

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

Description copied from interface: Vertx

Like Vertx.createSharedWorkerExecutor(String, int, long, TimeUnit) but with the ns unit.

Specified by:

createSharedWorkerExecutor in interface Vertx

createSharedWorkerExecutor

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

Description copied from interface: Vertx

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.

Specified by:

createSharedWorkerExecutor in interface Vertx

Parameters:

name - the name of the worker executor

poolSize - the size of the pool

maxExecuteTime - the value of max worker execute time

maxExecuteTimeUnit - the value of unit of max worker execute time

Returns:

the named worker executor

createSharedWorkerPool

WorkerPool createSharedWorkerPool(String name,
                                  int poolSize,
                                  long maxExecuteTime,
                                  TimeUnit maxExecuteTimeUnit)

simulateKill

void simulateKill()

getDeployment

Deployment getDeployment(String deploymentID)

failoverCompleteHandler

void failoverCompleteHandler(FailoverCompleteHandler failoverCompleteHandler)

isKilled

boolean isKilled()

failDuringFailover

void failDuringFailover(boolean fail)

resolveFile

File resolveFile(String fileName)

executeBlockingInternal

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

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

executeBlockingInternal

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

getClusterManager

ClusterManager getClusterManager()

haManager

HAManager haManager()

resolveAddress

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 - the hostname to resolve

resultHandler - the result handler

addressResolver

AddressResolver addressResolver()

Returns:

the address resolver

nettyAddressResolverGroup

io.netty.resolver.AddressResolverGroup<InetSocketAddress> nettyAddressResolverGroup()

Returns:

the Netty AddressResolverGroup to use in a Netty Bootstrap

blockedThreadChecker

BlockedThreadChecker blockedThreadChecker()

addCloseHook

void addCloseHook(Closeable hook)

removeCloseHook

void removeCloseHook(Closeable hook)