Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VertxOptions

Instances of this class are used to configure Vertx instances.

Hierarchy

  • VertxOptions

Index

Constructors

constructor

  • Returns VertxOptions

  • Parameters

    Returns VertxOptions

Methods

getAddressResolverOptions

  • Sets the address resolver configuration to configure resolving DNS servers, cache TTL, etc...

    Returns AddressResolverOptions

getBlockedThreadCheckInterval

  • getBlockedThreadCheckInterval(): number

getBlockedThreadCheckIntervalUnit

  • getBlockedThreadCheckIntervalUnit(): any
  • Set the time unit of blockedThreadCheckInterval.

    Returns any

getClusterManager

  • getClusterManager(): any
  • 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.

    Returns any

getDisableTCCL

  • getDisableTCCL(): boolean
  • Configures whether Vert.x sets the Context classloader as the thread context classloader on actions executed on that Context.

    When a Context is created the current thread classloader is captured and associated with this classloader.

    Likewise when a Verticle is created, the Verticle's Context classloader is set to the current thread classloader unless this classloader is overriden by DeploymentOptions.

    This setting overrides the (legacy) system property vertx.disableTCCL and provides control at the Vertx instance level.

    Returns boolean

getEventBusOptions

  • Sets the event bus configuration to configure the host, port, ssl...

    Returns EventBusOptions

getEventLoopPoolSize

  • getEventLoopPoolSize(): number
  • Set the number of event loop threads to be used by the Vert.x instance.

    Returns number

getFileSystemOptions

  • Set the file system options

    Returns FileSystemOptions

getHAGroup

  • getHAGroup(): string
  • Set the HA group to be used when HA is enabled.

    Returns string

getInternalBlockingPoolSize

  • getInternalBlockingPoolSize(): number
  • Set the value of internal blocking pool size

    Returns number

getMaxEventLoopExecuteTime

  • getMaxEventLoopExecuteTime(): number

getMaxEventLoopExecuteTimeUnit

  • getMaxEventLoopExecuteTimeUnit(): any
  • Set the time unit of maxEventLoopExecuteTime.

    Returns any

getMaxWorkerExecuteTime

  • getMaxWorkerExecuteTime(): number

getMaxWorkerExecuteTimeUnit

  • getMaxWorkerExecuteTimeUnit(): any
  • Set the time unit of maxWorkerExecuteTime.

    Returns any

getMetricsOptions

  • Set the metrics options

    Returns MetricsOptions

getPreferNativeTransport

  • getPreferNativeTransport(): boolean
  • Set wether to prefer the native transport to the JDK transport.

    Returns boolean

getQuorumSize

  • getQuorumSize(): number
  • Set the quorum size to be used when HA is enabled.

    Returns number

getTracingOptions

  • Set the tracing options

    Returns TracingOptions

getUseDaemonThread

  • getUseDaemonThread(): boolean
  • Mark the vertx thread as daemon thread or user thread.

    For keeping the old behavior, the default value is false instead of null.

    Returns boolean

getWarningExceptionTime

  • getWarningExceptionTime(): number

getWarningExceptionTimeUnit

  • getWarningExceptionTimeUnit(): any
  • Set the time unit of warningExceptionTime.

    Returns any

getWorkerPoolSize

  • getWorkerPoolSize(): number
  • Set the maximum number of worker threads to be used by the Vert.x instance.

    Returns number

isHAEnabled

  • isHAEnabled(): boolean
  • Set whether HA will be enabled on the Vert.x instance.

    Returns boolean

setAddressResolverOptions

  • Sets the address resolver configuration to configure resolving DNS servers, cache TTL, etc...

    Parameters

    Returns VertxOptions

setBlockedThreadCheckInterval

  • setBlockedThreadCheckInterval(blockedThreadCheckInterval: number): VertxOptions

setBlockedThreadCheckIntervalUnit

  • setBlockedThreadCheckIntervalUnit(blockedThreadCheckIntervalUnit: any): VertxOptions
  • Set the time unit of blockedThreadCheckInterval.

    Parameters

    • blockedThreadCheckIntervalUnit: any

    Returns VertxOptions

setClusterManager

  • 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: any

    Returns VertxOptions

setDisableTCCL

  • Configures whether Vert.x sets the Context classloader as the thread context classloader on actions executed on that Context.

    When a Context is created the current thread classloader is captured and associated with this classloader.

    Likewise when a Verticle is created, the Verticle's Context classloader is set to the current thread classloader unless this classloader is overriden by DeploymentOptions.

    This setting overrides the (legacy) system property vertx.disableTCCL and provides control at the Vertx instance level.

    Parameters

    • disableTCCL: boolean

    Returns VertxOptions

setEventBusOptions

  • Sets the event bus configuration to configure the host, port, ssl...

    Parameters

    Returns VertxOptions

setEventLoopPoolSize

  • setEventLoopPoolSize(eventLoopPoolSize: number): VertxOptions
  • Set the number of event loop threads to be used by the Vert.x instance.

    Parameters

    • eventLoopPoolSize: number

    Returns VertxOptions

setFileSystemOptions

  • Set the file system options

    Parameters

    Returns VertxOptions

setHAEnabled

  • Set whether HA will be enabled on the Vert.x instance.

    Parameters

    • haEnabled: boolean

    Returns VertxOptions

setHAGroup

  • Set the HA group to be used when HA is enabled.

    Parameters

    • haGroup: string

    Returns VertxOptions

setInternalBlockingPoolSize

  • setInternalBlockingPoolSize(internalBlockingPoolSize: number): VertxOptions
  • Set the value of internal blocking pool size

    Parameters

    • internalBlockingPoolSize: number

    Returns VertxOptions

setMaxEventLoopExecuteTime

  • setMaxEventLoopExecuteTime(maxEventLoopExecuteTime: number): VertxOptions

setMaxEventLoopExecuteTimeUnit

  • setMaxEventLoopExecuteTimeUnit(maxEventLoopExecuteTimeUnit: any): VertxOptions
  • Set the time unit of maxEventLoopExecuteTime.

    Parameters

    • maxEventLoopExecuteTimeUnit: any

    Returns VertxOptions

setMaxWorkerExecuteTime

  • setMaxWorkerExecuteTime(maxWorkerExecuteTime: number): VertxOptions

setMaxWorkerExecuteTimeUnit

  • setMaxWorkerExecuteTimeUnit(maxWorkerExecuteTimeUnit: any): VertxOptions
  • Set the time unit of maxWorkerExecuteTime.

    Parameters

    • maxWorkerExecuteTimeUnit: any

    Returns VertxOptions

setMetricsOptions

  • Set the metrics options

    Parameters

    Returns VertxOptions

setPreferNativeTransport

  • setPreferNativeTransport(preferNativeTransport: boolean): VertxOptions
  • Set wether to prefer the native transport to the JDK transport.

    Parameters

    • preferNativeTransport: boolean

    Returns VertxOptions

setQuorumSize

  • Set the quorum size to be used when HA is enabled.

    Parameters

    • quorumSize: number

    Returns VertxOptions

setTracingOptions

  • Set the tracing options

    Parameters

    Returns VertxOptions

setUseDaemonThread

  • setUseDaemonThread(useDaemonThread: boolean): VertxOptions
  • Mark the vertx thread as daemon thread or user thread.

    For keeping the old behavior, the default value is false instead of null.

    Parameters

    • useDaemonThread: boolean

    Returns VertxOptions

setWarningExceptionTime

  • setWarningExceptionTime(warningExceptionTime: number): VertxOptions

setWarningExceptionTimeUnit

  • setWarningExceptionTimeUnit(warningExceptionTimeUnit: any): VertxOptions
  • Set the time unit of warningExceptionTime.

    Parameters

    • warningExceptionTimeUnit: any

    Returns VertxOptions

setWorkerPoolSize

  • Set the maximum number of worker threads to be used by the Vert.x instance.

    Parameters

    • workerPoolSize: number

    Returns VertxOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc