Package | Description |
---|---|
io.vertx.core |
= Vert.x Core Manual
:toc: left
At the heart of Vert.x is a set of Java APIs that we call *Vert.x Core*
https://github.com/eclipse/vert.x[Repository].
|
io.vertx.core.buffer |
== Buffers
:toc: left
Most data is shuffled around inside Vert.x using buffers.
|
io.vertx.core.cli |
Vert.x Core provides an API for parsing command line arguments passed to programs.
|
io.vertx.core.datagram |
== Datagram sockets (UDP)
Using User Datagram Protocol (UDP) with Vert.x is a piece of cake.
|
io.vertx.core.dns |
== DNS client
Often you will find yourself in situations where you need to obtain DNS informations in an asynchronous fashion.
|
io.vertx.core.eventbus |
== The Event Bus
:toc: left
The
event bus is the *nervous system* of Vert.x. |
io.vertx.core.file |
== Using the file system with Vert.x
The Vert.x
FileSystem object provides many operations for manipulating the file system. |
io.vertx.core.http |
== Writing HTTP servers and clients
Vert.x allows you to easily write non blocking HTTP clients and servers.
|
io.vertx.core.json | |
io.vertx.core.metrics | |
io.vertx.core.net |
== Writing TCP servers and clients
Vert.x allows you to easily write non blocking TCP clients and servers.
|
Modifier and Type | Method and Description |
---|---|
JsonObject |
Context.config()
If the context is associated with a Verticle deployment, this returns the configuration that was specified when
the verticle was deployed.
|
JsonObject |
AbstractVerticle.config()
Get the configuration of the verticle.
|
JsonObject |
DeploymentOptions.getConfig()
Get the JSON configuration that will be passed to the verticle(s) when deployed.
|
JsonObject |
DeploymentOptions.toJson()
Convert this to JSON
|
Modifier and Type | Method and Description |
---|---|
void |
Launcher.afterConfigParsed(JsonObject config)
Hook for sub-classes of
Launcher after the config has been parsed. |
void |
DeploymentOptions.fromJson(JsonObject json)
Initialise the fields of this instance from the specified JSON
|
static void |
DeploymentOptionsConverter.fromJson(JsonObject json,
DeploymentOptions obj) |
static void |
VertxOptionsConverter.fromJson(JsonObject json,
VertxOptions obj) |
DeploymentOptions |
DeploymentOptions.setConfig(JsonObject config)
Set the JSON configuration that will be passed to the verticle(s) when it's deployed
|
static void |
DeploymentOptionsConverter.toJson(DeploymentOptions obj,
JsonObject json) |
static void |
VertxOptionsConverter.toJson(VertxOptions obj,
JsonObject json) |
Constructor and Description |
---|
DeploymentOptions(JsonObject json)
Constructor for creating a instance from JSON
|
VertxOptions(JsonObject json)
Create an instance from a
JsonObject |
Modifier and Type | Method and Description |
---|---|
JsonObject |
Buffer.toJsonObject()
Returns a Json object representation of the Buffer
|
Modifier and Type | Method and Description |
---|---|
JsonObject |
Option.toJson()
Gets the json representation of this
Option . |
JsonObject |
Argument.toJson()
Exports this
Argument to its corresponding JSON representation. |
Modifier and Type | Method and Description |
---|---|
static void |
ArgumentConverter.fromJson(JsonObject json,
Argument obj) |
static void |
OptionConverter.fromJson(JsonObject json,
Option obj) |
static void |
ArgumentConverter.toJson(Argument obj,
JsonObject json) |
static void |
OptionConverter.toJson(Option obj,
JsonObject json) |
Constructor and Description |
---|
Argument(JsonObject json)
Creates a new instance of
Argument from the given JSON object. |
Option(JsonObject json)
Creates a new instance of
Option from the given JsonObject |
Modifier and Type | Method and Description |
---|---|
static void |
DatagramSocketOptionsConverter.fromJson(JsonObject json,
DatagramSocketOptions obj) |
static void |
DatagramSocketOptionsConverter.toJson(DatagramSocketOptions obj,
JsonObject json) |
Constructor and Description |
---|
DatagramSocketOptions(JsonObject json)
Constructor to create options from JSON
|
Modifier and Type | Method and Description |
---|---|
JsonObject |
AddressResolverOptions.toJson() |
Modifier and Type | Method and Description |
---|---|
static void |
AddressResolverOptionsConverter.fromJson(JsonObject json,
AddressResolverOptions obj) |
static void |
AddressResolverOptionsConverter.toJson(AddressResolverOptions obj,
JsonObject json) |
Constructor and Description |
---|
AddressResolverOptions(JsonObject json) |
Modifier and Type | Method and Description |
---|---|
JsonObject |
EventBusOptions.toJson()
Builds a JSON object representing the current
EventBusOptions . |
Modifier and Type | Method and Description |
---|---|
static void |
EventBusOptionsConverter.fromJson(JsonObject json,
EventBusOptions obj) |
static void |
EventBusOptionsConverter.toJson(EventBusOptions obj,
JsonObject json) |
Constructor and Description |
---|
DeliveryOptions(JsonObject json)
Create a delivery options from JSON
|
EventBusOptions(JsonObject json)
Creates a new instance of
EventBusOptions from the JSON object. |
Modifier and Type | Method and Description |
---|---|
static void |
OpenOptionsConverter.fromJson(JsonObject json,
OpenOptions obj) |
static void |
OpenOptionsConverter.toJson(OpenOptions obj,
JsonObject json) |
Constructor and Description |
---|
OpenOptions(JsonObject json)
Constructor to create options from JSON
|
Modifier and Type | Method and Description |
---|---|
JsonObject |
HttpServerOptions.toJson()
Convert to JSON
|
JsonObject |
HttpClientOptions.toJson()
Convert to JSON
|
JsonObject |
Http2Settings.toJson() |
JsonObject |
GoAway.toJson() |
Modifier and Type | Method and Description |
---|---|
static void |
GoAwayConverter.fromJson(JsonObject json,
GoAway obj) |
static void |
Http2SettingsConverter.fromJson(JsonObject json,
Http2Settings obj) |
static void |
HttpClientOptionsConverter.fromJson(JsonObject json,
HttpClientOptions obj) |
static void |
HttpServerOptionsConverter.fromJson(JsonObject json,
HttpServerOptions obj) |
static void |
GoAwayConverter.toJson(GoAway obj,
JsonObject json) |
static void |
Http2SettingsConverter.toJson(Http2Settings obj,
JsonObject json) |
static void |
HttpClientOptionsConverter.toJson(HttpClientOptions obj,
JsonObject json) |
static void |
HttpServerOptionsConverter.toJson(HttpServerOptions obj,
JsonObject json) |
Constructor and Description |
---|
GoAway(JsonObject json) |
Http2Settings(JsonObject json)
Create an settings from JSON
|
HttpClientOptions(JsonObject json)
Constructor to create an options from JSON
|
HttpServerOptions(JsonObject json)
Create an options from JSON
|
RequestOptions(JsonObject json)
Create options from JSON
|
Modifier and Type | Method and Description |
---|---|
JsonObject |
JsonObject.clear()
Remove all the entries in this JSON object
|
JsonObject |
JsonObject.copy()
Copy the JSON object
|
JsonObject |
JsonArray.getJsonObject(int pos)
Get the JsonObject at position
pos in the array. |
JsonObject |
JsonObject.getJsonObject(String key)
Get the JsonObject value with the specified key
|
JsonObject |
JsonObject.getJsonObject(String key,
JsonObject def)
Like
getJsonObject(String) but specifying a default value to return if there is no entry. |
static JsonObject |
JsonObject.mapFrom(Object obj)
Create a JsonObject from the fields of a Java object.
|
JsonObject |
JsonObject.mergeIn(JsonObject other)
Merge in another JSON object.
|
JsonObject |
JsonObject.mergeIn(JsonObject other,
boolean deep)
Merge in another JSON object.
|
JsonObject |
JsonObject.mergeIn(JsonObject other,
int depth)
Merge in another JSON object.
|
JsonObject |
JsonObject.put(String key,
Boolean value)
Put a Boolean into the JSON object with the specified key.
|
JsonObject |
JsonObject.put(String key,
byte[] value)
Put a byte[] into the JSON object with the specified key.
|
JsonObject |
JsonObject.put(String key,
CharSequence value)
Put an CharSequence into the JSON object with the specified key.
|
JsonObject |
JsonObject.put(String key,
Double value)
Put a Double into the JSON object with the specified key.
|
JsonObject |
JsonObject.put(String key,
Enum value)
Put an Enum into the JSON object with the specified key.
|
JsonObject |
JsonObject.put(String key,
Float value)
Put a Float into the JSON object with the specified key.
|
JsonObject |
JsonObject.put(String key,
Instant value)
Put a Instant into the JSON object with the specified key.
|
JsonObject |
JsonObject.put(String key,
Integer value)
Put an Integer into the JSON object with the specified key.
|
JsonObject |
JsonObject.put(String key,
JsonArray value)
Put a JSON array into the JSON object with the specified key.
|
JsonObject |
JsonObject.put(String key,
JsonObject value)
Put another JSON object into the JSON object with the specified key.
|
JsonObject |
JsonObject.put(String key,
Long value)
Put a Long into the JSON object with the specified key.
|
JsonObject |
JsonObject.put(String key,
Object value)
Put an Object into the JSON object with the specified key.
|
JsonObject |
JsonObject.put(String key,
String value)
Put a String into the JSON object with the specified key.
|
JsonObject |
JsonObject.putNull(String key)
Put a null value into the JSON object with the specified key.
|
Modifier and Type | Method and Description |
---|---|
JsonArray |
JsonArray.add(JsonObject value)
Add a JSON object to the JSON array.
|
JsonObject |
JsonObject.getJsonObject(String key,
JsonObject def)
Like
getJsonObject(String) but specifying a default value to return if there is no entry. |
JsonObject |
JsonObject.mergeIn(JsonObject other)
Merge in another JSON object.
|
JsonObject |
JsonObject.mergeIn(JsonObject other,
boolean deep)
Merge in another JSON object.
|
JsonObject |
JsonObject.mergeIn(JsonObject other,
int depth)
Merge in another JSON object.
|
JsonObject |
JsonObject.put(String key,
JsonObject value)
Put another JSON object into the JSON object with the specified key.
|
Modifier and Type | Method and Description |
---|---|
JsonObject |
MetricsOptions.toJson() |
Modifier and Type | Method and Description |
---|---|
static void |
MetricsOptionsConverter.fromJson(JsonObject json,
MetricsOptions obj) |
static void |
MetricsOptionsConverter.toJson(MetricsOptions obj,
JsonObject json) |
Constructor and Description |
---|
MetricsOptions(JsonObject json)
Create an instance from a
JsonObject |
Modifier and Type | Method and Description |
---|---|
JsonObject |
TCPSSLOptions.toJson()
Convert to JSON
|
JsonObject |
ProxyOptions.toJson()
Convert to JSON
|
JsonObject |
PfxOptions.toJson()
Convert to JSON
|
JsonObject |
PemTrustOptions.toJson()
Convert to JSON
|
JsonObject |
PemKeyCertOptions.toJson()
Convert to JSON
|
JsonObject |
OpenSSLEngineOptions.toJson() |
JsonObject |
NetworkOptions.toJson()
Convert to JSON
|
JsonObject |
NetServerOptions.toJson()
Convert to JSON
|
JsonObject |
JksOptions.toJson()
Convert to JSON
|
JsonObject |
JdkSSLEngineOptions.toJson() |
JsonObject |
ClientOptionsBase.toJson()
Convert to JSON
|
Modifier and Type | Method and Description |
---|---|
static void |
ClientOptionsBaseConverter.fromJson(JsonObject json,
ClientOptionsBase obj) |
static void |
JksOptionsConverter.fromJson(JsonObject json,
JksOptions obj) |
static void |
NetClientOptionsConverter.fromJson(JsonObject json,
NetClientOptions obj) |
static void |
NetServerOptionsConverter.fromJson(JsonObject json,
NetServerOptions obj) |
static void |
NetworkOptionsConverter.fromJson(JsonObject json,
NetworkOptions obj) |
static void |
OpenSSLEngineOptionsConverter.fromJson(JsonObject json,
OpenSSLEngineOptions obj) |
static void |
PemKeyCertOptionsConverter.fromJson(JsonObject json,
PemKeyCertOptions obj) |
static void |
PemTrustOptionsConverter.fromJson(JsonObject json,
PemTrustOptions obj) |
static void |
PfxOptionsConverter.fromJson(JsonObject json,
PfxOptions obj) |
static void |
ProxyOptionsConverter.fromJson(JsonObject json,
ProxyOptions obj) |
static void |
TCPSSLOptionsConverter.fromJson(JsonObject json,
TCPSSLOptions obj) |
static void |
ClientOptionsBaseConverter.toJson(ClientOptionsBase obj,
JsonObject json) |
static void |
JksOptionsConverter.toJson(JksOptions obj,
JsonObject json) |
static void |
NetClientOptionsConverter.toJson(NetClientOptions obj,
JsonObject json) |
static void |
NetServerOptionsConverter.toJson(NetServerOptions obj,
JsonObject json) |
static void |
NetworkOptionsConverter.toJson(NetworkOptions obj,
JsonObject json) |
static void |
OpenSSLEngineOptionsConverter.toJson(OpenSSLEngineOptions obj,
JsonObject json) |
static void |
PemKeyCertOptionsConverter.toJson(PemKeyCertOptions obj,
JsonObject json) |
static void |
PemTrustOptionsConverter.toJson(PemTrustOptions obj,
JsonObject json) |
static void |
PfxOptionsConverter.toJson(PfxOptions obj,
JsonObject json) |
static void |
ProxyOptionsConverter.toJson(ProxyOptions obj,
JsonObject json) |
static void |
TCPSSLOptionsConverter.toJson(TCPSSLOptions obj,
JsonObject json) |
Constructor and Description |
---|
ClientOptionsBase(JsonObject json)
Create options from some JSON
|
JdkSSLEngineOptions(JsonObject json) |
JksOptions(JsonObject json)
Create options from JSON
|
NetClientOptions(JsonObject json)
Create options from JSON
|
NetServerOptions(JsonObject json)
Create some options from JSON
|
NetworkOptions(JsonObject json)
Constructor from JSON
|
OpenSSLEngineOptions(JsonObject json) |
PemKeyCertOptions(JsonObject json)
Create options from JSON
|
PemTrustOptions(JsonObject json)
Create options from JSON
|
PfxOptions(JsonObject json)
Create options from JSON
|
ProxyOptions(JsonObject json)
Create options from JSON.
|
TCPSSLOptions(JsonObject json)
Create options from JSON
|
Copyright © 2017. All rights reserved.