io.vertx.core

Interface Vertx

All Superinterfaces:

Measured

All Known Subinterfaces:

VertxInternal, VertxSPI

All Known Implementing Classes:

VertxImpl

public interface Vertx
extends Measured

The control centre of the Vert.x Core API.<p> You should normally only use a single instance of this class throughout your application. If you are running in the Vert.x container an instance will be provided to you.<p> If you are using Vert.x embedded, you can create an instance using one of the static VertxFactory.newVertx methods.<p> This class acts as a factory for TCP/SSL and HTTP/HTTPS servers and clients, SockJS servers, and provides an instance of the event bus, file system and shared data classes, as well as methods for setting and cancelling timers.<p> Instances of this class are thread-safe.<p>

Author:

<a href="http://tfox.org">Tim Fox</a>

Field Summary

Fields

Modifier and Type	Field and Description
static VertxFactory	factory

Method Summary

Modifier and Type	Method and Description
boolean	cancelTimer(long id) Cancel the timer with the specified id.
void	close() Stop the eventbus and any resource managed by the eventbus.
void	close(Handler<AsyncResult<Void>> completionHandler) Stop the eventbus and any resource managed by the eventbus.
static void	clusteredVertx(VertxOptions options, Handler<AsyncResult<Vertx>> resultHandler)
DatagramSocket	createDatagramSocket(DatagramSocketOptions options)
DnsClient	createDnsClient(int port, String host) Return the DnsClient
HttpClient	createHttpClient(HttpClientOptions options) Create a HTTP/HTTPS client
HttpServer	createHttpServer(HttpServerOptions options) Create an HTTP/HTTPS server
NetClient	createNetClient(NetClientOptions options) Create a TCP/SSL client
NetServer	createNetServer(NetServerOptions options) Create a TCP/SSL server
static Context	currentContext() Gets the current context
Set<String>	deployments()
void	deployVerticle(String identifier)
void	deployVerticle(String identifier, DeploymentOptions options)
void	deployVerticle(String identifier, DeploymentOptions options, Handler<AsyncResult<String>> completionHandler)
void	deployVerticle(String identifier, Handler<AsyncResult<String>> completionHandler)
void	deployVerticle(Verticle verticle)
void	deployVerticle(Verticle verticle, DeploymentOptions options)
void	deployVerticle(Verticle verticle, DeploymentOptions options, Handler<AsyncResult<String>> completionHandler)
void	deployVerticle(Verticle verticle, Handler<AsyncResult<String>> completionHandler)
EventBus	eventBus() The event bus
<T> void	executeBlocking(Handler<Future<T>> blockingCodeHandler, Handler<AsyncResult<T>> resultHandler)
FileSystem	fileSystem() The File system object
Context	getOrCreateContext() Gets the current context, or creates one if there isn’t one
TimeoutStream	periodicStream(long delay) Returns a periodic timer as a read stream.
void	registerVerticleFactory(VerticleFactory factory)
void	runOnContext(Handler<Void> action) Put the handler on the event queue for the current loop (or worker context) so it will be run asynchronously ASAP after this event has been processed
long	setPeriodic(long delay, Handler<Long> handler) Set a periodic timer to fire every delay milliseconds, at which point handler will be called with the id of the timer.
long	setTimer(long delay, Handler<Long> handler) Set a one-shot timer to fire after delay milliseconds, at which point handler will be called with the id of the timer.
SharedData	sharedData() The shared data object
TimeoutStream	timerStream(long delay) Returns a one-shot timer as a read stream.
void	undeployVerticle(String deploymentID)
void	undeployVerticle(String deploymentID, Handler<AsyncResult<Void>> completionHandler)
void	unregisterVerticleFactory(VerticleFactory factory)
Set<VerticleFactory>	verticleFactories()
static Vertx	vertx()
static Vertx	vertx(VertxOptions options)

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

metricBaseName, metrics

Field Detail

factory

static final VertxFactory factory

Method Detail

vertx

static Vertx vertx()

vertx

static Vertx vertx(VertxOptions options)

clusteredVertx

static void clusteredVertx(VertxOptions options,
                           Handler<AsyncResult<Vertx>> resultHandler)

currentContext

static Context currentContext()

Gets the current context

Returns:

The current context or null if no current context

getOrCreateContext

Context getOrCreateContext()

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

Returns:

The current context (created if didn’t exist)

createNetServer

NetServer createNetServer(NetServerOptions options)

Create a TCP/SSL server

createNetClient

NetClient createNetClient(NetClientOptions options)

Create a TCP/SSL client

createHttpServer

HttpServer createHttpServer(HttpServerOptions options)

Create an HTTP/HTTPS server

createHttpClient

HttpClient createHttpClient(HttpClientOptions options)

Create a HTTP/HTTPS client

createDatagramSocket

DatagramSocket createDatagramSocket(DatagramSocketOptions options)

fileSystem

FileSystem fileSystem()

The File system object

eventBus

EventBus eventBus()

The event bus

createDnsClient

DnsClient createDnsClient(int port,
                          String host)

Return the DnsClient

sharedData

SharedData sharedData()

The shared data object

setTimer

long setTimer(long delay,
              Handler<Long> handler)

Set a one-shot timer to fire after delay milliseconds, at which point handler will be called with the id of the timer.

Returns:

the unique ID of the timer

timerStream

TimeoutStream timerStream(long delay)

Returns a one-shot timer as a read stream. The timer will be fired after delay milliseconds after the ReadStream.handler(io.vertx.core.Handler<T>) has been called.

Returns:

the timer stream

setPeriodic

long setPeriodic(long delay,
                 Handler<Long> handler)

Set a periodic timer to fire every delay milliseconds, at which point handler will be called with the id of the timer.

Returns:

the unique ID of the timer

periodicStream

TimeoutStream periodicStream(long delay)

Returns a periodic timer as a read stream. The timer will be fired every delay milliseconds after the ReadStream.handler(io.vertx.core.Handler<T>) has been called.

Returns:

the periodic stream

cancelTimer

boolean cancelTimer(long id)

Cancel the timer with the specified id. Returns true if the timer was successfully cancelled, or false if the timer does not exist.

runOnContext

void runOnContext(Handler<Void> action)

Put the handler on the event queue for the current loop (or worker context) so it will be run asynchronously ASAP after this event has been processed

close

void close()

Stop the eventbus and any resource managed by the eventbus.

close

void close(Handler<AsyncResult<Void>> completionHandler)

Stop the eventbus and any resource managed by the eventbus.

deployVerticle

void deployVerticle(Verticle verticle)

deployVerticle

void deployVerticle(Verticle verticle,
                    Handler<AsyncResult<String>> completionHandler)

deployVerticle

void deployVerticle(Verticle verticle,
                    DeploymentOptions options)

deployVerticle

void deployVerticle(Verticle verticle,
                    DeploymentOptions options,
                    Handler<AsyncResult<String>> completionHandler)

deployVerticle

void deployVerticle(String identifier)

deployVerticle

void deployVerticle(String identifier,
                    Handler<AsyncResult<String>> completionHandler)

deployVerticle

void deployVerticle(String identifier,
                    DeploymentOptions options)

deployVerticle

void deployVerticle(String identifier,
                    DeploymentOptions options,
                    Handler<AsyncResult<String>> completionHandler)

undeployVerticle

void undeployVerticle(String deploymentID)

undeployVerticle

void undeployVerticle(String deploymentID,
                      Handler<AsyncResult<Void>> completionHandler)

deployments

Set<String> deployments()

registerVerticleFactory

void registerVerticleFactory(VerticleFactory factory)

unregisterVerticleFactory

void unregisterVerticleFactory(VerticleFactory factory)

executeBlocking

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

verticleFactories

Set<VerticleFactory> verticleFactories()