### start Source: https://vertx.io/docs/apidocs/io/vertx/rabbitmq/RabbitMQPublisher.html Starts the RabbitMQ publisher. It is expected that the underlying RabbitMQClient has already been started. ```APIDOC ## start ### Description Start the rabbitMQ publisher. The RabbitMQClient should have been started before this. ### Method Signature `Future start()` ### Returns A Future that completes when the publisher has been successfully started. ``` -------------------------------- ### Start Client Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/rabbitmq/RabbitMQClient.html Start the RabbitMQ client. ```APIDOC ## rxStart ### Description Start the RabbitMQ client. ### Method Signature `Completable rxStart()` ``` ```APIDOC ## start ### Description Start the RabbitMQ client. ### Method Signature `Completable start()` ``` -------------------------------- ### start Source: https://vertx.io/docs/apidocs/io/vertx/rabbitmq/RabbitMQClient.html Starts the RabbitMQ client, establishing the connection and creating the channel. ```APIDOC ## start ### Description Starts the RabbitMQ client. This operation creates the connection and the channel. ### Method Future ### See Also - `Connection.createChannel()` ``` -------------------------------- ### Start Publisher Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/rabbitmq/RabbitMQPublisher.html Start the RabbitMQ publisher. ```APIDOC ## start ### Description Start the rabbitMQ publisher. ### Method Future ``` -------------------------------- ### start Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/ext/consul/Watch.html Starts the watch and begins monitoring. ```APIDOC ## start ### Description Start this `Watch`. ### Method `public Watch start()` ### Returns - `Watch` - reference to this, for fluency ``` -------------------------------- ### Start MqttServer Listening (RxJava) Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/mqtt/class-use/MqttServer.html Methods to start the MQTT server listening for incoming connections using RxJava Singles. ```APIDOC ## rxListen() ### Description Start the server listening for incoming connections using the specified options through the constructor. ### Method Single ### Return Value A Single that will emit the MqttServer instance when it starts listening. ``` ```APIDOC ## rxListen(int port) ### Description Start the server listening for incoming connections on the port specified but on "0.0.0.0" as host. ### Method Single ### Parameters * **port** (int) - The port to listen on. ### Return Value A Single that will emit the MqttServer instance when it starts listening. ``` ```APIDOC ## rxListen(int port, String host) ### Description Start the server listening for incoming connections on the port and host specified. ### Method Single ### Parameters * **port** (int) - The port to listen on. * **host** (String) - The host to listen on. ### Return Value A Single that will emit the MqttServer instance when it starts listening. ``` -------------------------------- ### Starting the HttpServer (Listen) Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/core/http/class-use/HttpServer.html Methods to start the HttpServer listening for incoming connections, with options for port and host. ```APIDOC ## HttpServer Listen Methods ### Description Methods to initiate the server to start listening for incoming connections. ### Methods - `Future HttpServer.listen()`: Tells the server to start listening using its configured options. - `Future HttpServer.listen(int port)`: Starts the server listening on the specified port on host "0.0.0.0", ignoring the port in `HttpServerOptions`. - `Future HttpServer.listen(int port, String host)`: Starts the server listening on the specified port and host. - `Future HttpServer.listen(SocketAddress address)`: Starts the server listening on the given network address. - `Single HttpServer.rxListen()`: RxJava version of `listen()`, returning a Single. - `Single HttpServer.rxListen(int port)`: RxJava version of `listen(port)`. - `Single HttpServer.rxListen(int port, String host)`: RxJava version of `listen(port, host)`. - `Single HttpServer.rxListen(SocketAddress address)`: RxJava version of `listen(address)`. ``` -------------------------------- ### Start MqttServer Listening Source: https://vertx.io/docs/apidocs/io/vertx/mqtt/class-use/MqttServer.html Methods for starting the MQTT server to listen for incoming connections on specified ports and hosts. ```APIDOC ## listen() ### Description Start the server listening for incoming connections using the specified options through the constructor. ### Method `Future` ``` ```APIDOC ## listen(int port) ### Description Start the server listening for incoming connections on the specified port but on "0.0.0.0" as host. ### Method `Future` ### Parameters * **port** (int) - The port to listen on. ``` ```APIDOC ## listen(int port, String host) ### Description Start the server listening for incoming connections on the specified port and host. ### Method `Future` ### Parameters * **port** (int) - The port to listen on. * **host** (String) - The host to listen on. ``` -------------------------------- ### Start MqttServer Listening (RxJava) Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/mqtt/class-use/MqttServer.html Methods to start the MQTT server listening for incoming connections using RxJava. ```APIDOC ## listen() ### Description Start the server listening for incoming connections using the specified options through the constructor. ### Method Single ### Returns A Single that completes when the server has started listening. ``` ```APIDOC ## listen(int port) ### Description Start the server listening for incoming connections on the specified port but on "0.0.0.0" as host. ### Method Single ### Parameters - **port** (int) - The port to listen on. ### Returns A Single that completes when the server has started listening. ``` ```APIDOC ## listen(int port, String host) ### Description Start the server listening for incoming connections on the specified port and host. ### Method Single ### Parameters - **port** (int) - The port to listen on. - **host** (String) - The host to listen on. ### Returns A Single that completes when the server has started listening. ``` ```APIDOC ## rxListen() ### Description Start the server listening for incoming connections using the specified options through the constructor. This is the RxJava equivalent of the `listen()` method. ### Method Single ### Returns A Single that completes when the server has started listening. ``` ```APIDOC ## rxListen(int port) ### Description Start the server listening for incoming connections on the port specified but on "0.0.0.0" as host. This is the RxJava equivalent of the `listen(int port)` method. ### Method Single ### Parameters - **port** (int) - The port to listen on. ### Returns A Single that completes when the server has started listening. ``` ```APIDOC ## rxListen(int port, String host) ### Description Start the server listening for incoming connections on the port and host specified. This is the RxJava equivalent of the `listen(int port, String host)` method. ### Method Single ### Parameters - **port** (int) - The port to listen on. - **host** (String) - The host to listen on. ### Returns A Single that completes when the server has started listening. ``` -------------------------------- ### Rx Start Publisher Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/rabbitmq/RabbitMQPublisher.html Start the RabbitMQ publisher using RxJava. ```APIDOC ## rxStart ### Description Start the rabbitMQ publisher. ### Method Completable ``` -------------------------------- ### Server Instantiation Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/openapi/contract/class-use/Server.html Demonstrates how to create a new instance of Server. ```APIDOC ## Server.newInstance ### Description Creates a new instance of the Server class. ### Method `static Server` ### Parameters - `arg` (Server) - Required - An existing Server instance to base the new instance on. ``` -------------------------------- ### HookContext.vertx Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Vertx.html Get the Vert.x instance after it has started. ```APIDOC ## HookContext.vertx ### Description Get the Vert.x instance, after it has started. ### Method Signature `Vertx vertx()` ``` -------------------------------- ### Creating an MqttServer instance Source: https://vertx.io/docs/apidocs/io/vertx/mqtt/class-use/MqttServerOptions.html Demonstrates how to create an MqttServer instance using the Vert.x instance and MqttServerOptions. ```APIDOC ## Create MqttServer ### `static MqttServer create(Vertx vertx, MqttServerOptions options)` Returns an MQTT server instance configured with the provided options. #### Parameters - **vertx** (Vertx) - The Vert.x instance. - **options** (MqttServerOptions) - The configuration options for the MQTT server. #### Returns - MqttServer - An instance of the MQTT server. ``` -------------------------------- ### WebClient GET requests with UriTemplate Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/uritemplate/class-use/UriTemplate.html Examples of creating GET requests using UriTemplate for different host and port configurations. ```APIDOC ## GET requests with UriTemplate ### Description These methods allow you to create HTTP GET requests where the request URI is defined by a UriTemplate. ### Methods - `WebClient.get(int port, String host, UriTemplate requestURI)` - `WebClient.get(UriTemplate requestURI)` - `WebClient.get(String host, UriTemplate requestURI)` - `WebClient.getAbs(UriTemplate absoluteURI)` ### Parameters - `port` (int) - The port of the server. - `host` (String) - The host of the server. - `requestURI` (UriTemplate) - The UriTemplate for the request URI. - `absoluteURI` (UriTemplate) - The absolute UriTemplate for the request URI. ### Returns `HttpRequest` - An HTTP request object. ``` -------------------------------- ### Setup Credentials Get Callback Route Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/ext/web/handler/WebAuthn4JHandler.html Configures the route for creating login attestations, typically used for user authentication. ```APIDOC ## setupCredentialsGetCallback ### Description The callback route to create login attestations. Usually this route is `/webauthn/login`. ### Method `WebAuthn4JHandler` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters * `route` (Route) - The route where credential get options are generated. ### Returns - `WebAuthn4JHandler` - fluent self. ``` -------------------------------- ### Creating an MqttClient with Options Source: https://vertx.io/docs/apidocs/io/vertx/mqtt/class-use/MqttClientOptions.html Demonstrates how to create an MqttClient instance using provided MqttClientOptions. ```APIDOC ## MqttClient Creation ### `static MqttClient create(Vertx vertx, MqttClientOptions options)` Returns an MQTT client instance configured with the provided options. ### Parameters * **vertx** (Vertx) - The Vert.x instance. * **options** (MqttClientOptions) - The configuration options for the MQTT client. ### Returns * `MqttClient` - An instance of the MQTT client. ``` -------------------------------- ### Start MqttServer Listening (Futures) Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/mqtt/class-use/MqttServer.html Methods to start the MQTT server listening for incoming connections using Vert.x Futures. ```APIDOC ## listen() ### Description Start the server listening for incoming connections using the specified options through the constructor. ### Method Future ### Return Value A Future that will be completed when the server starts listening. ``` ```APIDOC ## listen(int port) ### Description Start the server listening for incoming connections on the specified port but on "0.0.0.0" as host. ### Method Future ### Parameters * **port** (int) - The port to listen on. ### Return Value A Future that will be completed when the server starts listening. ``` ```APIDOC ## listen(int port, String host) ### Description Start the server listening for incoming connections on the specified port and host. ### Method Future ### Parameters * **port** (int) - The port to listen on. * **host** (String) - The host to listen on. ### Return Value A Future that will be completed when the server starts listening. ``` -------------------------------- ### listen (no arguments) Source: https://vertx.io/docs/apidocs/io/vertx/core/net/QuicServer.html Start listening on the `port` and `host` as configured in the `QuicServerConfig` used when creating the server. ```APIDOC ## listen ### Description Start listening on the `port` and `host` as configured in the `QuicServerConfig` used when creating the server. ### Method Signature `Future listen()` ### Returns * A future signaling the success or failure of the listen operation. The result is the socket address this endpoint is bound to. ``` -------------------------------- ### Setup Credentials Get Callback Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/ext/web/handler/class-use/WebAuthn4JHandler.html Configures a route to handle the callback for creating login attestations. This is used during the user login process with WebAuthn. ```APIDOC ## WebAuthn4JHandler setupCredentialsGetCallback(Route route) ### Description The callback route to create login attestations. ### Method instance method ### Parameters #### Path Parameters - **route** (Route) - Required - The route to set up for getting credentials. ``` -------------------------------- ### Create NetClient with Options Source: https://vertx.io/docs/apidocs/io/vertx/core/net/class-use/NetClientOptions.html Demonstrates how to create a NetClient instance using provided NetClientOptions. ```APIDOC ## Vertx.createNetClient(NetClientOptions options) ### Description Create a TCP/SSL client using the specified options. ### Method `NetClient` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java NetClientOptions options = new NetClientOptions(); // Configure options here... NetClient client = vertx.createNetClient(options); ``` ### Response #### Success Response (NetClient) Returns a configured NetClient instance. #### Response Example ```java // Example response is implicit in the method signature ``` ``` -------------------------------- ### Get Metrics Snapshot by Base Name Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/ext/dropwizard/MetricsService.html Retrieves a snapshot of metrics that start with a given base name. Aggregates metrics if running in a scaled environment. ```APIDOC ## getMetricsSnapshot ### Description Will return the metrics that begins with the `baseName`, null if no metrics is available. In the case of scaled servers, the JsonObject returns an aggregation of the metrics as the dropwizard backend reports to a single server. ### Method Instance Methods ### Parameters #### Path Parameters - **baseName** (String) - ### Returns - **JsonObject** - the map of metrics where the key is the name of the metric and the value is the json data representing that metric ``` -------------------------------- ### RabbitMQPublisher rxStart Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/rabbitmq/RabbitMQPublisher.html Starts the RabbitMQ publisher asynchronously. The RabbitMQClient must be started before calling this method. ```APIDOC ## rxStart ### Description Start the rabbitMQ publisher. The RabbitMQClient should have been started before this. ### Method Completable rxStart() ### Returns ``` -------------------------------- ### Starting NetServer Listening Source: https://vertx.io/docs/apidocs/io/vertx/core/net/class-use/NetServer.html Methods to start the NetServer listening on a specified address or port. ```APIDOC ## Starting NetServer Listening ### Description Start the NetServer listening on the configured or specified network address and port. ### Methods #### `Future NetServer.listen()` Start listening on the port and host as configured in the `NetServerOptions` used when creating the server. #### `Future NetServer.listen(int port)` Start listening on the specified port and host "0.0.0.0", ignoring port and host configured in the `NetServerOptions` used when creating the server. #### `Future NetServer.listen(int port, String host)` Start listening on the specified port and host, ignoring port and host configured in the `NetServerOptions` used when creating the server. #### `Future NetServer.listen(SocketAddress localAddress)` Start listening on the specified local address, ignoring port and host configured in the `NetServerOptions` used when creating the server. ``` -------------------------------- ### MqttServer.create (with options) Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/core/class-use/Vertx.html Returns an MQTT server instance with specified options. ```APIDOC ## MqttServer.create (with options) ### Description Returns an MQTT server instance with specified options. ### Method static ### Signature MqttServer.create(Vertx vertx, MqttServerOptions options) ### Parameters - **vertx** (Vertx) - The Vertx instance. - **options** (MqttServerOptions) - The MQTT server options. ``` -------------------------------- ### Create WebSocketClient with Default Options Source: https://vertx.io/docs/apidocs/io/vertx/core/http/class-use/WebSocketClient.html Creates a WebSocket client using the default configuration. This is a convenient way to get started with WebSocket client functionality. ```APIDOC ## Create WebSocketClient with Default Options ### Description Create a WebSocket client using default options. ### Method `Vertx.createWebSocketClient()` ### Parameters None ``` -------------------------------- ### rxStart Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/rabbitmq/RabbitMQPublisher.html RxJava3 version of starting the publisher. ```APIDOC ## rxStart Start the rabbitMQ publisher. ### Method Completable ``` -------------------------------- ### ServiceType.get() Source: https://vertx.io/docs/apidocs/io/vertx/servicediscovery/spi/ServiceType.html Gets the service for the given record. The record's type must match the current type. From the returned ServiceReference, the consumer can start using the service and release it. ```APIDOC ServiceReference get(Vertx vertx, ServiceDiscovery discovery, Record record, JsonObject configuration) Gets the `service` for the given record. The record's type must match the current type. From the returned `ServiceReference`, the consumer can start using the service and release it. Parameters: `vertx` - the vert.x instance `discovery` - the discovery instance requesting the reference `record` - the record `configuration` - some optional configuration, maybe be `null` or empty Returns: the retrieved `ServiceReference` ``` -------------------------------- ### Creating a NetServer Source: https://vertx.io/docs/apidocs/io/vertx/core/net/class-use/NetServer.html Demonstrates different ways to create a NetServer instance using Vert.x. ```APIDOC ## Creating a NetServer ### Description Create a TCP/SSL server using default options, specified options, or a configuration object. ### Methods #### `Vertx.createNetServer()` Create a TCP/SSL server using default options. #### `Vertx.createNetServer(NetServerOptions options)` Create a TCP/SSL server using the specified options. #### `Vertx.createNetServer(TcpServerConfig config)` Create a TCP/SSL server using the specified config. #### `Vertx.createNetServer(TcpServerConfig config, ServerSSLOptions sslOptions)` Create a TCP/SSL server using the specified config and the specified SSL options. ``` -------------------------------- ### Get Error Message Bytes - ErrorResponseOrBuilder Source: https://vertx.io/docs/apidocs/io/vertx/grpc/reflection/v1/ErrorResponseOrBuilder.html Retrieves the error message as a ByteString. This is useful for handling the error message in its raw byte format, for example, when serializing or transmitting it. ```java com.google.protobuf.ByteString getErrorMessageBytes() ``` -------------------------------- ### getRebalanceDelay Source: https://vertx.io/docs/apidocs/io/vertx/spi/cluster/ignite/IgniteCacheOptions.html Gets the delay in milliseconds after which rebalancing should be started automatically when nodes join or leave the topology. A delay of 0 means immediate rebalancing, -1 means manual rebalancing. ```APIDOC ## getRebalanceDelay ### Description Gets delay in milliseconds upon a node joining or leaving topology (or crash) after which rebalancing should be started automatically. Rebalancing should be delayed if you plan to restart nodes after they leave topology, or if you plan to start multiple nodes at once or one after another and don't want to repartition and rebalance until all nodes are started. For better efficiency user should usually make sure that new nodes get placed on the same place of consistent hash ring as the left nodes, and that nodes are restarted before this delay expires. As an example, node IP address and port combination may be used in this case. Default value is `0` which means that repartitioning and rebalancing will start immediately upon node leaving topology. If `-1` is returned, then rebalancing will only be started manually by calling rebalance() method or from management console. ### Returns Rebalancing delay, `0` to start rebalancing immediately, `-1` to start rebalancing manually, or positive value to specify delay in milliseconds after which rebalancing should start automatically. ``` -------------------------------- ### MqttServer.create Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Vertx.html Create an MQTT server instance. ```APIDOC ## MqttServer.create ### Description Return an MQTT server instance. ### Method Signature `static MqttServer create(Vertx vertx)` ### Method Signature `static MqttServer create(Vertx vertx, MqttServerOptions options)` ``` -------------------------------- ### Get Metrics Snapshot by Base Name Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/ext/dropwizard/MetricsService.html Retrieves a snapshot of metrics for all measured objects whose names start with the given base name. Returns null if no metrics are available. ```APIDOC ## getMetricsSnapshot ### Description Will return the metrics that begins with the `baseName`, null if no metrics is available. Note: in the case of scaled servers, the JsonObject returns an aggregation of the metrics as the dropwizard backend reports to a single server. ### Method JsonObject ### Parameters #### Path Parameters - **baseName** (String) - ### Returns - JsonObject - the map of metrics where the key is the name of the metric and the value is the json data representing that metric ``` -------------------------------- ### Get Policy Attributes Source: https://vertx.io/docs/apidocs/io/vertx/ext/auth/abac/Policy.html Retrieves the set of attributes for the policy. Attributes are environmental values extracted from the User and are used to filter policies before evaluation. For example, an attribute can filter users based on their authentication method. ```java public Set getAttributes() ``` -------------------------------- ### MqttServer.create (default options) Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/core/class-use/Vertx.html Returns an MQTT server instance using default options. ```APIDOC ## MqttServer.create (default options) ### Description Returns an MQTT server instance using default options. ### Method static ### Signature MqttServer.create(Vertx vertx) ### Parameters - **vertx** (Vertx) - The Vertx instance. ``` -------------------------------- ### rxListen (no args) Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/mqtt/MqttServer.html Starts the MQTT server listening for incoming connections without specifying port or host. It uses options configured via the constructor. ```APIDOC ## rxListen ### Description Starts the server listening for incoming connections using the specified options through the constructor. ### Method `public Single rxListen()` ### Returns a `Single` completed with this server instance. ``` -------------------------------- ### QuicServer rxListen methods Source: https://vertx.io/docs/apidocs/io/vertx/core/net/class-use/SocketAddress.html Reactive methods for starting a Quic server listener. ```APIDOC ## QuicServer.rxListen ### Description Starts listening on the specified port and host "0.0.0.0". ### Method `Single` ### Signature `rxListen(int port)` --- ### Description Starts listening on the specified port and host. ### Method `Single` ### Signature `rxListen(int port, String host)` --- ### Description Starts listening on the specified local address. ### Method `Single` ### Signature `rxListen(SocketAddress localAddress)` --- ### Description Starts listening on the port and host as configured in the `QuicServerConfig` used when creating the server. ### Method `Single` ### Signature `rxListen()` ``` -------------------------------- ### RabbitMQPublisher start Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/rabbitmq/RabbitMQPublisher.html Starts the RabbitMQ publisher. The RabbitMQClient must be started before calling this method. ```APIDOC ## start ### Description Start the rabbitMQ publisher. The RabbitMQClient should have been started before this. ### Method Completable start() ### Returns ``` -------------------------------- ### Create HTTP Server with Options Source: https://vertx.io/docs/apidocs/io/vertx/core/http/class-use/HttpServerOptions.html Demonstrates how to create an HTTP or HTTPS server using a provided HttpServerOptions object. ```APIDOC ## createHttpServer(HttpServerOptions options) ### Description Create an HTTP/HTTPS server using the specified `options`. ### Method `Vertx.createHttpServer(HttpServerOptions options)` ### Parameters * **options** (HttpServerOptions) - The options to configure the HTTP server. ``` -------------------------------- ### CamelBridge start Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Future.html Starts the Camel bridge. Returns a Future that completes when the bridge has started. ```APIDOC ## CamelBridge.start() ### Description Starts the bridge. ### Method [Method signature implies an asynchronous operation, likely POST conceptually] ### Endpoint [Not applicable, SDK method] ### Parameters None ### Response #### Success Response `Future` - Indicates successful startup. ``` -------------------------------- ### CamelBridge Start Source: https://vertx.io/docs/apidocs/io/vertx/camel/CamelBridge.html Starts the Camel bridge asynchronously. A future is returned that is notified when the bridge has started. ```APIDOC ## start ### Description Starts the bridge. The bridge is started asynchronously. ### Method Future ### Returns - **Future** - A future notified when the bridge has started. ``` -------------------------------- ### GET Request Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/ext/web/client/WebClient.html Creates an HTTP GET request to the specified URI. This method is a convenience wrapper for making GET requests. ```APIDOC ## get ### Description Creates an HTTP GET request to send to the server. ### Method GET ### Endpoint (URI provided as parameter) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) (Not explicitly defined) #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### CassandraClient Creation with Options Source: https://vertx.io/docs/apidocs/io/vertx/cassandra/class-use/CassandraClientOptions.html Demonstrates how to create a Cassandra client using CassandraClientOptions. ```APIDOC ## CassandraClient Creation ### Static Factory Methods - **`static CassandraClient create(Vertx vertx, CassandraClientOptions options)`** Create a Cassandra client which maintains its own driver session. - **`static CassandraClient createShared(Vertx vertx, CassandraClientOptions options)`** Like `CassandraClient.createShared(Vertx, String, CassandraClientOptions)` with default client name. - **`static CassandraClient createShared(Vertx vertx, String clientName, CassandraClientOptions options)`** Create a Cassandra client that shares its driver session with any other client having the same name. ``` -------------------------------- ### HttpClient Instantiation Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/core/http/class-use/HttpClient.html Demonstrates how to create a new HttpClient instance. ```APIDOC ## HttpClient.newInstance(HttpClient arg) ### Description Creates a new HttpClient instance, potentially by cloning or initializing from an existing one. ### Method `static HttpClient` ### Parameters - **arg** (HttpClient) - The existing HttpClient to base the new instance on. ``` -------------------------------- ### PreparedQuery Creation and Execution Source: https://vertx.io/docs/apidocs/io/vertx/sqlclient/class-use/PreparedQuery.html Demonstrates how to create and execute prepared queries using Pool and SqlClient. ```APIDOC ## Pool.preparedQuery(String sql) ### Description Create a prepared query, one of the `PreparedQuery.execute(Tuple)` or `PreparedQuery.executeBatch(List)` methods must be called to execute the query. ### Method `PreparedQuery>` ### Endpoint N/A (SDK method) ## SqlClient.preparedQuery(String sql) ### Description Create a prepared query, one of the `PreparedQuery.execute(Tuple)` or `PreparedQuery.executeBatch(List)` methods must be called to execute the query. ### Method `PreparedQuery>` ### Endpoint N/A (SDK method) ## SqlClient.preparedQuery(String sql, PrepareOptions options) ### Description Create a prepared query, one of the `PreparedQuery.execute(Tuple)` or `PreparedQuery.executeBatch(List)` methods must be called to execute the query. ### Method `PreparedQuery>` ### Endpoint N/A (SDK method) ``` -------------------------------- ### RedisAPI rxFtSugget Source: https://vertx.io/docs/apidocs/io/vertx/redis/client/class-use/Response.html Gets completion suggestions for a prefix. ```APIDOC ## rxFtSugget(List args) ### Description Gets completion suggestions for a prefix. ### Method `rxFtSugget` ### Parameters #### Path Parameters - **args** (List) - Required - Arguments for the sugget command. ### Response #### Success Response - **Response** (Maybe) - The list of suggestions. ``` -------------------------------- ### ServiceImporter Start Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Vertx.html Method for starting the ServiceImporter. ```APIDOC ## ServiceImporter.start(Vertx vertx, ServicePublisher publisher, JsonObject configuration, Promise future) ### Description Starts the importer. ### Method void ### Parameters - **vertx** (Vertx) - The Vertx instance. - **publisher** (ServicePublisher) - The service publisher. - **configuration** (JsonObject) - The configuration. - **future** (Promise) - The future to complete. ``` -------------------------------- ### Create Quic Client with SSL Options Source: https://vertx.io/docs/apidocs/io/vertx/core/net/class-use/QuicClientConfig.html Shows how to create a Quic client with both `QuicClientConfig` and `ClientSSLOptions`. ```APIDOC ## Create Quic Client with SSL Options ### Description Creates a configured Quic client using the provided `QuicClientConfig` and `ClientSSLOptions`. ### Method `Vertx.createQuicClient(QuicClientConfig config, ClientSSLOptions sslOptions)` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java Vertx vertx = Vertx.vertx(); QuicClientConfig config = new QuicClientConfig(); ClientSSLOptions sslOptions = new ClientSSLOptions(); // Configure config and sslOptions objects here... QuicClient client = vertx.createQuicClient(config, sslOptions); ``` ### Response #### Success Response (200) - `QuicClient` (QuicClient) - The created Quic client instance. #### Response Example None ``` -------------------------------- ### KubernetesServiceImporter Start Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Vertx.html Method for starting the KubernetesServiceImporter. ```APIDOC ## KubernetesServiceImporter.start(Vertx vertx, ServicePublisher publisher, JsonObject configuration, Promise completion) ### Description Starts the KubernetesServiceImporter. ### Method void ### Parameters - **vertx** (Vertx) - The Vertx instance. - **publisher** (ServicePublisher) - The service publisher. - **configuration** (JsonObject) - The configuration. - **completion** (Promise) - The completion promise. ``` -------------------------------- ### QuicServer.listen Source: https://vertx.io/docs/apidocs/io/vertx/core/net/class-use/SocketAddress.html Starts the QuicServer listening. ```APIDOC ## QuicServer.listen ### Description Starts the QuicServer listening. ### Method `Future listen()` ### Parameters None ### Request Example None ### Response #### Success Response (200) `Future` - A future that completes with the listening socket address. #### Response Example None ``` -------------------------------- ### DockerLinksServiceImporter Start Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Vertx.html Method for starting the DockerLinksServiceImporter. ```APIDOC ## DockerLinksServiceImporter.start(Vertx vertx, ServicePublisher publisher, JsonObject configuration, Promise completion) ### Description Starts the DockerLinksServiceImporter. ### Method void ### Parameters - **vertx** (Vertx) - The Vertx instance. - **publisher** (ServicePublisher) - The service publisher. - **configuration** (JsonObject) - The configuration. - **completion** (Promise) - The completion promise. ``` -------------------------------- ### ConsulServiceImporter Start Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/Vertx.html Method for starting the ConsulServiceImporter. ```APIDOC ## ConsulServiceImporter.start(Vertx vertx, ServicePublisher publisher, JsonObject configuration, Promise completion) ### Description Starts the ConsulServiceImporter. ### Method void ### Parameters - **vertx** (Vertx) - The Vertx instance. - **publisher** (ServicePublisher) - The service publisher. - **configuration** (JsonObject) - The configuration. - **completion** (Promise) - The completion promise. ``` -------------------------------- ### Delay After Start Source: https://vertx.io/docs/apidocs/io/vertx/spi/cluster/ignite/IgniteOptions.html Configure the delay after Ignite start. ```APIDOC ## setDelayAfterStart ### Description Sets delay in milliseconds after Ignite start. Defaults to 100ms. ### Method public IgniteOptions setDelayAfterStart(long delayAfterStart) ### Parameters * `delayAfterStart` (long) - delay in milliseconds. ## getDelayAfterStart ### Description Returns the delay after Ignite start. ### Method public long getDelayAfterStart() ``` -------------------------------- ### Start ShellService Source: https://vertx.io/docs/apidocs/io/vertx/ext/shell/ShellService.html Starts the shell service asynchronously. ```APIDOC ## start Start the shell service, this is an asynchronous start. ### Method Signature `Future start()` ### Returns * `Future` - A future that completes when the service has started. ``` -------------------------------- ### Create HTTP Server with Config and SSL Options Source: https://vertx.io/docs/apidocs/io/vertx/core/http/class-use/HttpServerConfig.html Shows how to create an HTTP server with both configuration and SSL options. ```APIDOC ## Create HTTP Server with Config and SSL Options ### Description Creates an HTTP server using the specified configuration and SSL options. ### Method Signature ```java public static HttpServer createHttpServer(HttpServerConfig config, ServerSSLOptions sslOptions) ``` ### Parameters * **config** (HttpServerConfig) - The configuration object for the HTTP server. * **sslOptions** (ServerSSLOptions) - The SSL options for the HTTP server. ``` -------------------------------- ### SessionStore get Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/ext/web/sstore/SessionStore.html Get the session with the specified ID. ```APIDOC ## SessionStore get ### Description Get the session with the specified ID. ### Method `public Maybe get(String cookieValue)` ### Parameters #### Path Parameters - **cookieValue** (String) - the unique ID of the session ### Returns future that will be called with a result holding the session, or a failure ``` ```APIDOC ## SessionStore rxGet ### Description Get the session with the specified ID. ### Method `public Maybe rxGet(String cookieValue)` ### Parameters #### Path Parameters - **cookieValue** (String) - the unique ID of the session ### Returns future that will be called with a result holding the session, or a failure ``` -------------------------------- ### WebClient Creation with WebClientConfig Source: https://vertx.io/docs/apidocs/io/vertx/ext/web/client/class-use/WebClientConfig.html Demonstrates how to create a WebClient instance using a provided Vertx instance and a WebClientConfig object. This allows for custom client configurations. ```APIDOC ## WebClient.create(Vertx, WebClientConfig) ### Description Create a web client using the provided `vertx` instance and a custom `WebClientConfig`. ### Method `static WebClient create(Vertx vertx, WebClientConfig config)` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **WebClient** (WebClient) - The created WebClient instance. #### Response Example None ``` ```APIDOC ## WebClient.create(Vertx, WebClientConfig, PoolOptions) ### Description Create a web client using the provided `vertx` instance, a custom `WebClientConfig`, and specific `PoolOptions` for connection pooling. ### Method `static WebClient create(Vertx vertx, WebClientConfig config, PoolOptions poolOptions)` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **WebClient** (WebClient) - The created WebClient instance. #### Response Example None ``` ```APIDOC ## WebClient.create(Vertx, WebClientConfig, ClientSSLOptions) ### Description Create a web client using the provided `vertx` instance, a custom `WebClientConfig`, and specific `ClientSSLOptions` for SSL configuration. ### Method `static WebClient create(Vertx vertx, WebClientConfig config, ClientSSLOptions sslOptions)` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **WebClient** (WebClient) - The created WebClient instance. #### Response Example None ``` ```APIDOC ## WebClient.create(Vertx, WebClientConfig, ClientSSLOptions, PoolOptions) ### Description Create a web client using the provided `vertx` instance, a custom `WebClientConfig`, specific `ClientSSLOptions`, and `PoolOptions` for connection pooling. ### Method `static WebClient create(Vertx vertx, WebClientConfig config, ClientSSLOptions sslOptions, PoolOptions poolOptions)` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **WebClient** (WebClient) - The created WebClient instance. #### Response Example None ``` -------------------------------- ### Get Principal Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/ext/auth/User.html Gets the underlying principal for the User. ```APIDOC ## principal public JsonObject principal() ### Description Get the underlying principal for the User. What this actually returns depends on the implementation. For a simple user/password based auth, it's likely to contain a JSON object with the following structure: ``` { "username", "tim" } ``` ### Returns JSON representation of the Principal ``` -------------------------------- ### Vertx Instance Creation with VertxOptions Source: https://vertx.io/docs/apidocs/io/vertx/core/class-use/VertxOptions.html Demonstrates how to create Vert.x instances, both clustered and non-clustered, using VertxOptions. ```APIDOC ## Vertx Instance Creation with VertxOptions ### Description Methods for creating Vert.x instances using provided options. ### Methods - `static Future clusteredVertx(VertxOptions options)`: Creates a clustered Vert.x instance. - `static Vertx vertx(VertxOptions options)`: Creates a non-clustered Vert.x instance. - `VertxBuilder with(VertxOptions options)`: Configures the Vert.x builder with options. ``` -------------------------------- ### Absolute GET Request Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/ext/web/client/WebClient.html Creates an HTTP GET request using an absolute URI. This is useful for making GET requests to servers other than the default host and port. ```APIDOC ## getAbs ### Description Creates an HTTP GET request to send to the server using an absolute URI. ### Method GET ### Endpoint (Absolute URI provided as parameter) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) (Not explicitly defined) #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### start Source: https://vertx.io/docs/apidocs/io/vertx/servicediscovery/zookeeper/ZookeeperServiceImporter.html Starts the importer. This method is part of the ServiceImporter interface. ```APIDOC ## start ### Description Starts the importer. ### Method `void start(Vertx vertx, ServicePublisher publisher, JsonObject configuration, Promise future)` ### Parameters * **vertx** (Vertx) - the vertx instance * **publisher** (ServicePublisher) - the service publisher instance * **configuration** (JsonObject) - the bridge configuration if any * **future** (Promise) - a future on which the bridge must report the completion of the starting ``` -------------------------------- ### MqttServer Listen Methods Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/mqtt/MqttServer.html Methods to start the MQTT server listening for incoming connections. ```APIDOC ## rxListen ### Description Starts the server listening for incoming connections using the specified options through the constructor. ### Method `public Single rxListen()` ### Returns A `Single` completed with this server instance. ``` ```APIDOC ## listen ### Description Starts the server listening for incoming connections on the specified port and host. ### Method `public Single listen(int port, String host)` ### Parameters - `port` (int) - the port to listen on - `host` (String) - the host to listen on ### Returns A `Single` completed with this server instance. ``` ```APIDOC ## rxListen ### Description Starts the server listening for incoming connections on the specified port and host. ### Method `public Single rxListen(int port, String host)` ### Parameters - `port` (int) - the port to listen on - `host` (String) - the host to listen on ### Returns A `Single` completed with this server instance. ``` ```APIDOC ## listen ### Description Starts the server listening for incoming connections on the specified port but on "0.0.0.0" as host. It ignores any options specified through the constructor. ### Method `public Single listen(int port)` ### Parameters - `port` (int) - the port to listen on ### Returns A `Single` completed with this server instance. ``` ```APIDOC ## rxListen ### Description Starts the server listening for incoming connections on the specified port but on "0.0.0.0" as host. It ignores any options specified through the constructor. ### Method `public Single rxListen(int port)` ### Parameters - `port` (int) - the port to listen on ### Returns A `Single` completed with this server instance. ``` -------------------------------- ### RedisAPI rxFtSuglen Source: https://vertx.io/docs/apidocs/io/vertx/redis/client/class-use/Response.html Gets the size of an auto-complete suggestion dictionary. ```APIDOC ## rxFtSuglen(List args) ### Description Gets the size of an auto-complete suggestion dictionary. ### Method `rxFtSuglen` ### Parameters #### Path Parameters - **args** (List) - Required - Arguments for the suglen command. ### Response #### Success Response - **Response** (Maybe) - The size of the suggestion dictionary. ``` -------------------------------- ### Start Watch Source: https://vertx.io/docs/apidocs/io/vertx/ext/consul/Watch.html Start the watch and begin monitoring for updates. ```APIDOC ## Watch.start() ### Description Start this `Watch`. ### Returns - **Watch** - the `Watch` instance ``` -------------------------------- ### Creating HTTP/HTTPS Clients with ClientSSLOptions Source: https://vertx.io/docs/apidocs/io/vertx/core/net/class-use/ClientSSLOptions.html Demonstrates how to create HTTP/HTTPS clients using Vert.x with specified client and SSL options. ```APIDOC ## Vertx.createHttpClient ### Description Create a HTTP/HTTPS client using the specified client and ssl options. ### Method Signature `default HttpClientAgent Vertx.createHttpClient(HttpClientConfig clientConfig, ClientSSLOptions sslOptions)` --- ### Description Create a HTTP/HTTPS client using the specified client, ssl options and pool options. ### Method Signature `default HttpClientAgent Vertx.createHttpClient(HttpClientConfig clientConfig, ClientSSLOptions sslOptions, PoolOptions poolOptions)` ``` -------------------------------- ### Get Delegate (io.vertx.reactivex.ext.web.templ.pebble) Source: https://vertx.io/docs/apidocs/io/vertx/ext/web/templ/pebble/class-use/PebbleTemplateEngine.html Gets the delegate PebbleTemplateEngine instance. ```APIDOC ## getDelegate() ### Description Gets the delegate PebbleTemplateEngine instance. ### Method `PebbleTemplateEngine` ### Returns `PebbleTemplateEngine` - The delegate instance. ``` -------------------------------- ### Get Delegate (RxJava3) Source: https://vertx.io/docs/apidocs/io/vertx/ext/web/sstore/redis/class-use/RedisSessionStore.html Gets the delegate for the rxjava3 RedisSessionStore. ```APIDOC ## getDelegate ### Description Gets the delegate for the rxjava3 RedisSessionStore. ### Method RedisSessionStore ### Signature getDelegate() ### Returns RedisSessionStore - The delegate RedisSessionStore. ``` -------------------------------- ### create Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/rabbitmq/RabbitMQClient.html Create and return a client configured with the default options or with custom configuration. ```APIDOC ## create ### Description Create and return a client configured with the default options or with custom configuration. ### Method static RabbitMQClient ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Response #### Success Response (200) RabbitMQClient #### Response Example None ``` -------------------------------- ### Get Delegate (ReactiveX) Source: https://vertx.io/docs/apidocs/io/vertx/ext/web/sstore/redis/class-use/RedisSessionStore.html Gets the delegate for the reactivex RedisSessionStore. ```APIDOC ## getDelegate ### Description Gets the delegate for the reactivex RedisSessionStore. ### Method RedisSessionStore ### Signature getDelegate() ### Returns RedisSessionStore - The delegate RedisSessionStore. ``` -------------------------------- ### MqttServer Creation Source: https://vertx.io/docs/apidocs/io/vertx/rxjava3/core/class-use/Vertx.html Create an MQTT server instance using default options. ```APIDOC ## MqttServer create(Vertx vertx) ### Description Return an MQTT server instance using default options. ### Method `static MqttServer` ### Parameters - **vertx** (Vertx) - The Vertx instance. ``` -------------------------------- ### Client Start and Stop Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/rabbitmq/RabbitMQClient.html Methods for starting and stopping the RabbitMQ client. ```APIDOC ## rxStart () ### Description Start the RabbitMQ client. ### Returns `Completable` ``` ```APIDOC ## rxStop () ### Description Stop the RabbitMQ client. ### Returns `Completable` ``` ```APIDOC ## start () ### Description Start the RabbitMQ client. ### Returns `Future` ``` ```APIDOC ## stop () ### Description Stop the RabbitMQ client. ### Returns `Future` ``` -------------------------------- ### StompServer Creation with Options Source: https://vertx.io/docs/apidocs/io/vertx/ext/stomp/class-use/StompServerOptions.html Demonstrates how to create a StompServer instance using StompServerOptions. ```APIDOC ## StompServer Creation ### Description Methods to create a `StompServer` using provided `StompServerOptions`. ### Methods #### `static StompServer create(Vertx vertx, StompServerOptions options)` Creates a `StompServer` based on the default Stomp Server implementation. #### `static StompServer create(Vertx vertx, NetServer net, StompServerOptions options)` Creates a `StompServer` based on the default Stomp Server implementation, using a provided `NetServer`. ``` -------------------------------- ### newInstance Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/mqtt/MqttServer.html Creates a new instance of MqttServer. ```APIDOC ## newInstance ### Description Creates a new instance of MqttServer. ### Method ```java public static MqttServer newInstance(MqttServer arg) ``` ### Parameters #### Path Parameters - **arg** (MqttServer) - Description not provided. ``` -------------------------------- ### ServiceImporter start Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/core/class-use/Vertx.html Starts the ServiceImporter with Vertx, publisher, configuration, and a future. ```APIDOC ## ServiceImporter start ### Description Starts the importer. ### Method `void` ### Parameters - **vertx** (Vertx) - The Vertx instance. - **publisher** (ServicePublisher) - The service publisher. - **configuration** (JsonObject) - The configuration object. - **future** (Promise) - The promise to be completed upon successful start. ### Endpoint N/A (SDK method) ``` -------------------------------- ### AppleIdAuth Instantiation Source: https://vertx.io/docs/apidocs/io/vertx/reactivex/ext/auth/oauth2/providers/class-use/AppleIdAuth.html Demonstrates how to create a new instance of AppleIdAuth. ```APIDOC ## AppleIdAuth.newInstance ### Description Creates a new instance of AppleIdAuth. ### Method `static AppleIdAuth newInstance(AppleIdAuth arg)` ### Parameters #### Path Parameters - **arg** (AppleIdAuth) - Required - The argument to initialize the new instance with. ```