All Classes and Interfaces
Class
Description
WARNING : this class is not deprecated, however we encourage instead to use
VerticleBase
An abstract base class that you can extend to write your own Verticle classes.Defines the access mode of a context local storage.
A general purpose networking address.
A provider for address resolver.
Configuration options for Vert.x hostname resolver.
Converter and mapper for
AddressResolverOptions.Represents a file on the file-system which can be read from, or written to asynchronously.
A lock on a region of an
AsyncFile.An asynchronous map.
Encapsulates the result of an asynchronous operation.
Most data is shuffled around inside Vert.x using buffers.
Configures the engine to require/request client authentication.
A form: a container for attributes.
The client metrics SPI that Vert.x will use to call when client events occur.
A multipart form, providing file upload capabilities.
Base class for Client options
Converter and mapper for
ClientOptionsBase.HTTP client HTTP redirect config.
Configuration of a client resolver, the resolver translates a logical address into a socket address and a port.
Client SSL options.
Converter and mapper for
ClientSSLOptions.Represents a client-side WebSocket.
A closeable resource.
View of a clustered node.
A cluster provider for Vert.x must implement this interface.
A view of something that can be completed with a success or failure.
The composite future wraps a list of
futures, it is useful when several futures
needs to be coordinated.HTTP compression configuration.
Represents a failure to add a HttpClientRequest to the wait queue on an ConnectionManager.
Options for configuring how to connect to a TCP server.
The execution context of a
Handler execution.A local storage for arbitrary data attached to a
Context.Represents an HTTP Cookie.
Represents the Cookie SameSite policy to be used.
Describes the copy (and move) options.
Converter and mapper for
CopyOptions.An asynchronous counter that can be used to across the cluster to maintain a consistent count.
A received datagram packet (UDP) which contains the data and information about the sender of the data itself.
A datagram socket can be used to send
DatagramPacket's to remote datagram servers
and receive DatagramPackets .The datagram/udp metrics SPI which Vert.x will use to call when each event occurs pertaining to datagram sockets.
Options used to configure a datagram socket.
Converter and mapper for
DatagramSocketOptions.Instances of this Exception are thrown if failed to decode a JSON string, because of invalid JSON.
Carries request/response latencies.
Default interaction metrics.
The default implementation of
SslContextFactory that creates and configures a Netty SslContext using a
SslContextBuilder.Encapsulates a message being delivered by Vert.x as well as providing control over the message delivery.
Delivery options are used to configure message delivery.
Base interface for reactive services written in Java deployed in a Vert.x instance
Options for configuring a verticle deployment.
Converter and mapper for
DeploymentOptions.Provides a way to asynchronously lookup information from DNS servers.
Configuration options for Vert.x DNS client.
Converter and mapper for
DnsClientOptions.Exception which is used to notify the
AsyncResult
if the DNS query returns a DnsResponseCode which indicates and error.Represents the possible response codes a server may send after receiving a
query.
A builder for an endpoint.
Configuration of an endpoint.
A resolver for endpoints.
Endpoint resolver Service Provider Interface (SPI).
A Vert.x event-bus is a light-weight distributed messaging system which allows different parts of your application,
or different applications and services to communicate with each in a loosely coupled way.
The event bus metrics SPI which Vert.x will use to call when each event occurs.
Options to configure the event bus.
Converter and mapper for
EventBusOptions.Event executor service provider interface.
The interface for a factory used to obtain an external
ExecutorService.An expectation, very much like a predicate with the ability to provide a meaningful description of the failure.
Represents properties of a file on the file system.
Sometimes the file resources of an application are bundled into jars, or are somewhere on the classpath but not
available on the file system, e.g. in the case of a Vert.x webapp bundled as a fat jar.
A factory for the pluggable file resolver SPI.
Contains a broad set of operations for manipulating files on the file system.
Exception thrown by the FileSystem class
Vert.x file system base configuration, this class can be extended by provider implementations to configure
those specific implementations.
Converter and mapper for
FileSystemOptions.Represents properties of the file system.
Form decoder configuration.
Represents the result of an action that may, or may not, have occurred yet.
A GOAWAY frame.
Converter and mapper for
GoAway.A generic event handler.
A combination of host and port.
HTTP/1.x client configuration.
HTTP/1.x server configuration.
HTTP/2 client configuration.
HTTP/2 server configuration.
HTTP2 settings, the settings is initialized with the default HTTP/2 values.
Converter and mapper for
Http2Settings.HTTP/3 client configuration.
HTTP/3 server configuration.
HTTP/3 settings, the settings is initialized with the default HTTP/3 values.
The API to interacts with an HTTP server.
An asynchronous HTTP client.
A builder for
HttpClient.Configuration of a
HttpClientRepresents an HTTP client connection.
The http client metrics SPI that Vert.x will use to call when http client events occur.
Options describing how an
HttpClient will make connections.Converter and mapper for
HttpClientOptions.Represents a client-side HTTP request.
Represents a client-side HTTP response.
Signals a HTTP connection close.
Represents an HTTP connection.
Options describing how an
HttpClient will connect to a server.Converter and mapper for
HttpConnectOptions.An HTTP/2 frame.
Contains a bunch of useful HTTP headers stuff:
methods for creating
MultiMap instances
often used Header names
method to create optimized CharSequence which can be used as header name and value
Represents an HTTP method.
Subset of ALPN protocol ID
for HTTP applications.
An HTTP request.
The state of the HTTP request head:
Method / URI
Headers
An HTTP response.
Common expectations for HTTP responses.
The state of the HTTP response head:
Status code / Message
Headers
An HTTP and WebSockets server.
A builder for
HttpServer.Configuration of a
HttpServerRepresents an file upload from an HTML FORM.
The http server metrics SPI that Vert.x will use to call when each http server event occurs.
Represents options used by an
HttpServer instanceConverter and mapper for
HttpServerOptions.Represents a server-side HTTP request.
Represents a server-side HTTP response.
An HTTP setting.
Base container for HTTP settings.
Represents the version of the HTTP protocol.
This is a custom implementation of the Jackson's
RecyclerPool intended to work equally well with both
platform and virtual threads.Gather metrics for a request/response interaction with the server, this interface is write-only and used to report
usage to build statistics for a load balancing purpose.
Configures a
TCPSSLOptions to use the JDK ssl engine implementation.Converter and mapper for
JdkSSLEngineOptions.Key or trust store options configuring private key and/or certificates based on Java Keystore files.
Converter and mapper for
JksOptions.A representation of a JSON array in Java.
A JSON event emitted by the
JsonParser.The possibles types of
JsonEvent emitted by the JsonParser.A factory for the plug-able json SPI.
A representation of a JSON object in Java.
A parser class which allows to incrementally parse json elements and emit json parse events instead of parsing a json
element fully.
Implementation of RFC6901 Json Pointers.
The JsonPointerIterator is used by the read/write algorithms of the
Every method takes the currentValue as parameter, representing the actual value held by the query algorithm.
Implementations of this interface should be stateless, so they can be reused
You can implement this interface to query the structure you want using json pointers
JsonPointer to read/write the querying data structure Every method takes the currentValue as parameter, representing the actual value held by the query algorithm.
Implementations of this interface should be stateless, so they can be reused
You can implement this interface to query the structure you want using json pointers
Key/cert configuration options.
Key or trust store options configuring private key and/or certificates based on
KeyStore.Base class of
KeyStore based options.Converter and mapper for
KeyStoreOptions.A load balancer.
Local maps can be used to share data safely in a single Vert.x instance.
An asynchronous exclusive lock which can be obtained from any node in the cluster.
Generic purpose logging of network operations configuration.
Represents a message that is received from the event bus in a handler.
A message codec allows a custom message type to be marshalled across the event bus.
An event bus consumer object representing a stream of message to an
EventBus address that can
be read from.Options configuring the behavior of a event-bus message consumer.
Converter and mapper for
MessageConsumerOptions.Represents a stream of message that can be written to.
The metrics interface is implemented by metrics providers that wants to provide monitoring of
Vert.x core.
Vert.x metrics base configuration, this class can be extended by provider implementations to configure
those specific implementations.
Converter and mapper for
MetricsOptions.Metrics provider is the base SPI used by metrics implementations to retrieve a
Metrics
object.We do our own mapping since support for mime mapping in Java is platform dependent
and doesn't seem to work very well
This class represents a MultiMap of String keys to a List of String values.
Represent a Mail-Exchange-Record (MX) which was resolved for a domain.
A TCP client.
Options for configuring a
NetClient.Converter and mapper for
NetClientOptions.Represents a TCP server
Options for configuring a
NetServer.Converter and mapper for
NetServerOptions.Represents a socket-like interface to a TCP connection on either the
client or the server side.
An SPI used internally by Vert.x to gather metrics on a net socket which serves
as a base class for TCP, UDP or QUIC.
Details about a clustered Vert.x node.
A NodeListener is called when nodes join or leave the cluster
Generic client/server observability config.
Describes how an
AsyncFile should be opened.Converter and mapper for
OpenOptions.Configures a
TCPSSLOptions to use OpenSsl.Converter and mapper for
OpenSSLEngineOptions.Key store options configuring a list of private key and its certificate based on
Privacy-enhanced Electronic Email (PEM) files.
Converter and mapper for
PemKeyCertOptions.Certificate Authority options configuring certificates based on
Privacy-enhanced Electronic Email (PEM) files.
Converter and mapper for
PemTrustOptions.Key or trust store options configuring private key and/or certificates based on PKCS#12 files.
Converter and mapper for
PfxOptions.Pipe data from a
ReadStream to a WriteStream and performs flow control where necessary to
prevent the write stream buffer from getting overfull.Worker pool metrics
Options configuring a
HttpClient pool.Converter and mapper for
PoolOptions.Policy for enforcing post-quantum cryptography (PQC) key exchange.
Represents the writable side of an action that may, or may not, have occurred yet.
Proxy options for a net client or a net client.
Converter and mapper for
ProxyOptions.The type of a TCP proxy server.
QLog configuration.
Query parameter decoder configuration.
A Quic client.
Quic client address validation on the server.
Configuration of a Quic client.
Quic transport options.
A Quic connection between a client and a server, providing support for handling or creating Quic
streamsDetails of a Quic connection close.
Options for configuring how to connect to a QUIC server.
QUIC datagram configuration.
Represents a Quic endpoints, whose primary function is to bind a UDP socket on a given or random port.
Configuration of a Quic client.
A Quic server.
Configuration of a Quic server.
Implementation of
SslContextFactory that creates and configures a Netty QuicSslContext using a
QuicSslContextBuilder.A Quic stream.
Quic transport parameters.
Represents a stream of items that can be read from.
A helper class which allows you to easily parse protocols which are delimited by a sequence of bytes, or fixed
size records.
Registration data stored by the cluster manager.
Registration listener used by the cluster manager to keep the clustered event bus updated with the registration changes.
Event fired by the
ClusterManager when messaging handler registrations are added or removed.Represents the failure of a message send.
Represents the type of reply failure
Options describing how an
HttpClient will connect to make a request.Converter and mapper for
RequestOptions.Deprecated, for removal: This API element is subject to removal in a future version.
this class does not work reliably and consistently on stock Java distributions
A physical server of an endpoint.
Request interaction with an endpoint, mostly callbacks to gather statistics.
Select the most appropriate server among the list of servers of an endpoint.
Server SSL options.
Converter and mapper for
ServerSSLOptions.Represents a server side WebSocket.
A server WebSocket handshake, allows to control acceptance or rejection of a WebSocket.
An interface which allows you to put arbitrary objects into a
LocalMap.Shared data allows you to share data safely between different parts of your application in a safe way.
The address of a socket, an inet socket address or a domain socket address.
Represent a Service-Record (SRV) which was resolved for a domain.
A factory for a Netty
SslContext, the factory is configured with the fluent setters until SslContextFactory.create()
to obtain a properly configured SslContext.The SSL engine implementation to use in a Vert.x server or client.
Client/Server SSL options.
Converter and mapper for
SSLOptions.Base interface for a stream.
Represents a channel interface modelling a duplex flow controlled byte oriented stream.
This class represents HTTP/2 stream priority defined in RFC 7540 clause 5.3
This exception signals a stream reset, it is used only for HTTP/2.
This provides an utility for extracting request/response tags, potentially allocation-free.
Configuration of a
NetClientShould this be
TcpConfig instead ?Deprecated, for removal: This API element is subject to removal in a future version.
instead use
TransportMetricsGeneric TCP configuration option.
Configuration of a
NetServerBase class.
Converter and mapper for
TCPSSLOptions.The threading model defines the scheduler to execute context tasks.
A timer task that can be used as a future.
Vert.x tracing base configuration, this class can be extended by provider implementations to configure
those specific implementations.
Converter and mapper for
TracingOptions.Policy controlling the behavior across boundaries.
Options describing how
GlobalTrafficShapingHandler will handle traffic shaping.Converter and mapper for
TrafficShapingOptions.The transport used by a
Vertx instance.The transport used by a
Vertx instance.An SPI used internally by Vert.x to gather metrics on a socket transport which serves
as a base class for things like HttpServer and HttpClient, all of which serve connections.
Certification authority configuration options.
WARNING : this class is not deprecated, however we encourage instead to use
VerticleBase
A verticle is a piece of code that can be deployed by Vert.x.An abstract base class that you can extend to write your own Verticle classes.
Has responsibility for creating verticle instances.
The entry point into the Vert.x Core API.
A builder for creating Vert.x instances, allowing to configure Vert.x plugins:
metrics
tracing
cluster manager
Example usage:
The main Vert.x metrics SPI which Vert.x will use internally.
A factory for the plugable metrics SPI.
A Jackson
Module to provide following VertX Serializers and Deserializers
that can be reused for building custom mappers :
JsonObjectSerializer of JsonObject
JsonArraySerializer of JsonArray
JsonArrayDeserializer of JsonArray
JsonObjectDeserializer of JsonObject
InstantSerializer and InstantDeserializer of Instant
ByteArraySerializer and ByteArraySerializer of byte[]
BufferSerializer and BufferSerializer of Buffer
Instances of this class are used to configure
Vertx instances.Converter and mapper for
VertxOptions.Entry point for loading Vert.x SPI implementations.
The tracer SPI used by Vert.x components to report activities.
A factory for the plug-able tracing SPI.
Common WebSocket implementation.
Base WebSocket implementation.
An asynchronous WebSocket client.
Converter and mapper for
WebSocketClientOptions.Options describing how an
HttpClient connect a WebSocket.Converter and mapper for
WebSocketConnectOptions.A WebSocket frame that represents either text or binary data.
List of all frame types.
WebSocket metrics.
WebSocket server configuration.
Represents the WebSocket version
An executor for executing blocking code in Vert.x .
Represents a stream of data that can be written to.