# Index

`AddressResolverOptions` | Configuration options for Vert.x hostname resolver. T
`Argument` | Defines a command line argument.
`AsyncFile` | Represents a file on the file-system which can be read from, or written to asynchronously. T
`AsyncMap` | An asynchronous map. <
`Buffer` | Most data is shuffled around inside Vert.x using buffers. A
`CLI` | Interface defining a command-line interface (in other words a command such as 'run', 'ls'&hel
`ClientAuth` | Configures the engine to require/request client authentication. C
`ClientOptionsBase` | Base class for Client options
`CommandLine` | The parser transforms a CLI (a model) into an CommandLine. T
`CompositeFuture` | The composite future wraps a list of futures, it is useful when several futures needs to be coordinated.
`Context` | The execution context of a handler execution. W
`CopyOptions` | Describes the copy (and move) options.
`Counter` | An asynchronous counter that can be used to across the cluster to maintain a consistent count. <
`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 . U
`DatagramSocketOptions` | Options used to configure a datagram socket.
`DeliveryOptions` | Delivery options are used to configure message delivery. D
`DeploymentOptions` | Options for configuring a verticle deployment. <
`DnsClient` | Provides a way to asynchronously lookup information from DNS servers. P
`DnsClientOptions` | Configuration options for Vert.x DNS client.
`DnsResponseCode` | Represents the possible response codes a server may send after receiving a query.
`EventBus` | A Vert.x event-bus is a light-weight distributed messaging system which allows different parts of your application, or…
`EventBusOptions` | Options to configure the event bus.
`FileProps` | Represents properties of a file on the file system. <
`FileSystem` | Contains a broad set of operations for manipulating files on the file system. A
`FileSystemProps` | Represents properties of the file system.
`Future` | Represents the result of an action that may, or may not, have occurred yet. <
`GoAway` | A frame.
`Http2Settings` | HTTP2 settings, the settings is initialized with the default HTTP/2 values. <
`HttpClient` | An asynchronous HTTP client. I
`HttpClientOptions` | Options describing how an HttpClient will make connections.
`HttpClientRequest` | Represents a client-side HTTP request. I
`HttpClientResponse` | Represents a client-side HTTP response. V
`HttpConnection` | Represents an HTTP connection. H
`HttpFrame` | An HTTP/2 frame.
`HttpMethod` | Represents an HTTP method
`HttpServer` | An HTTP and WebSockets server. Y
`HttpServerFileUpload` | Represents an file upload from an HTML FORM.
`HttpServerOptions` | Represents options used by an HttpServer instance
`HttpServerRequest` | Represents a server-side HTTP request. I
`HttpServerResponse` | Represents a server-side HTTP response. A
`HttpVersion` | Represents the version of the HTTP protocol.
`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. W
`JsonEvent` | A JSON event emited by the JsonParser.
`JsonEventType` | The possibles types of JsonEvent emitted by the JsonParser.
`JsonParser` | A parser class which allows to incrementally parse json elements and emit json parse events instead of parsing a json…
`LocalMap` | Local maps can be used to share data safely in a single Vert.x instance. T
`Lock` | An asynchronous exclusive lock which can be obtained from any node in the cluster. W
`Measured` |
`Message` | Represents a message that is received from the event bus in a handler. M
`MessageConsumer` | An event bus consumer object representing a stream of message to an EventBus address that can be read from. T
`MessageProducer` | Represents a stream of message that can be written to. <
`MetricsOptions` | Vert.x metrics base configuration, this class can be extended by provider implementations to configure those specific…
`MultiMap` | This class represents a MultiMap of String keys to a List of String values. I
`MxRecord` | Represent a Mail-Exchange-Record (MX) which was resolved for a domain.
`NetClient` | A TCP client. M
`NetClientOptions` | Options for configuring a NetClient.
`NetServer` | Represents a TCP server
`NetServerOptions` | Options for configuring a NetServer.
`NetSocket` | Represents a socket-like interface to a TCP connection on either the client or the server side. I
`NetworkOptions` |
`OpenOptions` | Describes how an AsyncFile should be opened.
`OpenSSLEngineOptions` | Configures a TCPSSLOptions to use OpenSsl.
`Option` | Models command line options.
`PemKeyCertOptions` | Key store options configuring a list of private key and its certificate based on Privacy-enhanced Electronic Email (PEM)…
`PemTrustOptions` | Certificate Authority options configuring certificates based on Privacy-enhanced Electronic Email (PEM) files.
`PfxOptions` | Key or trust store options configuring private key and/or certificates based on PKCS#12 files. W
`ProxyOptions` | Proxy options for a net client or a net client.
`ProxyType` | The type of a TCP proxy server.
`Pump` | Pumps data from a ReadStream to a WriteStream and performs flow control where necessary to prevent the write stream…
`ReadStream` | Represents a stream of items that can be read from. A
`RecordParser` | A helper class which allows you to easily parse protocols which are delimited by a sequence of bytes, or fixed size…
`ReplyFailure` | Represents the type of reply failure
`RequestOptions` | Options describing how an HttpClient will make connect to make a request.
`SelfSignedCertificate` | A self-signed certificate helper for testing and development purposes. W
`SendContext` | Encapsulates a message being sent from Vert.x.
`ServerWebSocket` | Represents a server side WebSocket. I
`SharedData` | Shared data allows you to share data safely between different parts of your application in a safe way. S
`SocketAddress` | The address of a socket, an inet socket address or a domain socket address. U
`SrvRecord` | Represent a Service-Record (SRV) which was resolved for a domain.
`StreamBase` | Base interface for a stream.
`TCPSSLOptions` | Base class.
`TimeoutStream` | A timeout stream is triggered by a timer, the handler will be call when the timer is fired, it can be once or several…
`Verticle` |
`Vertx` | The entry point into the Vert.x Core API. Y
`VertxOptions` | Instances of this class are used to configure Vertx instances.
`WebSocket` | Represents a client-side WebSocket.
`WebSocketBase` | Base WebSocket implementation. I
`WebSocketFrame` | A WebSocket frame that represents either text or binary data. A
`WebsocketVersion` | Represents the WebSocket version
`WorkerExecutor` | An executor for executing blocking code in Vert.x . <
`WriteStream` | Represents a stream of data that can be written to. A
`addressResolverOptions` |
`argument` |
`badkey` | ID 13, bad key
`badsig` | ID 12, bad signature
`badtime` | ID 14, bad timestamp
`badvers` | ID 11, bad extension mechanism for version
`buffer` |
`cli` |
`clientAuth` |
`clientOptionsBase` |
`commandLine` |
`compositeFuture` |
`connect` |
`context` |
`copyOptions` |
`datagramSocketOptions` |
`delete` |
`deliveryOptions` |
`deploymentOptions` |
`dnsClientOptions` |
`dnsResponseCode` |
`end_array` | Signals the end of a JSON array.
`end_object` | Signals the end of a JSON object.
`eventBusOptions` |
`formerror` | ID 1, format error
`future` |
`get` |
`goAway` |
`head` |
`http` | HTTP CONNECT ssl proxy
`http2Settings` |
`httpClientOptions` |
`httpMethod` |
`httpServerOptions` |
`httpVersion` |
`http_1_0` |
`http_1_1` |
`http_2` |
`jdkSSLEngineOptions` |
`jksOptions` |
`jsonEventType` |
`jsonParser` |
`metricsOptions` |
`multiMap` |
`netClientOptions` |
`netServerOptions` |
`networkOptions` |
`no_handlers` | The message send failed because no handlers were available to handle the message.
`noerror` | ID 0, no error
`none` | No client authentication is requested or required.
`notauth` | ID 9, not authoritative for zone
`notimpl` | ID 4, not implemented
`notzone` | ID 10, name not in zone
`nxdomain` | ID 3, name error
`nxrrset` | ID 8, rrset does not exist
`openOptions` |
`openSSLEngineOptions` |
`option` |
`options` |
`other` |
`patch` |
`pemKeyCertOptions` |
`pemTrustOptions` |
`pfxOptions` |
`post` |
`proxyOptions` |
`proxyType` |
`pump` |
`put` |
`recipient_failure` | The message send failed because the recipient actively sent back a failure (rejected the message)
`recordParser` |
`refused` | ID 5, operation refused
`replyFailure` |
`request` | Accept authentication if presented by client.
`requestOptions` |
`required` | Require client to present authentication, if not presented then negotiations will be declined.
`resolveVerticles()` | Find the verticles for the specified module and return a list of verticle factories.
`selfSignedCertificate` |
`servfail` | ID 2, server failure
`socketAddress` |
`socks4` | SOCKS4/4a tcp proxy
`socks5` | SOCSK5 tcp proxy
`start_array` | Signals the start of a JSON array.
`start_object` | Signals the start of a JSON object.
`tcpsslOptions` |
`timeout` | The message send failed because no reply was received before the timeout time.
`trace` |
`v00` |
`v07` |
`v08` |
`v13` |
`value` | Signals a JSON value.
`vertx` |
`vertxOptions` |
`webSocketFrame` |
`websocketVersion` |
`yxdomain` | ID 6, domain name should not exist
`yxrrset` | ID 7, resource record set should not exist