Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeploymentOptions

Options for configuring a verticle deployment.

Hierarchy

  • DeploymentOptions

Index

Constructors

constructor

Methods

getClassLoader

  • getClassLoader(): any
  • Set the classloader to use for deploying the Verticle.

    The VerticleFactory will use this classloader for creating the Verticle and the Verticle Context will set this classloader as context classloader for the tasks execution on context.

    By default no classloader is required and the deployment will use the current thread context classloader.

    Returns any

getConfig

  • getConfig(): {}
  • Set the JSON configuration that will be passed to the verticle(s) when it's deployed

    Returns {}

    • [key: string]: any

getInstances

  • getInstances(): number
  • Set the number of instances that should be deployed.

    Returns number

getMaxWorkerExecuteTime

  • getMaxWorkerExecuteTime(): number

getMaxWorkerExecuteTimeUnit

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

    When the verticle does not use a #getWorkerPoolName() named worker pool, this option has no effect.

    Returns any

getWorkerPoolName

  • getWorkerPoolName(): string
  • Set the worker pool name to use for this verticle. When no name is set, the Vert.x worker pool will be used, when a name is set, the verticle will use a named worker pool.

    Returns string

getWorkerPoolSize

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

    When the verticle does not use a #getWorkerPoolName() named worker pool, this option has no effect.

    Returns number

isHa

  • isHa(): boolean
  • Set whether the verticle(s) will be deployed as HA.

    Returns boolean

isWorker

  • isWorker(): boolean
  • Set whether the verticle(s) should be deployed as a worker verticle

    Returns boolean

setClassLoader

  • Set the classloader to use for deploying the Verticle.

    The VerticleFactory will use this classloader for creating the Verticle and the Verticle Context will set this classloader as context classloader for the tasks execution on context.

    By default no classloader is required and the deployment will use the current thread context classloader.

    Parameters

    • classLoader: any

    Returns DeploymentOptions

setConfig

  • Set the JSON configuration that will be passed to the verticle(s) when it's deployed

    Parameters

    • config: {}
      • [key: string]: any

    Returns DeploymentOptions

setHa

  • Set whether the verticle(s) will be deployed as HA.

    Parameters

    • ha: boolean

    Returns DeploymentOptions

setInstances

  • Set the number of instances that should be deployed.

    Parameters

    • instances: number

    Returns DeploymentOptions

setMaxWorkerExecuteTime

setMaxWorkerExecuteTimeUnit

  • Set the time unit of maxWorkerExecuteTime

    When the verticle does not use a #getWorkerPoolName() named worker pool, this option has no effect.

    Parameters

    • maxWorkerExecuteTimeUnit: any

    Returns DeploymentOptions

setWorker

  • Set whether the verticle(s) should be deployed as a worker verticle

    Parameters

    • worker: boolean

    Returns DeploymentOptions

setWorkerPoolName

  • Set the worker pool name to use for this verticle. When no name is set, the Vert.x worker pool will be used, when a name is set, the verticle will use a named worker pool.

    Parameters

    • workerPoolName: string

    Returns DeploymentOptions

setWorkerPoolSize

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

    When the verticle does not use a #getWorkerPoolName() named worker pool, this option has no effect.

    Parameters

    • workerPoolSize: number

    Returns DeploymentOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc