All Classes

Class	Description
AbstractVerticle	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.
AccessMode	Defines the access mode of a context local storage.
Address	A general purpose networking address.
AddressResolver<A extends Address>	A provider for address resolver.
AddressResolverOptions	Configuration options for Vert.x hostname resolver.
AddressResolverOptionsConverter	Converter and mapper for AddressResolverOptions.
AddressResolverProvider
AsyncFile	Represents a file on the file-system which can be read from, or written to asynchronously.
AsyncFileLock	A lock on a region of an AsyncFile.
AsyncMap<K,V>	An asynchronous map.
AsyncResult<T>	Encapsulates the result of an asynchronous operation.
Buffer	Most data is shuffled around inside Vert.x using buffers.
ClientAuth	Configures the engine to require/request client authentication.
ClientForm	A form: a container for attributes.
ClientMetrics<M,Req,Resp>	The client metrics SPI that Vert.x will use to call when client events occur.
ClientMultipartForm	A multipart form, providing file upload capabilities.
ClientOptionsBase	Base class for Client options
ClientOptionsBaseConverter	Converter and mapper for ClientOptionsBase.
ClientSSLOptions	Client SSL options.
ClientSSLOptionsConverter	Converter and mapper for ClientSSLOptions.
ClientWebSocket	Represents a client-side WebSocket.
Closeable	A closeable resource.
ClusteredNode	View of a clustered node.
ClusterManager	A cluster provider for Vert.x must implement this interface.
ClusterSerializable	Objects implementing this interface will be written to and read from a Buffer when: stored in and read from an AsyncMap, or encodec to and decoded from an EventBus message body
Completable<T>	A view of something that can be completed with a success or failure.
CompositeFuture	The composite future wraps a list of futures, it is useful when several futures needs to be coordinated.
ConnectionPoolTooBusyException	Represents a failure to add a HttpClientRequest to the wait queue on an ConnectionManager.
ConnectOptions	Options for configuring how to connect to a TCP server.
Context	The execution context of a Handler execution.
ContextLocal<T>	A local storage for arbitrary data attached to a Context.
Cookie	Represents an HTTP Cookie.
CookieSameSite	Represents the Cookie SameSite policy to be used.
CopyOptions	Describes the copy (and move) options.
CopyOptionsConverter	Converter and mapper for CopyOptions.
Counter	An asynchronous counter that can be used to across the cluster to maintain a consistent count.
DatabindCodec
DatagramPacket	A received datagram packet (UDP) which contains the data and information about the sender of the data itself.
DatagramSocket	A datagram socket can be used to send DatagramPacket's to remote datagram servers and receive DatagramPackets .
DatagramSocketMetrics	The datagram/udp metrics SPI which Vert.x will use to call when each event occurs pertaining to datagram sockets.
DatagramSocketOptions	Options used to configure a datagram socket.
DatagramSocketOptionsConverter	Converter and mapper for DatagramSocketOptions.
DecodeException	Instances of this Exception are thrown if failed to decode a JSON string, because of invalid JSON.
DefaultInteractionMetric	Carries request/response latencies.
DefaultInteractionMetrics	Default interaction metrics.
DefaultSslContextFactory	The default implementation of SslContextFactory that creates and configures a Netty SslContext using a SslContextBuilder.
DeliveryContext<T>	Encapsulates a message being delivered by Vert.x as well as providing control over the message delivery.
DeliveryOptions	Delivery options are used to configure message delivery.
Deployable	Base interface for reactive services written in Java deployed in a Vert.x instance
DeploymentOptions	Options for configuring a verticle deployment.
DeploymentOptionsConverter	Converter and mapper for DeploymentOptions.
DnsClient	Provides a way to asynchronously lookup information from DNS servers.
DnsClientOptions	Configuration options for Vert.x DNS client.
DnsClientOptionsConverter	Converter and mapper for DnsClientOptions.
DnsException	Exception which is used to notify the AsyncResult if the DNS query returns a DnsResponseCode which indicates and error.
DnsResponseCode	Represents the possible response codes a server may send after receiving a query.
EncodeException
Endpoint
EndpointBuilder<E,S>	A builder for an endpoint.
EndpointResolver	A resolver for endpoints.
EndpointResolver<A extends Address,S,D,E>	Endpoint resolver Service Provider Interface (SPI).
EventBus	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.
EventBusMetrics<H>	The event bus metrics SPI which Vert.x will use to call when each event occurs.
EventBusOptions	Options to configure the event bus.
EventBusOptionsConverter	Converter and mapper for EventBusOptions.
EventExecutorProvider	Event executor service provider interface.
ExecutorServiceFactory	The interface for a factory used to obtain an external ExecutorService.
Expectation<V>	An expectation, very much like a predicate with the ability to provide a meaningful description of the failure.
FileProps	Represents properties of a file on the file system.
FileResolver	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.
FileResolverFactory	A factory for the pluggable file resolver SPI.
FileSystem	Contains a broad set of operations for manipulating files on the file system.
FileSystemException	Exception thrown by the FileSystem class
FileSystemOptions	Vert.x file system base configuration, this class can be extended by provider implementations to configure those specific implementations.
FileSystemOptionsConverter	Converter and mapper for FileSystemOptions.
FileSystemProps	Represents properties of the file system.
Future<T>	Represents the result of an action that may, or may not, have occurred yet.
GoAway	A GOAWAY frame.
GoAwayConverter	Converter and mapper for GoAway.
Handler<E>	A generic event handler.
HostAndPort	A combination of host and port.
Http2Settings	HTTP2 settings, the settings is initialized with the default HTTP/2 values.
Http2SettingsConverter	Converter and mapper for Http2Settings.
HttpClient	The API to interacts with an HTTP server.
HttpClientAgent	An asynchronous HTTP client.
HttpClientBuilder	A builder for HttpClient.
HttpClientConnection	Represents an HTTP client connection.
HttpClientMetrics<R,W,S>	The http client metrics SPI that Vert.x will use to call when http client events occur.
HttpClientOptions	Options describing how an HttpClient will make connections.
HttpClientOptionsConverter	Converter and mapper for HttpClientOptions.
HttpClientRequest	Represents a client-side HTTP request.
HttpClientResponse	Represents a client-side HTTP response.
HttpClosedException	Signals a HTTP connection close.
HttpConnection	Represents an HTTP connection.
HttpConnectOptions	Options describing how an HttpClient will connect to a server.
HttpConnectOptionsConverter	Converter and mapper for HttpConnectOptions.
HttpFrame	An HTTP/2 frame.
HttpHeaders	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
HttpMethod	Represents an HTTP method.
HttpRequest	An HTTP request.
HttpRequestHead	The state of the HTTP request head: Method / URI Headers
HttpResponse	An HTTP response.
HttpResponseExpectation	Common expectations for HTTP responses.
HttpResponseHead	The state of the HTTP response head: Status code / Message Headers
HttpServer	An HTTP and WebSockets server.
HttpServerFileUpload	Represents an file upload from an HTML FORM.
HttpServerMetrics<R,W,S>	The http server metrics SPI that Vert.x will use to call when each http server event occurs.
HttpServerOptions	Represents options used by an HttpServer instance
HttpServerOptionsConverter	Converter and mapper for HttpServerOptions.
HttpServerRequest	Represents a server-side HTTP request.
HttpServerResponse	Represents a server-side HTTP response.
HttpVersion	Represents the version of the HTTP protocol.
HybridJacksonPool	This is a custom implementation of the Jackson's RecyclerPool intended to work equally well with both platform and virtual threads.
HybridJacksonPool.StripedLockFreePool
InteractionMetrics<M>	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.
JacksonCodec
JacksonFactory
JdkSSLEngineOptions	Configures a TCPSSLOptions to use the JDK ssl engine implementation.
JksOptions	Key or trust store options configuring private key and/or certificates based on Java Keystore files.
JksOptionsConverter	Converter and mapper for JksOptions.
Json
JsonArray	A representation of a JSON array in Java.
JsonCodec
JsonEvent	A JSON event emitted by the JsonParser.
JsonEventType	The possibles types of JsonEvent emitted by the JsonParser.
JsonFactory	A factory for the plug-able json SPI.
JsonObject	A representation of a JSON object in Java.
JsonParser	A parser class which allows to incrementally parse json elements and emit json parse events instead of parsing a json element fully.
JsonPointer	Implementation of RFC6901 Json Pointers.
JsonPointerIterator	The JsonPointerIterator is used by the read/write algorithms of the 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
KeyCertOptions	Key/cert configuration options.
KeyStoreOptions	Key or trust store options configuring private key and/or certificates based on KeyStore.
KeyStoreOptionsBase	Base class of KeyStore based options.
KeyStoreOptionsConverter	Converter and mapper for KeyStoreOptions.
LoadBalancer	A load balancer.
LocalMap<K,V>	Local maps can be used to share data safely in a single Vert.x instance.
Lock	An asynchronous exclusive lock which can be obtained from any node in the cluster.
Measured
Message<T>	Represents a message that is received from the event bus in a handler.
MessageCodec<S,R>	A message codec allows a custom message type to be marshalled across the event bus.
MessageConsumer<T>	An event bus consumer object representing a stream of message to an EventBus address that can be read from.
MessageConsumerOptions	Options configuring the behavior of a event-bus message consumer.
MessageConsumerOptionsConverter	Converter and mapper for MessageConsumerOptions.
MessageProducer<T>	Represents a stream of message that can be written to.
Metrics	The metrics interface is implemented by metrics providers that wants to provide monitoring of Vert.x core.
MetricsOptions	Vert.x metrics base configuration, this class can be extended by provider implementations to configure those specific implementations.
MetricsOptionsConverter	Converter and mapper for MetricsOptions.
MetricsProvider	Metrics provider is the base SPI used by metrics implementations to retrieve a Metrics object.
MimeMapping	We do our own mapping since support for mime mapping in Java is platform dependent and doesn't seem to work very well
MultiMap	This class represents a MultiMap of String keys to a List of String values.
MxRecord	Represent a Mail-Exchange-Record (MX) which was resolved for a domain.
NetClient	A TCP client.
NetClientOptions	Options for configuring a NetClient.
NetClientOptionsConverter	Converter and mapper for NetClientOptions.
NetServer	Represents a TCP server
NetServerOptions	Options for configuring a NetServer.
NetServerOptionsConverter	Converter and mapper for NetServerOptions.
NetSocket	Represents a socket-like interface to a TCP connection on either the client or the server side.
NetworkMetrics<S>	An SPI used internally by Vert.x to gather metrics on a net socket which serves as a base class for TCP or UDP.
NetworkOptions
NetworkOptionsConverter	Converter and mapper for NetworkOptions.
NodeInfo	Details about a clustered Vert.x node.
NodeListener	A NodeListener is called when nodes join or leave the cluster
OpenOptions	Describes how an AsyncFile should be opened.
OpenOptionsConverter	Converter and mapper for OpenOptions.
OpenSSLEngineOptions	Configures a TCPSSLOptions to use OpenSsl.
OpenSSLEngineOptionsConverter	Converter and mapper for OpenSSLEngineOptions.
PemKeyCertOptions	Key store options configuring a list of private key and its certificate based on Privacy-enhanced Electronic Email (PEM) files.
PemKeyCertOptionsConverter	Converter and mapper for PemKeyCertOptions.
PemTrustOptions	Certificate Authority options configuring certificates based on Privacy-enhanced Electronic Email (PEM) files.
PemTrustOptionsConverter	Converter and mapper for PemTrustOptions.
PfxOptions	Key or trust store options configuring private key and/or certificates based on PKCS#12 files.
PfxOptionsConverter	Converter and mapper for PfxOptions.
Pipe<T>	Pipe data from a ReadStream to a WriteStream and performs flow control where necessary to prevent the write stream buffer from getting overfull.
PoolMetrics<Q,T>	Worker pool metrics
PoolOptions	Options configuring a HttpClient pool.
PoolOptionsConverter	Converter and mapper for PoolOptions.
Promise<T>	Represents the writable side of an action that may, or may not, have occurred yet.
ProxyOptions	Proxy options for a net client or a net client.
ProxyOptionsConverter	Converter and mapper for ProxyOptions.
ProxyType	The type of a TCP proxy server.
ReadStream<T>	Represents a stream of items that can be read from.
RecordParser	A helper class which allows you to easily parse protocols which are delimited by a sequence of bytes, or fixed size records.
RegistrationInfo	Registration data stored by the cluster manager.
RegistrationListener	Registration listener used by the cluster manager to keep the clustered event bus updated with the registration changes.
RegistrationUpdateEvent	Event fired by the ClusterManager when messaging handler registrations are added or removed.
ReplyException	Represents the failure of a message send.
ReplyFailure	Represents the type of reply failure
RequestOptions	Options describing how an HttpClient will connect to make a request.
RequestOptionsConverter	Converter and mapper for RequestOptions.
SelfSignedCertificate	A self-signed certificate helper for testing and development purposes.
ServerEndpoint	A physical server of an endpoint.
ServerInteraction	Request interaction with an endpoint, mostly callbacks to gather statistics.
ServerSelector	Select the most appropriate server among the list of servers of an endpoint.
ServerSSLOptions	Server SSL options.
ServerSSLOptionsConverter	Converter and mapper for ServerSSLOptions.
ServerWebSocket	Represents a server side WebSocket.
ServerWebSocketHandshake	A server WebSocket handshake, allows to control acceptance or rejection of a WebSocket.
Shareable	An interface which allows you to put arbitrary objects into a LocalMap.
SharedData	Shared data allows you to share data safely between different parts of your application in a safe way.
SocketAddress	The address of a socket, an inet socket address or a domain socket address.
SpanKind
SrvRecord	Represent a Service-Record (SRV) which was resolved for a domain.
SslContextFactory	A factory for a Netty SslContext, the factory is configured with the fluent setters until SslContextFactory.create() to obtain a properly configured SslContext.
SSLEngineOptions	The SSL engine implementation to use in a Vert.x server or client.
SSLOptions	Client/Server SSL options.
SSLOptionsConverter	Converter and mapper for SSLOptions.
StreamBase	Base interface for a stream.
StreamPriority	This class represents HTTP/2 stream priority defined in RFC 7540 clause 5.3
StreamResetException	This exception signals a stream reset, it is used only for HTTP/2.
TagExtractor<T>	This provides an utility for extracting request/response tags, potentially allocation-free.
TCPMetrics<S>	An SPI used internally by Vert.x to gather metrics on a net socket which serves as a base class for things like HttpServer and HttpClient, all of which serve TCP connections.
TCPSSLOptions	Base class.
TCPSSLOptionsConverter	Converter and mapper for TCPSSLOptions.
ThreadingModel	The threading model defines the scheduler to execute context tasks.
Timer	A timer task that can be used as a future.
TracingOptions	Vert.x tracing base configuration, this class can be extended by provider implementations to configure those specific implementations.
TracingOptionsConverter	Converter and mapper for TracingOptions.
TracingPolicy	Policy controlling the behavior across boundaries.
TrafficShapingOptions	Options describing how GlobalTrafficShapingHandler will handle traffic shaping.
TrafficShapingOptionsConverter	Converter and mapper for TrafficShapingOptions.
Transport	The transport used by a Vertx instance.
Transport	The transport used by a Vertx instance.
TrustOptions	Certification authority configuration options.
UpgradeRejectedException
Verticle	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.
VerticleBase	An abstract base class that you can extend to write your own Verticle classes.
VerticleFactory	Has responsibility for creating verticle instances.
Vertx	The entry point into the Vert.x Core API.
VertxBuilder	A builder for creating Vert.x instances, allowing to configure Vert.x plugins: metrics tracing cluster manager Example usage:
VertxException
VertxMetrics	The main Vert.x metrics SPI which Vert.x will use internally.
VertxMetricsFactory	A factory for the plugable metrics SPI.
VertxModule	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
VertxOptions	Instances of this class are used to configure Vertx instances.
VertxOptionsConverter	Converter and mapper for VertxOptions.
VertxServiceProvider	Entry point for loading Vert.x SPI implementations.
VertxThreadFactory
VertxTracer<I,O>	The tracer SPI used by Vert.x components to report activities.
VertxTracerFactory	A factory for the plug-able tracing SPI.
WebSocket	Common WebSocket implementation.
WebSocketBase	Base WebSocket implementation.
WebSocketClient	An asynchronous WebSocket client.
WebSocketClientOptions
WebSocketClientOptionsConverter	Converter and mapper for WebSocketClientOptions.
WebSocketConnectOptions	Options describing how an HttpClient connect a WebSocket.
WebSocketConnectOptionsConverter	Converter and mapper for WebSocketConnectOptions.
WebSocketFrame	A WebSocket frame that represents either text or binary data.
WebSocketFrameType	List of all frame types.
WebSocketVersion	Represents the WebSocket version
WorkerExecutor	An executor for executing blocking code in Vert.x .
WriteStream<T>	Represents a stream of data that can be written to.