## Uses of Interface
io.vertx.core.Vertx

- Packages that use Vertx
  Package | Description
  --- | ---
  io.vertx.core |
  io.vertx.core.spi |
  io.vertx.core.spi.cluster |
  io.vertx.ext.auth.jwt |
  io.vertx.ext.auth.shiro |
  io.vertx.ext.dropwizard |
  io.vertx.ext.jdbc |
  io.vertx.ext.mail |
  io.vertx.ext.mongo |
  io.vertx.ext.unit |
  io.vertx.ext.unit.collect |
  io.vertx.ext.unit.junit |
  io.vertx.ext.unit.report |
  io.vertx.ext.web |
  io.vertx.ext.web.handler.sockjs |
  io.vertx.ext.web.sstore |
  io.vertx.redis |
  io.vertx.rx.java |
  io.vertx.rxjava.core |
  io.vertx.spi.cluster.hazelcast |

- - ### Uses of Vertx in io.vertx.core

    Fields in io.vertx.core declared as Vertx
    Modifier and Type | Field and Description
    --- | ---
    `protected Vertx` | AbstractVerticle.`vertx` Reference to the Vert.x instance that deployed this verticle
    `protected Vertx` | Starter.`vertx`

    Methods in io.vertx.core that return Vertx
    Modifier and Type | Method and Description
    --- | ---
    `Vertx` | AbstractVerticle.`getVertx()` Get the Vert.x instance
    `Vertx` | Verticle.`getVertx()` Get a reference to the Vert.x instance that deployed this verticle
    `Vertx` | Context.`owner()`
    `static Vertx` | Vertx.`vertx()` Creates a non clustered instance using default options.
    `static Vertx` | Vertx.`vertx(VertxOptions options)` Creates a non clustered instance using the specified options

    Methods in io.vertx.core with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `void` | AbstractVerticle.`init(Vertx vertx, Context context)` Initialise the verticle.
    `void` | Verticle.`init(Vertx vertx, Context context)` Initialise the verticle with the Vert.x instance and the context.

    Method parameters in io.vertx.core with type arguments of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static void` | Vertx.`clusteredVertx(VertxOptions options, Handler<AsyncResult<Vertx>> resultHandler)` Creates a clustered instance using the specified options.

  - ### Uses of Vertx in io.vertx.core.spi

    Methods in io.vertx.core.spi that return Vertx
    Modifier and Type | Method and Description
    --- | ---
    `Vertx` | VertxFactory.`vertx()`
    `Vertx` | VertxFactory.`vertx(VertxOptions options)`

    Methods in io.vertx.core.spi with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `default void` | VerticleFactory.`init(Vertx vertx)`
    `VertxMetrics` | VertxMetricsFactory.`metrics(Vertx vertx, VertxOptions options)` Create a new `VertxMetrics` object. No specific thread and context can be expected when this method is called.

    Method parameters in io.vertx.core.spi with type arguments of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `void` | VertxFactory.`clusteredVertx(VertxOptions options, Handler<AsyncResult<Vertx>> resultHandler)`

  - ### Uses of Vertx in io.vertx.core.spi.cluster

    Methods in io.vertx.core.spi.cluster with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `void` | ClusterManager.`setVertx(Vertx vertx)`

  - ### Uses of Vertx in io.vertx.ext.auth.jwt

    Methods in io.vertx.ext.auth.jwt with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static JWTAuth` | JWTAuth.`create(Vertx vertx, JsonObject config)` Create a JWT auth provider

  - ### Uses of Vertx in io.vertx.ext.auth.shiro

    Methods in io.vertx.ext.auth.shiro with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static ShiroAuth` | ShiroAuth.`create(Vertx vertx, org.apache.shiro.realm.Realm realm)` Create a Shiro auth provider
    `static ShiroAuth` | ShiroAuth.`create(Vertx vertx, ShiroAuthRealmType realmType, JsonObject config)` Create a Shiro auth provider

  - ### Uses of Vertx in io.vertx.ext.dropwizard

    Methods in io.vertx.ext.dropwizard with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static MetricsService` | MetricsService.`create(Vertx vertx)` Creates a metric service for a given `Vertx` instance.

    Constructors in io.vertx.ext.dropwizard with parameters of type Vertx
    Constructor and Description
    `ScheduledMetricsConsumer(Vertx vertx)`
    `ScheduledMetricsConsumer(Vertx vertx, Measured measured)`

  - ### Uses of Vertx in io.vertx.ext.jdbc

    Methods in io.vertx.ext.jdbc with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static JDBCClient` | JDBCClient.`create(Vertx vertx, DataSource dataSource)` Create a client using a pre-existing data source
    `static JDBCClient` | JDBCClient.`createNonShared(Vertx vertx, JsonObject config)` Create a JDBC client which maintains its own data source.
    `static JDBCClient` | JDBCClient.`createShared(Vertx vertx, JsonObject config)` Like `JDBCClient.createShared(io.vertx.core.Vertx, JsonObject, String)` but with the default data source name
    `static JDBCClient` | JDBCClient.`createShared(Vertx vertx, JsonObject config, String dataSourceName)` Create a JDBC client which shares its data source with any other JDBC clients created with the same data source name

  - ### Uses of Vertx in io.vertx.ext.mail

    Methods in io.vertx.ext.mail with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static MailService` | MailService.`createEventBusProxy(Vertx vertx, String address)` create a proxy of MailService that delegates to the mail service running somewhere else via the event bus
    `static MailClient` | MailClient.`createNonShared(Vertx vertx, MailConfig config)` create a non shared instance of the mail client
    `static MailClient` | MailClient.`createShared(Vertx vertx, MailConfig config)` Like `MailClient.createShared(io.vertx.core.Vertx, MailConfig, String)` but with the default pool name
    `static MailClient` | MailClient.`createShared(Vertx vertx, MailConfig config, String poolName)` Create a Mail client which shares its data source with any other Mongo clients created with the same pool name

    Constructors in io.vertx.ext.mail with parameters of type Vertx
    Constructor and Description
    `MailServiceVertxEBProxy(Vertx vertx, String address)`
    `MailServiceVertxProxyHandler(Vertx vertx, MailService service)`
    `MailServiceVertxProxyHandler(Vertx vertx, MailService service, boolean topLevel, long timeoutSeconds)`
    `MailServiceVertxProxyHandler(Vertx vertx, MailService service, long timeoutInSecond)`

  - ### Uses of Vertx in io.vertx.ext.mongo

    Methods in io.vertx.ext.mongo with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static MongoClient` | MongoClient.`createNonShared(Vertx vertx, JsonObject config)` Create a Mongo client which maintains its own data source.
    `static MongoClient` | MongoClient.`createShared(Vertx vertx, JsonObject config)` Like `MongoClient.createShared(io.vertx.core.Vertx, JsonObject, String)` but with the default data source name
    `static MongoClient` | MongoClient.`createShared(Vertx vertx, JsonObject config, String dataSourceName)` Create a Mongo client which shares its data source with any other Mongo clients created with the same data source name

  - ### Uses of Vertx in io.vertx.ext.unit

    Methods in io.vertx.ext.unit with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `void` | TestCase.`awaitSuccess(Vertx vertx)` Assert the test case passes and block until it is executed.
    `void` | TestCase.`awaitSuccess(Vertx vertx, long timeout, TimeUnit unit)` Assert the test case passes and block until it is executed.
    `TestCompletion` | TestSuite.`run(Vertx vertx)` Run the testsuite with the default options and the specified `vertx` instance. The test suite will be executed on the event loop provided by the `vertx` argument.
    `TestCompletion` | TestSuite.`run(Vertx vertx, TestOptions options)` Run the testsuite with the specified `options` and the specified `vertx` instance. The test suite will be executed on the event loop provided by the `vertx` argument when `TestOptions.setUseEventLoop(Boolean)` is not set to `false`.

  - ### Uses of Vertx in io.vertx.ext.unit.collect

    Methods in io.vertx.ext.unit.collect with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static EventBusCollector` | EventBusCollector.`create(Vertx vertx, Handler<TestSuiteReport> reporter)`
    `static EventBusCollector` | EventBusCollector.`create(Vertx vertx, ReportingOptions options)` Create a message handler reporting with the specified options.

  - ### Uses of Vertx in io.vertx.ext.unit.junit

    Methods in io.vertx.ext.unit.junit that return Vertx
    Modifier and Type | Method and Description
    --- | ---
    `Vertx` | RunTestOnContext.`vertx()` Retrieves the current Vert.x instance, this value varies according to the test life cycle.

    Constructor parameters in io.vertx.ext.unit.junit with type arguments of type Vertx
    Constructor and Description
    `RunTestOnContext(java.util.function.Supplier<Vertx> createVertx)` Create a new rule with supplier for creating a Vert.x instance.
    `RunTestOnContext(java.util.function.Supplier<Vertx> createVertx, java.util.function.BiConsumer<Vertx,java.util.function.Consumer<Void>> closeVertx)` Create a new rule with supplier/consumer for creating/closing a Vert.x instance.
    `RunTestOnContext(java.util.function.Supplier<Vertx> createVertx, java.util.function.BiConsumer<Vertx,java.util.function.Consumer<Void>> closeVertx)` Create a new rule with supplier/consumer for creating/closing a Vert.x instance.

  - ### Uses of Vertx in io.vertx.ext.unit.report

    Methods in io.vertx.ext.unit.report with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static Reporter<?>` | Reporter.`reporter(Vertx vertx, ReportOptions options)`
    `Reporter` | ReporterFactory.`reporter(Vertx vertx, ReportOptions options)`

  - ### Uses of Vertx in io.vertx.ext.web

    Methods in io.vertx.ext.web that return Vertx
    Modifier and Type | Method and Description
    --- | ---
    `Vertx` | RoutingContext.`vertx()`

    Methods in io.vertx.ext.web with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static Router` | Router.`router(Vertx vertx)` Create a router

  - ### Uses of Vertx in io.vertx.ext.web.handler.sockjs

    Methods in io.vertx.ext.web.handler.sockjs with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static SockJSHandler` | SockJSHandler.`create(Vertx vertx)` Create a SockJS handler
    `static SockJSHandler` | SockJSHandler.`create(Vertx vertx, SockJSHandlerOptions options)` Create a SockJS handler
    `static void` | SockJSHandler.`installTestApplications(Router router, Vertx vertx)` Install SockJS test applications on a router - used when running the SockJS test suite

  - ### Uses of Vertx in io.vertx.ext.web.sstore

    Methods in io.vertx.ext.web.sstore with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static ClusteredSessionStore` | ClusteredSessionStore.`create(Vertx vertx)` Create a session store
    `static LocalSessionStore` | LocalSessionStore.`create(Vertx vertx)` Create a session store
    `static ClusteredSessionStore` | ClusteredSessionStore.`create(Vertx vertx, String sessionMapName)` Create a session store
    `static LocalSessionStore` | LocalSessionStore.`create(Vertx vertx, String sessionMapName)` Create a session store
    `static LocalSessionStore` | LocalSessionStore.`create(Vertx vertx, String sessionMapName, long reaperInterval)` Create a session store

  - ### Uses of Vertx in io.vertx.redis

    Methods in io.vertx.redis with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static RedisClient` | RedisClient.`create(Vertx vertx, JsonObject config)`

  - ### Uses of Vertx in io.vertx.rx.java

    Methods in io.vertx.rx.java with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `static rx.Scheduler` | RxHelper.`blockingScheduler(Vertx vertx)` Create a scheduler for a `Vertx` object, actions can be blocking, they are not executed on Vertx event loop.
    `static rx.Scheduler` | RxHelper.`scheduler(Vertx vertx)` Create a scheduler for a `Vertx` object, actions are executed on the event loop.
    `static rx.plugins.RxJavaSchedulersHook` | RxHelper.`schedulerHook(Vertx vertx)` Create a scheduler hook for a `Vertx` object, the `RxJavaSchedulersHook.getIOScheduler()` uses a blocking scheduler.

    Constructors in io.vertx.rx.java with parameters of type Vertx
    Constructor and Description
    `ContextScheduler(Vertx vertx, boolean blocking)`

  - ### Uses of Vertx in io.vertx.rxjava.core

    Methods in io.vertx.rxjava.core with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `void` | AbstractVerticle.`init(Vertx vertx, Context context)`
    `static Vertx` | Vertx.`newInstance(Vertx arg)`

    Constructors in io.vertx.rxjava.core with parameters of type Vertx
    Constructor and Description
    `Vertx(Vertx delegate)`

  - ### Uses of Vertx in io.vertx.spi.cluster.hazelcast

    Methods in io.vertx.spi.cluster.hazelcast with parameters of type Vertx
    Modifier and Type | Method and Description
    --- | ---
    `void` | HazelcastClusterManager.`setVertx(Vertx vertx)`

Copyright © 2015. All Rights Reserved.