VertxOptions (Vert.x Stack - Docs 3.9.15 API)

java.lang.Object
- io.vertx.core.VertxOptions

```
public class VertxOptions
extends Object
```
Instances of this class are used to configure Vertx instances.

Author:

Tim Fox

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_BLOCKED_THREAD_CHECK_INTERVAL` The default value of blocked thread check interval = 1000 ms.
`static TimeUnit`	`DEFAULT_BLOCKED_THREAD_CHECK_INTERVAL_UNIT` The default value of blocked thread check interval unit = `TimeUnit.MILLISECONDS`
`static String`	`DEFAULT_CLUSTER_HOST` Deprecated. as of 3.7, use `EventBusOptions.DEFAULT_CLUSTER_HOST` instead
`static long`	`DEFAULT_CLUSTER_PING_INTERVAL` Deprecated. as of 3.7, use `EventBusOptions.DEFAULT_CLUSTER_PING_INTERVAL` instead
`static long`	`DEFAULT_CLUSTER_PING_REPLY_INTERVAL` Deprecated. as of 3.7, use `EventBusOptions.DEFAULT_CLUSTER_PING_REPLY_INTERVAL` instead
`static int`	`DEFAULT_CLUSTER_PORT` Deprecated. as of 3.7, use `EventBusOptions.DEFAULT_CLUSTER_PORT` instead
`static String`	`DEFAULT_CLUSTER_PUBLIC_HOST` Deprecated. as of 3.7, use `EventBusOptions.DEFAULT_CLUSTER_PUBLIC_HOST` instead
`static int`	`DEFAULT_CLUSTER_PUBLIC_PORT` Deprecated. as of 3.7, use `EventBusOptions.DEFAULT_CLUSTER_PUBLIC_PORT` instead
`static boolean`	`DEFAULT_CLUSTERED` Deprecated. as of 3.7, use `EventBusOptions.DEFAULT_CLUSTERED` instead
`static int`	`DEFAULT_EVENT_LOOP_POOL_SIZE` The default number of event loop threads to be used = 2 * number of cores on the machine
`static boolean`	`DEFAULT_HA_ENABLED` The default value of HA enabled = false
`static String`	`DEFAULT_HA_GROUP` The default value of Ha group is "__DEFAULT__"
`static int`	`DEFAULT_INTERNAL_BLOCKING_POOL_SIZE` The default number of threads in the internal blocking pool (used by some internal operations) = 20
`static long`	`DEFAULT_MAX_EVENT_LOOP_EXECUTE_TIME` The default value of max event loop execute time = 2000000000 ns (2 seconds)
`static TimeUnit`	`DEFAULT_MAX_EVENT_LOOP_EXECUTE_TIME_UNIT` The default value of max event loop execute time unit = `TimeUnit.NANOSECONDS`
`static long`	`DEFAULT_MAX_WORKER_EXECUTE_TIME` The default value of max worker execute time = 60000000000 ns (60 seconds)
`static TimeUnit`	`DEFAULT_MAX_WORKER_EXECUTE_TIME_UNIT` The default value of max worker execute time unit = `TimeUnit.NANOSECONDS`
`static boolean`	`DEFAULT_PREFER_NATIVE_TRANSPORT` The default value for preferring native transport = false
`static int`	`DEFAULT_QUORUM_SIZE` The default value of quorum size = 1
`static TimeUnit`	`DEFAULT_WARNING_EXCEPTION_TIME_UNIT` The default value of warning exception time unit = `TimeUnit.NANOSECONDS`
`static int`	`DEFAULT_WORKER_POOL_SIZE` The default number of threads in the worker pool = 20

Constructor Summary

Constructors
Constructor and Description
`VertxOptions()` Default constructor
`VertxOptions(JsonObject json)` Create an instance from a `JsonObject`
`VertxOptions(VertxOptions other)` Copy constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`AddressResolverOptions`	`getAddressResolverOptions()`
`long`	`getBlockedThreadCheckInterval()` Get the value of blocked thread check period, in `blockedThreadCheckIntervalUnit`.
`TimeUnit`	`getBlockedThreadCheckIntervalUnit()`
`String`	`getClusterHost()` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.getHost()` instead
`ClusterManager`	`getClusterManager()` Get the cluster manager to be used when clustering.
`long`	`getClusterPingInterval()` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.getClusterPingInterval()` instead
`long`	`getClusterPingReplyInterval()` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.getClusterPingReplyInterval()` instead
`int`	`getClusterPort()` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.getPort()` instead
`String`	`getClusterPublicHost()` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.getClusterPublicHost()` instead
`int`	`getClusterPublicPort()` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.getClusterPublicPort()` instead
`EventBusOptions`	`getEventBusOptions()`
`int`	`getEventLoopPoolSize()` Get the number of event loop threads to be used by the Vert.x instance.
`FileSystemOptions`	`getFileSystemOptions()`
`String`	`getHAGroup()` Get the HA group to be used when HA is enabled.
`int`	`getInternalBlockingPoolSize()` Get the value of internal blocking pool size.
`long`	`getMaxEventLoopExecuteTime()` Get the value of max event loop execute time, in `maxEventLoopExecuteTimeUnit`.
`TimeUnit`	`getMaxEventLoopExecuteTimeUnit()`
`long`	`getMaxWorkerExecuteTime()` Get the value of max worker execute time, in `maxWorkerExecuteTimeUnit`.
`TimeUnit`	`getMaxWorkerExecuteTimeUnit()`
`MetricsOptions`	`getMetricsOptions()`
`boolean`	`getPreferNativeTransport()`
`int`	`getQuorumSize()` Get the quorum size to be used when HA is enabled.
`long`	`getWarningExceptionTime()` Get the threshold value above this, the blocked warning contains a stack trace.
`TimeUnit`	`getWarningExceptionTimeUnit()`
`int`	`getWorkerPoolSize()` Get the maximum number of worker threads to be used by the Vert.x instance.
`int`	`hashCode()`
`boolean`	`isClustered()` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.isClustered()` instead
`boolean`	`isFileResolverCachingEnabled()` Deprecated. use `getFileSystemOptions().isFileCachingEnabled()` instead
`boolean`	`isHAEnabled()` Will HA be enabled on the Vert.x instance?
`VertxOptions`	`setAddressResolverOptions(AddressResolverOptions addressResolverOptions)` Sets the address resolver configuration to configure resolving DNS servers, cache TTL, etc...
`VertxOptions`	`setBlockedThreadCheckInterval(long blockedThreadCheckInterval)` Sets the value of blocked thread check period, in `blockedThreadCheckIntervalUnit`.
`VertxOptions`	`setBlockedThreadCheckIntervalUnit(TimeUnit blockedThreadCheckIntervalUnit)` Set the time unit of `blockedThreadCheckInterval`.
`VertxOptions`	`setClustered(boolean clustered)` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.setClustered(boolean)` instead
`VertxOptions`	`setClusterHost(String clusterHost)` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.setHost(String)` instead
`VertxOptions`	`setClusterManager(ClusterManager clusterManager)` Programmatically set the cluster manager to be used when clustering.
`VertxOptions`	`setClusterPingInterval(long clusterPingInterval)` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.setClusterPingInterval(long)` instead
`VertxOptions`	`setClusterPingReplyInterval(long clusterPingReplyInterval)` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.setClusterPingReplyInterval(long)` instead
`VertxOptions`	`setClusterPort(int clusterPort)` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.setPort(int)` instead
`VertxOptions`	`setClusterPublicHost(String clusterPublicHost)` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.setClusterPublicHost(String)` instead
`VertxOptions`	`setClusterPublicPort(int clusterPublicPort)` Deprecated. as of 3.7, use `getEventBusOptions()` and then `EventBusOptions.setClusterPublicPort(int)` instead
`VertxOptions`	`setEventBusOptions(EventBusOptions options)` Sets the event bus configuration to configure the host, port, ssl...
`VertxOptions`	`setEventLoopPoolSize(int eventLoopPoolSize)` Set the number of event loop threads to be used by the Vert.x instance.
`VertxOptions`	`setFileResolverCachingEnabled(boolean fileResolverCachingEnabled)` Deprecated. use `getFileSystemOptions().setFileCachingEnabled(val)` instead
`VertxOptions`	`setFileSystemOptions(FileSystemOptions fileSystemOptions)` Set the file system options
`VertxOptions`	`setHAEnabled(boolean haEnabled)` Set whether HA will be enabled on the Vert.x instance.
`VertxOptions`	`setHAGroup(String haGroup)` Set the HA group to be used when HA is enabled.
`VertxOptions`	`setInternalBlockingPoolSize(int internalBlockingPoolSize)` Set the value of internal blocking pool size
`VertxOptions`	`setMaxEventLoopExecuteTime(long maxEventLoopExecuteTime)` Sets the value of max event loop execute time, in `maxEventLoopExecuteTimeUnit`.
`VertxOptions`	`setMaxEventLoopExecuteTimeUnit(TimeUnit maxEventLoopExecuteTimeUnit)` Set the time unit of `maxEventLoopExecuteTime`.
`VertxOptions`	`setMaxWorkerExecuteTime(long maxWorkerExecuteTime)` Sets the value of max worker execute time, in `maxWorkerExecuteTimeUnit`.
`VertxOptions`	`setMaxWorkerExecuteTimeUnit(TimeUnit maxWorkerExecuteTimeUnit)` Set the time unit of `maxWorkerExecuteTime`.
`VertxOptions`	`setMetricsOptions(MetricsOptions metrics)` Set the metrics options
`VertxOptions`	`setPreferNativeTransport(boolean preferNativeTransport)` Set wether to prefer the native transport to the JDK transport.
`VertxOptions`	`setQuorumSize(int quorumSize)` Set the quorum size to be used when HA is enabled.
`VertxOptions`	`setWarningExceptionTime(long warningExceptionTime)` Set the threshold value above this, the blocked warning contains a stack trace.
`VertxOptions`	`setWarningExceptionTimeUnit(TimeUnit warningExceptionTimeUnit)` Set the time unit of `warningExceptionTime`.
`VertxOptions`	`setWorkerPoolSize(int workerPoolSize)` Set the maximum number of worker threads to be used by the Vert.x instance.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_EVENT_LOOP_POOL_SIZE
```
public static final int DEFAULT_EVENT_LOOP_POOL_SIZE
```
    The default number of event loop threads to be used = 2 * number of cores on the machine
  - DEFAULT_WORKER_POOL_SIZE
```
public static final int DEFAULT_WORKER_POOL_SIZE
```
    The default number of threads in the worker pool = 20
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INTERNAL_BLOCKING_POOL_SIZE
```
public static final int DEFAULT_INTERNAL_BLOCKING_POOL_SIZE
```
    The default number of threads in the internal blocking pool (used by some internal operations) = 20
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CLUSTERED
```
@Deprecated
public static final boolean DEFAULT_CLUSTERED
```
    Deprecated. as of 3.7, use EventBusOptions.DEFAULT_CLUSTERED instead
    
    The default value of whether Vert.x is clustered = false.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CLUSTER_HOST
```
@Deprecated
public static final String DEFAULT_CLUSTER_HOST
```
    Deprecated. as of 3.7, use EventBusOptions.DEFAULT_CLUSTER_HOST instead
    
    The default hostname to use when clustering = "localhost"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CLUSTER_PORT
```
@Deprecated
public static final int DEFAULT_CLUSTER_PORT
```
    Deprecated. as of 3.7, use EventBusOptions.DEFAULT_CLUSTER_PORT instead
    
    The default port to use when clustering = 0 (meaning assign a random port)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CLUSTER_PUBLIC_HOST
```
@Deprecated
public static final String DEFAULT_CLUSTER_PUBLIC_HOST
```
    Deprecated. as of 3.7, use EventBusOptions.DEFAULT_CLUSTER_PUBLIC_HOST instead
    
    The default cluster public host to use = null which means use the same as the cluster host
  - DEFAULT_CLUSTER_PUBLIC_PORT
```
@Deprecated
public static final int DEFAULT_CLUSTER_PUBLIC_PORT
```
    Deprecated. as of 3.7, use EventBusOptions.DEFAULT_CLUSTER_PUBLIC_PORT instead
    
    The default cluster public port to use = -1 which means use the same as the cluster port
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CLUSTER_PING_INTERVAL
```
@Deprecated
public static final long DEFAULT_CLUSTER_PING_INTERVAL
```
    Deprecated. as of 3.7, use EventBusOptions.DEFAULT_CLUSTER_PING_INTERVAL instead
    
    The default value of cluster ping interval = 20000 ms.
  - DEFAULT_CLUSTER_PING_REPLY_INTERVAL
```
@Deprecated
public static final long DEFAULT_CLUSTER_PING_REPLY_INTERVAL
```
    Deprecated. as of 3.7, use EventBusOptions.DEFAULT_CLUSTER_PING_REPLY_INTERVAL instead
    
    The default value of cluster ping reply interval = 20000 ms.
  - DEFAULT_BLOCKED_THREAD_CHECK_INTERVAL
```
public static final long DEFAULT_BLOCKED_THREAD_CHECK_INTERVAL
```
    The default value of blocked thread check interval = 1000 ms.
  - DEFAULT_BLOCKED_THREAD_CHECK_INTERVAL_UNIT
```
public static final TimeUnit DEFAULT_BLOCKED_THREAD_CHECK_INTERVAL_UNIT
```
    The default value of blocked thread check interval unit = TimeUnit.MILLISECONDS
  - DEFAULT_MAX_EVENT_LOOP_EXECUTE_TIME
```
public static final long DEFAULT_MAX_EVENT_LOOP_EXECUTE_TIME
```
    The default value of max event loop execute time = 2000000000 ns (2 seconds)
  - DEFAULT_MAX_EVENT_LOOP_EXECUTE_TIME_UNIT
```
public static final TimeUnit DEFAULT_MAX_EVENT_LOOP_EXECUTE_TIME_UNIT
```
    The default value of max event loop execute time unit = TimeUnit.NANOSECONDS
  - DEFAULT_MAX_WORKER_EXECUTE_TIME
```
public static final long DEFAULT_MAX_WORKER_EXECUTE_TIME
```
    The default value of max worker execute time = 60000000000 ns (60 seconds)
  - DEFAULT_MAX_WORKER_EXECUTE_TIME_UNIT
```
public static final TimeUnit DEFAULT_MAX_WORKER_EXECUTE_TIME_UNIT
```
    The default value of max worker execute time unit = TimeUnit.NANOSECONDS
  - DEFAULT_QUORUM_SIZE
```
public static final int DEFAULT_QUORUM_SIZE
```
    The default value of quorum size = 1
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HA_GROUP
```
public static final String DEFAULT_HA_GROUP
```
    The default value of Ha group is "__DEFAULT__"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HA_ENABLED
```
public static final boolean DEFAULT_HA_ENABLED
```
    The default value of HA enabled = false
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PREFER_NATIVE_TRANSPORT
```
public static final boolean DEFAULT_PREFER_NATIVE_TRANSPORT
```
    The default value for preferring native transport = false
    
    See Also:
    
    Constant Field Values
  - DEFAULT_WARNING_EXCEPTION_TIME_UNIT
```
public static final TimeUnit DEFAULT_WARNING_EXCEPTION_TIME_UNIT
```
    The default value of warning exception time unit = TimeUnit.NANOSECONDS
- Constructor Detail
  - VertxOptions
```
public VertxOptions()
```
    Default constructor
  - VertxOptions
```
public VertxOptions(VertxOptions other)
```
    Copy constructor
    
    Parameters:
    
    other - The other VertxOptions to copy when creating this
  - VertxOptions
```
public VertxOptions(JsonObject json)
```
    Create an instance from a JsonObject
    
    Parameters:
    
    json - the JsonObject to create it from
- Method Detail
  - getEventLoopPoolSize
```
public int getEventLoopPoolSize()
```
    Get the number of event loop threads to be used by the Vert.x instance.
    
    Returns:
    
    the number of threads
  - setEventLoopPoolSize
```
public VertxOptions setEventLoopPoolSize(int eventLoopPoolSize)
```
    Set the number of event loop threads to be used by the Vert.x instance.
    
    Parameters:
    
    eventLoopPoolSize - the number of threads
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getWorkerPoolSize
```
public int getWorkerPoolSize()
```
    Get the maximum number of worker threads to be used by the Vert.x instance.
    Worker threads are used for running blocking code and worker verticles.
    
    Returns:
    
    the maximum number of worker threads
  - setWorkerPoolSize
```
public VertxOptions setWorkerPoolSize(int workerPoolSize)
```
    Set the maximum number of worker threads to be used by the Vert.x instance.
    
    Parameters:
    
    workerPoolSize - the number of threads
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - isClustered
```
@Deprecated
public boolean isClustered()
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.isClustered() instead
    
    Is the Vert.x instance clustered?
    
    Returns:
    
    true if clustered, false if not
  - setClustered
```
@Deprecated
public VertxOptions setClustered(boolean clustered)
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.setClustered(boolean) instead
    
    Set whether or not the Vert.x instance will be clustered.
    
    Parameters:
    
    clustered - if true, the Vert.x instance will be clustered, otherwise not
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getClusterHost
```
@Deprecated
public String getClusterHost()
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.getHost() instead
    
    Get the host name to be used for clustering.
    
    Returns:
    
    The host name
  - setClusterHost
```
@Deprecated
public VertxOptions setClusterHost(String clusterHost)
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.setHost(String) instead
    
    Set the hostname to be used for clustering.
    
    Parameters:
    
    clusterHost - the host name to use
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getClusterPublicHost
```
@Deprecated
public String getClusterPublicHost()
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.getClusterPublicHost() instead
    
    Get the public facing hostname to be used when clustering.
    
    Returns:
    
    the public facing hostname
  - setClusterPublicHost
```
@Deprecated
public VertxOptions setClusterPublicHost(String clusterPublicHost)
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.setClusterPublicHost(String) instead
    
    Set the public facing hostname to be used for clustering. Sometimes, e.g. when running on certain clouds, the local address the server listens on for clustering is not the same address that other nodes connect to it at, as the OS / cloud infrastructure does some kind of proxying. If this is the case you can specify a public hostname which is different from the hostname the server listens at. The default value is null which means use the same as the cluster hostname.
    
    Parameters:
    
    clusterPublicHost - the public host name to use
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getClusterPort
```
@Deprecated
public int getClusterPort()
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.getPort() instead
    
    Get the port to be used for clustering
    
    Returns:
    
    the port
  - setClusterPort
```
@Deprecated
public VertxOptions setClusterPort(int clusterPort)
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.setPort(int) instead
    
    Set the port to be used for clustering.
    
    Parameters:
    
    clusterPort - the port
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getClusterPublicPort
```
@Deprecated
public int getClusterPublicPort()
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.getClusterPublicPort() instead
    
    Get the public facing port to be used when clustering.
    
    Returns:
    
    the public facing port
  - setClusterPublicPort
```
@Deprecated
public VertxOptions setClusterPublicPort(int clusterPublicPort)
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.setClusterPublicPort(int) instead
    
    See setClusterPublicHost(String) for an explanation.
    
    Parameters:
    
    clusterPublicPort - the public port to use
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getClusterPingInterval
```
@Deprecated
public long getClusterPingInterval()
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.getClusterPingInterval() instead
    
    Get the value of cluster ping interval, in ms.
    Nodes in the cluster ping each other at this interval to determine whether they are still running.
    
    Returns:
    
    The value of cluster ping interval
  - setClusterPingInterval
```
@Deprecated
public VertxOptions setClusterPingInterval(long clusterPingInterval)
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.setClusterPingInterval(long) instead
    
    Set the value of cluster ping interval, in ms.
    
    Parameters:
    
    clusterPingInterval - The value of cluster ping interval, in ms.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getClusterPingReplyInterval
```
@Deprecated
public long getClusterPingReplyInterval()
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.getClusterPingReplyInterval() instead
    
    Get the value of cluster ping reply interval, in ms.
    After sending a ping, if a pong is not received in this time, the node will be considered dead.
    
    Returns:
    
    the value of cluster ping reply interval
  - setClusterPingReplyInterval
```
@Deprecated
public VertxOptions setClusterPingReplyInterval(long clusterPingReplyInterval)
```
    Deprecated. as of 3.7, use getEventBusOptions() and then EventBusOptions.setClusterPingReplyInterval(long) instead
    
    Set the value of cluster ping reply interval, in ms.
    
    Parameters:
    
    clusterPingReplyInterval - The value of cluster ping reply interval, in ms.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getBlockedThreadCheckInterval
```
public long getBlockedThreadCheckInterval()
```
    Get the value of blocked thread check period, in blockedThreadCheckIntervalUnit.
    This setting determines how often Vert.x will check whether event loop threads are executing for too long.
    The default value of blockedThreadCheckIntervalUnit is TimeUnit.MILLISECONDS.
    
    Returns:
    
    the value of blocked thread check period, in blockedThreadCheckIntervalUnit.
  - setBlockedThreadCheckInterval
```
public VertxOptions setBlockedThreadCheckInterval(long blockedThreadCheckInterval)
```
    Sets the value of blocked thread check period, in blockedThreadCheckIntervalUnit.
    The default value of blockedThreadCheckIntervalUnit is TimeUnit.MILLISECONDS
    
    Parameters:
    
    blockedThreadCheckInterval - the value of blocked thread check period, in blockedThreadCheckIntervalUnit.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getMaxEventLoopExecuteTime
```
public long getMaxEventLoopExecuteTime()
```
    Get the value of max event loop execute time, in maxEventLoopExecuteTimeUnit.
    Vert.x will automatically log a warning if it detects that event loop threads haven't returned within this time.
    This can be used to detect where the user is blocking an event loop thread, contrary to the Golden Rule of the holy Event Loop.
    The default value of maxEventLoopExecuteTimeUnit is TimeUnit.NANOSECONDS
    
    Returns:
    
    the value of max event loop execute time, in maxEventLoopExecuteTimeUnit.
  - setMaxEventLoopExecuteTime
```
public VertxOptions setMaxEventLoopExecuteTime(long maxEventLoopExecuteTime)
```
    Sets the value of max event loop execute time, in maxEventLoopExecuteTimeUnit.
    The default value of maxEventLoopExecuteTimeUnitis TimeUnit.NANOSECONDS
    
    Parameters:
    
    maxEventLoopExecuteTime - the value of max event loop execute time, in maxEventLoopExecuteTimeUnit.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getMaxWorkerExecuteTime
```
public long getMaxWorkerExecuteTime()
```
    Get the value of max worker execute time, in maxWorkerExecuteTimeUnit.
    Vert.x will automatically log a warning if it detects that worker threads haven't returned within this time.
    This can be used to detect where the user is blocking a worker thread for too long. Although worker threads can be blocked longer than event loop threads, they shouldn't be blocked for long periods of time.
    The default value of maxWorkerExecuteTimeUnit is TimeUnit.NANOSECONDS
    
    Returns:
    
    The value of max worker execute time, in maxWorkerExecuteTimeUnit.
  - setMaxWorkerExecuteTime
```
public VertxOptions setMaxWorkerExecuteTime(long maxWorkerExecuteTime)
```
    Sets the value of max worker execute time, in maxWorkerExecuteTimeUnit.
    The default value of maxWorkerExecuteTimeUnit is TimeUnit.NANOSECONDS
    
    Parameters:
    
    maxWorkerExecuteTime - the value of max worker execute time, in maxWorkerExecuteTimeUnit.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getClusterManager
```
public ClusterManager getClusterManager()
```
    Get the cluster manager to be used when clustering.
    If the cluster manager has been programmatically set here, then that will be used when clustering.
    Otherwise Vert.x attempts to locate a cluster manager on the classpath.
    
    Returns:
    
    the cluster manager.
  - setClusterManager
```
public VertxOptions setClusterManager(ClusterManager clusterManager)
```
    Programmatically set the cluster manager to be used when clustering.
    Only valid if clustered = true.
    Normally Vert.x will look on the classpath for a cluster manager, but if you want to set one programmatically you can use this method.
    
    Parameters:
    
    clusterManager - the cluster manager
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getInternalBlockingPoolSize
```
public int getInternalBlockingPoolSize()
```
    Get the value of internal blocking pool size.
    Vert.x maintains a pool for internal blocking operations
    
    Returns:
    
    the value of internal blocking pool size
  - setInternalBlockingPoolSize
```
public VertxOptions setInternalBlockingPoolSize(int internalBlockingPoolSize)
```
    Set the value of internal blocking pool size
    
    Parameters:
    
    internalBlockingPoolSize - the maximumn number of threads in the internal blocking pool
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - isHAEnabled
```
public boolean isHAEnabled()
```
    Will HA be enabled on the Vert.x instance?
    
    Returns:
    
    true if HA enabled, false otherwise
  - setHAEnabled
```
public VertxOptions setHAEnabled(boolean haEnabled)
```
    Set whether HA will be enabled on the Vert.x instance.
    
    Parameters:
    
    haEnabled - true if enabled, false if not.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getQuorumSize
```
public int getQuorumSize()
```
    Get the quorum size to be used when HA is enabled.
    
    Returns:
    
    the quorum size
  - setQuorumSize
```
public VertxOptions setQuorumSize(int quorumSize)
```
    Set the quorum size to be used when HA is enabled.
    
    Parameters:
    
    quorumSize - the quorum size
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getHAGroup
```
public String getHAGroup()
```
    Get the HA group to be used when HA is enabled.
    
    Returns:
    
    the HA group
  - setHAGroup
```
public VertxOptions setHAGroup(String haGroup)
```
    Set the HA group to be used when HA is enabled.
    
    Parameters:
    
    haGroup - the HA group to use
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getMetricsOptions
```
public MetricsOptions getMetricsOptions()
```
    Returns:
    
    the metrics options
  - getFileSystemOptions
```
public FileSystemOptions getFileSystemOptions()
```
    Returns:
    
    the file system options
  - setMetricsOptions
```
public VertxOptions setMetricsOptions(MetricsOptions metrics)
```
    Set the metrics options
    
    Parameters:
    
    metrics - the options
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setFileSystemOptions
```
public VertxOptions setFileSystemOptions(FileSystemOptions fileSystemOptions)
```
    Set the file system options
    
    Parameters:
    
    fileSystemOptions - the options
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getWarningExceptionTime
```
public long getWarningExceptionTime()
```
    Get the threshold value above this, the blocked warning contains a stack trace. in warningExceptionTimeUnit.
    The default value of warningExceptionTimeUnit is TimeUnit.NANOSECONDS
    
    Returns:
    
    the warning exception time threshold
  - setWarningExceptionTime
```
public VertxOptions setWarningExceptionTime(long warningExceptionTime)
```
    Set the threshold value above this, the blocked warning contains a stack trace. in warningExceptionTimeUnit. The default value of warningExceptionTimeUnit is TimeUnit.NANOSECONDS
    
    Parameters:
    
    warningExceptionTime -
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getEventBusOptions
```
public EventBusOptions getEventBusOptions()
```
    Returns:
    
    the event bus option to configure the event bus communication (host, port, ssl...)
  - setEventBusOptions
```
public VertxOptions setEventBusOptions(EventBusOptions options)
```
    Sets the event bus configuration to configure the host, port, ssl...
    
    Parameters:
    
    options - the event bus options
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getAddressResolverOptions
```
public AddressResolverOptions getAddressResolverOptions()
```
    Returns:
    
    the address resolver options to configure resolving DNS servers, cache TTL, etc...
  - setAddressResolverOptions
```
public VertxOptions setAddressResolverOptions(AddressResolverOptions addressResolverOptions)
```
    Sets the address resolver configuration to configure resolving DNS servers, cache TTL, etc...
    
    Parameters:
    
    addressResolverOptions - the address resolver options
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - isFileResolverCachingEnabled
```
@Deprecated
public boolean isFileResolverCachingEnabled()
```
    Deprecated. use getFileSystemOptions().isFileCachingEnabled() instead
    
    Returns:
    
    whether the file resolver uses caching
  - setFileResolverCachingEnabled
```
@Deprecated
public VertxOptions setFileResolverCachingEnabled(boolean fileResolverCachingEnabled)
```
    Deprecated. use getFileSystemOptions().setFileCachingEnabled(val) instead
    
    Set whether the Vert.x file resolver uses caching for classpath resources.
    
    Parameters:
    
    fileResolverCachingEnabled - true when the file resolver caches resources
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getPreferNativeTransport
```
public boolean getPreferNativeTransport()
```
    Returns:
    
    wether to prefer the native transport to the JDK transport
  - setPreferNativeTransport
```
public VertxOptions setPreferNativeTransport(boolean preferNativeTransport)
```
    Set wether to prefer the native transport to the JDK transport.
    
    Parameters:
    
    preferNativeTransport - true to prefer the native transport
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getMaxEventLoopExecuteTimeUnit
```
public TimeUnit getMaxEventLoopExecuteTimeUnit()
```
    Returns:
    
    the time unit of maxEventLoopExecuteTime
  - setMaxEventLoopExecuteTimeUnit
```
public VertxOptions setMaxEventLoopExecuteTimeUnit(TimeUnit maxEventLoopExecuteTimeUnit)
```
    Set the time unit of maxEventLoopExecuteTime.
    
    Parameters:
    
    maxEventLoopExecuteTimeUnit - the time unit of maxEventLoopExecuteTime
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getMaxWorkerExecuteTimeUnit
```
public TimeUnit getMaxWorkerExecuteTimeUnit()
```
    Returns:
    
    the time unit of maxWorkerExecuteTime
  - setMaxWorkerExecuteTimeUnit
```
public VertxOptions setMaxWorkerExecuteTimeUnit(TimeUnit maxWorkerExecuteTimeUnit)
```
    Set the time unit of maxWorkerExecuteTime.
    
    Parameters:
    
    maxWorkerExecuteTimeUnit - the time unit of maxWorkerExecuteTime
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getWarningExceptionTimeUnit
```
public TimeUnit getWarningExceptionTimeUnit()
```
    Returns:
    
    the time unit of warningExceptionTime
  - setWarningExceptionTimeUnit
```
public VertxOptions setWarningExceptionTimeUnit(TimeUnit warningExceptionTimeUnit)
```
    Set the time unit of warningExceptionTime.
    
    Parameters:
    
    warningExceptionTimeUnit - the time unit of warningExceptionTime
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getBlockedThreadCheckIntervalUnit
```
public TimeUnit getBlockedThreadCheckIntervalUnit()
```
    Returns:
    
    the time unit of blockedThreadCheckInterval
  - setBlockedThreadCheckIntervalUnit
```
public VertxOptions setBlockedThreadCheckIntervalUnit(TimeUnit blockedThreadCheckIntervalUnit)
```
    Set the time unit of blockedThreadCheckInterval.
    
    Parameters:
    
    blockedThreadCheckIntervalUnit - the time unit of warningExceptionTime
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class VertxOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_EVENT_LOOP_POOL_SIZE

DEFAULT_WORKER_POOL_SIZE

DEFAULT_INTERNAL_BLOCKING_POOL_SIZE

DEFAULT_CLUSTERED

DEFAULT_CLUSTER_HOST

DEFAULT_CLUSTER_PORT

DEFAULT_CLUSTER_PUBLIC_HOST

DEFAULT_CLUSTER_PUBLIC_PORT

DEFAULT_CLUSTER_PING_INTERVAL

DEFAULT_CLUSTER_PING_REPLY_INTERVAL

DEFAULT_BLOCKED_THREAD_CHECK_INTERVAL

DEFAULT_BLOCKED_THREAD_CHECK_INTERVAL_UNIT

DEFAULT_MAX_EVENT_LOOP_EXECUTE_TIME

DEFAULT_MAX_EVENT_LOOP_EXECUTE_TIME_UNIT

DEFAULT_MAX_WORKER_EXECUTE_TIME

DEFAULT_MAX_WORKER_EXECUTE_TIME_UNIT

DEFAULT_QUORUM_SIZE

DEFAULT_HA_GROUP

DEFAULT_HA_ENABLED

DEFAULT_PREFER_NATIVE_TRANSPORT

DEFAULT_WARNING_EXCEPTION_TIME_UNIT

Constructor Detail

VertxOptions

VertxOptions

VertxOptions

Method Detail

getEventLoopPoolSize

setEventLoopPoolSize

getWorkerPoolSize

setWorkerPoolSize

isClustered

setClustered

getClusterHost

setClusterHost

getClusterPublicHost

setClusterPublicHost

getClusterPort

setClusterPort

getClusterPublicPort

setClusterPublicPort

getClusterPingInterval

setClusterPingInterval

getClusterPingReplyInterval

setClusterPingReplyInterval

getBlockedThreadCheckInterval

setBlockedThreadCheckInterval

getMaxEventLoopExecuteTime

setMaxEventLoopExecuteTime

getMaxWorkerExecuteTime

setMaxWorkerExecuteTime

getClusterManager

setClusterManager

getInternalBlockingPoolSize

setInternalBlockingPoolSize

isHAEnabled

setHAEnabled

getQuorumSize

setQuorumSize

getHAGroup

setHAGroup

getMetricsOptions

getFileSystemOptions

setMetricsOptions

setFileSystemOptions

getWarningExceptionTime

setWarningExceptionTime

getEventBusOptions

setEventBusOptions

getAddressResolverOptions

setAddressResolverOptions

isFileResolverCachingEnabled

setFileResolverCachingEnabled

getPreferNativeTransport

setPreferNativeTransport