io.vertx.kotlin.core.http.RequestOptions.kt Maven / Gradle / Ivy
/*
* Copyright 2019 Red Hat, Inc.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package io.vertx.kotlin.core.http
import io.vertx.core.http.RequestOptions
import io.vertx.core.net.Address
import io.vertx.core.net.ClientSSLOptions
import io.vertx.core.net.ProxyOptions
/**
* A function providing a DSL for building [io.vertx.core.http.RequestOptions] objects.
*
* Options describing how an [io.vertx.core.http.HttpClient] will connect to make a request.
*
* @param proxyOptions Override the [io.vertx.core.http.HttpClientOptions] proxy options for connections.
* @param server Set the server address to be used by the client request. When the server address is null, the address will be resolved after the host property by the Vert.x resolver.
Use this when you want to connect to a specific server address without name resolution.
* @param host Set the host name to be used by the client request.
* @param port Set the port to be used by the client request.
* @param ssl Set whether SSL/TLS is enabled.
* @param sslOptions Set the SSL options to use.
When none is provided, the client SSL options will be used instead.
* @param connectTimeout Sets the amount of time after which, if the request is not obtained from the client within the timeout period, the Future obtained from the client is failed with a [java.util.concurrent.TimeoutException]. Note this is not related to the TCP [io.vertx.core.http.HttpClientOptions] option, when a request is made against a pooled HTTP client, the timeout applies to the duration to obtain a connection from the pool to serve the request, the timeout might fire because the server does not respond in time or the pool is too busy to serve a request.
* @param uri Set the request relative URI.
* @param followRedirects Set whether to follow HTTP redirect
* @param timeout Sets both connect and idle timeouts for the request
- connect timeout: if the request is not obtained from the client within the timeout period, the
Future obtained from the client is failed with a [java.util.concurrent.TimeoutException]. - idle timeout: if the request does not return any data within the timeout period, the request/response is closed and the related futures are failed with a [java.util.concurrent.TimeoutException], e.g.
Future or Future response body.
The connect and idle timeouts can be set separately using [io.vertx.core.http.RequestOptions] and [io.vertx.core.http.RequestOptions]
* @param idleTimeout Sets the amount of time after which, if the request does not return any data within the timeout period, the request/response is closed and the related futures are failed with a [java.util.concurrent.TimeoutException], e.g. Future or Future response body. The timeout starts after a connection is obtained from the client, similar to calling [io.vertx.core.http.HttpClientRequest].
* @param absoluteURI Parse an absolute URI to use, this will update the ssl, host, port and uri fields.
* @param traceOperation Override the operation the tracer use for this request. When no operation is set, the HTTP method is used instead.
* @param routingKey Set the routing key, the routing key can be used by a Vert.x client side sticky load balancer to pin the request to a remote HTTP server.
*
*
* NOTE: This function has been automatically generated from the [io.vertx.core.http.RequestOptions original] using Vert.x codegen.
*/
fun requestOptionsOf(
proxyOptions: io.vertx.core.net.ProxyOptions? = null,
server: io.vertx.core.net.Address? = null,
host: String? = null,
port: Int? = null,
ssl: Boolean? = null,
sslOptions: io.vertx.core.net.ClientSSLOptions? = null,
connectTimeout: Long? = null,
uri: String? = null,
followRedirects: Boolean? = null,
timeout: Long? = null,
idleTimeout: Long? = null,
absoluteURI: String? = null,
traceOperation: String? = null,
routingKey: String? = null): RequestOptions = io.vertx.core.http.RequestOptions().apply {
if (proxyOptions != null) {
this.setProxyOptions(proxyOptions)
}
if (server != null) {
this.setServer(server)
}
if (host != null) {
this.setHost(host)
}
if (port != null) {
this.setPort(port)
}
if (ssl != null) {
this.setSsl(ssl)
}
if (sslOptions != null) {
this.setSslOptions(sslOptions)
}
if (connectTimeout != null) {
this.setConnectTimeout(connectTimeout)
}
if (uri != null) {
this.setURI(uri)
}
if (followRedirects != null) {
this.setFollowRedirects(followRedirects)
}
if (timeout != null) {
this.setTimeout(timeout)
}
if (idleTimeout != null) {
this.setIdleTimeout(idleTimeout)
}
if (absoluteURI != null) {
this.setAbsoluteURI(absoluteURI)
}
if (traceOperation != null) {
this.setTraceOperation(traceOperation)
}
if (routingKey != null) {
this.setRoutingKey(routingKey)
}
}