| Modifier and Type | Field and Description |
|---|---|
| private ClassLoader | |
| private JsonObject | config
References Deprecated
JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.
|
| public static final boolean | |
| public static final int | |
| public static final ThreadingModel | |
| public static final boolean | |
| private List | |
| private boolean | |
| private int | |
| private List | |
| private String | |
| private long | |
| private TimeUnit | |
| private ThreadingModel | |
| private String | |
| private int |
| Access | Constructor and Description |
|---|---|
| public | |
| public | |
| public | DeploymentOptions(JsonObject
the JSON json)
References Deprecated
JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.
Constructor for creating a instance from JSON |
| Modifier and Type | Method and Description |
|---|---|
| public void | checkIsolationNotDefined()
Throw |
| public ClassLoader | |
| public JsonObject | Returns: the JSON config
References Deprecated
JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.
Get the JSON configuration that will be passed to the verticle(s) when deployed. |
| public List | Returns: any extra classpath
Deprecated
Get any extra classpath to be used when deploying the verticle. |
| public int | |
| public List | Returns: the list of isolated classes
Deprecated
Get the list of isolated class names, the names can be a Java class fully qualified name such as 'com.mycompany.myproject.engine.MyClass' or a wildcard matching such as `com.mycompany.myproject.*`. |
| public String | Returns: the isolation group
Deprecated
Get the isolation group that will be used when deploying the verticle(s) Important Note this feature is removed when running with Java 11 or above. |
| public long | Returns: The value of max worker execute time, the default value ofDeploymentOptions#setMaxWorkerExecuteTimeUnit maxWorkerExecuteTimeUnit is TimeUnit#NANOSECONDSGet the value of max worker execute time, in |
| public TimeUnit | Returns: the time unit ofmaxWorkerExecuteTimeWhen the verticle does not use a |
| public ThreadingModel | Returns: the verticle threading modelWhich threading model the verticle(s) should use? |
| public String | |
| public int | Returns: the maximum number of worker threadsGet the maximum number of worker threads to be used by the worker pool when the verticle is deployed
with a |
| public boolean | Returns: true if HA, false otherwiseWill the verticle(s) be deployed as HA (highly available) ? |
| public boolean | Returns: true if will be deployed as worker, false otherwise
Deprecated
instead use
getThreadingModel()
Should the verticle(s) be deployed as a worker verticle? |
| public DeploymentOptions | Returns: a reference to this, so the API can be used fluentlythe loader to use classLoader)Set the classloader to use for deploying the Verticle. |
| public DeploymentOptions | Returns: a reference to this, so the API can be used fluentlythe JSON config config)
References Deprecated
JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.
Set the JSON configuration that will be passed to the verticle(s) when it's deployed |
| public DeploymentOptions | Returns: a reference to this, so the API can be used fluently
Deprecated
Set any extra classpath to be used when deploying the verticle. |
| public DeploymentOptions | Returns: a reference to this, so the API can be used fluentlytrue if to be deployed as HA, false otherwise ha)Set whether the verticle(s) will be deployed as HA. |
| public DeploymentOptions | Returns: a reference to this, so the API can be used fluentlythe number of instances instances)Set the number of instances that should be deployed. |
| public DeploymentOptions | Returns: a reference to this, so the API can be used fluentlythe list of isolated class names isolatedClasses)
Deprecated
Set the isolated class names. |
| public DeploymentOptions | Returns: a reference to this, so the API can be used fluently- the isolation group isolationGroup)
Deprecated
Set the isolation group that will be used when deploying the verticle(s) Important Note this feature is removed when running with Java 11 or above. |
| public DeploymentOptions | Returns: a reference to this, so the API can be used fluentlythe value of max worker execute time, in in maxWorkerExecuteTime)maxWorkerExecuteTimeUnit.Sets the value of max worker execute time, in |
| public DeploymentOptions | Returns: a reference to this, so the API can be used fluentlythe time unit of maxWorkerExecuteTimeUnit)maxWorkerExecuteTimeSet the time unit of
When the verticle does not use a |
| public DeploymentOptions | Returns: a reference to this, so the API can be used fluentlythe threading model threadingModel)Set the verticle(s) verticle(s) threading model, e.g. a worker or a virtual thread verticle |
| public DeploymentOptions | Returns: a reference to this, so the API can be used fluentlytrue for worker, false force event-loop
Deprecated
instead use
setThreadingModel(ThreadingModel)
Set whether the verticle(s) should be deployed as a worker verticle |
| public DeploymentOptions | Returns: a reference to this, so the API can be used fluentlythe worker pool name workerPoolName)Set the worker pool name to use for this verticle. |
| public DeploymentOptions | Returns: a reference to this, so the API can be used fluentlythe number of threads workerPoolSize)Set the maximum number of worker threads to be used by the Vert.x instance. |
| public JsonObject | Returns: the JSON
References Deprecated
JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.
Convert this to JSON |
| classLoader | back to summary |
|---|---|
| private ClassLoader classLoader | |
| config | back to summary |
|---|---|
| private JsonObject config
References Deprecated
See corresponding docs for further information. | |
| DEFAULT_HA | back to summary |
|---|---|
| public static final boolean DEFAULT_HA | |
| DEFAULT_INSTANCES | back to summary |
|---|---|
| public static final int DEFAULT_INSTANCES | |
| DEFAULT_MODE | back to summary |
|---|---|
| public static final ThreadingModel DEFAULT_MODE | |
| DEFAULT_WORKER | back to summary |
|---|---|
| public static final boolean DEFAULT_WORKER | |
| extraClasspath | back to summary |
|---|---|
| private List<String> extraClasspath | |
| ha | back to summary |
|---|---|
| private boolean ha | |
| instances | back to summary |
|---|---|
| private int instances | |
| isolatedClasses | back to summary |
|---|---|
| private List<String> isolatedClasses | |
| isolationGroup | back to summary |
|---|---|
| private String isolationGroup | |
| maxWorkerExecuteTime | back to summary |
|---|---|
| private long maxWorkerExecuteTime | |
| maxWorkerExecuteTimeUnit | back to summary |
|---|---|
| private TimeUnit maxWorkerExecuteTimeUnit | |
| threadingModel | back to summary |
|---|---|
| private ThreadingModel threadingModel | |
| workerPoolName | back to summary |
|---|---|
| private String workerPoolName | |
| workerPoolSize | back to summary |
|---|---|
| private int workerPoolSize | |
| DeploymentOptions | back to summary |
|---|---|
| public DeploymentOptions() Default constructor | |
| DeploymentOptions | back to summary |
|---|---|
| public DeploymentOptions(DeploymentOptions other) Copy constructor
| |
| DeploymentOptions | back to summary |
|---|---|
| public DeploymentOptions(JsonObject json)
References Deprecated
See corresponding docs for further information. Constructor for creating a instance from JSON
| |
| checkIsolationNotDefined | back to summary |
|---|---|
| public void checkIsolationNotDefined() Throw | |
| getClassLoader | back to summary |
|---|---|
public ClassLoader getClassLoader()
| |
| getConfig | back to summary |
|---|---|
| public JsonObject getConfig()
References Deprecated
See corresponding docs for further information. Get the JSON configuration that will be passed to the verticle(s) when deployed.
| |
| getExtraClasspath | back to summary |
|---|---|
| public List Deprecated
Get any extra classpath to be used when deploying the verticle.
Ignored if no isolation group is set.
Important Note this feature is removed when running with Java 11 or above. | |
| getInstances | back to summary |
|---|---|
| public int getInstances() Get the number of instances that should be deployed.
| |
| getIsolatedClasses | back to summary |
|---|---|
| public List Deprecated
Get the list of isolated class names, the names can be a Java class fully qualified name such as
'com.mycompany.myproject.engine.MyClass' or a wildcard matching such as `com.mycompany.myproject.*`.
Important Note this feature is removed when running with Java 11 or above. | |
| getIsolationGroup | back to summary |
|---|---|
| public String getIsolationGroup()
Deprecated
Get the isolation group that will be used when deploying the verticle(s)
Important Note this feature is removed when running with Java 11 or above.
| |
| getMaxWorkerExecuteTime | back to summary |
|---|---|
| public long getMaxWorkerExecuteTime() Get the value of max worker execute time, in 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.
When the verticle does not use a
| |
| getMaxWorkerExecuteTimeUnit | back to summary |
|---|---|
| public TimeUnit getMaxWorkerExecuteTimeUnit() When the verticle does not use a
| |
| getThreadingModel | back to summary |
|---|---|
| public ThreadingModel getThreadingModel() Which threading model the verticle(s) should use?
| |
| getWorkerPoolName | back to summary |
|---|---|
public String getWorkerPoolName()
| |
| getWorkerPoolSize | back to summary |
|---|---|
| public int getWorkerPoolSize() Get the maximum number of worker threads to be used by the worker pool when the verticle is deployed
with a Worker threads are used for running blocking code and worker verticles.
When the verticle does not use a
| |
| isHa | back to summary |
|---|---|
| public boolean isHa() Will the verticle(s) be deployed as HA (highly available) ?
| |
| isWorker | back to summary |
|---|---|
| public boolean isWorker()
Deprecated instead use Should the verticle(s) be deployed as a worker verticle?
| |
| setClassLoader | back to summary |
|---|---|
| public DeploymentOptions setClassLoader(ClassLoader classLoader) Set the classloader to use for deploying the Verticle. The By default no classloader is required and the deployment will use the current thread context classloader.
| |
| setConfig | back to summary |
|---|---|
| public DeploymentOptions setConfig(JsonObject config)
References Deprecated
See corresponding docs for further information. Set the JSON configuration that will be passed to the verticle(s) when it's deployed
| |
| setExtraClasspath | back to summary |
|---|---|
| public DeploymentOptions setExtraClasspath(List<String> extraClasspath)
Deprecated
Set any extra classpath to be used when deploying the verticle.
Ignored if no isolation group is set.
Important Note this feature is removed when running with Java 11 or above.
| |
| setHa | back to summary |
|---|---|
| public DeploymentOptions setHa(boolean ha) Set whether the verticle(s) will be deployed as HA.
| |
| setInstances | back to summary |
|---|---|
| public DeploymentOptions setInstances(int instances) Set the number of instances that should be deployed.
| |
| setIsolatedClasses | back to summary |
|---|---|
| public DeploymentOptions setIsolatedClasses(List<String> isolatedClasses)
Deprecated
Set the isolated class names.
Important Note this feature is removed when running with Java 11 or above.
| |
| setIsolationGroup | back to summary |
|---|---|
| public DeploymentOptions setIsolationGroup(String isolationGroup)
Deprecated
Set the isolation group that will be used when deploying the verticle(s)
Important Note this feature is removed when running with Java 11 or above.
| |
| setMaxWorkerExecuteTime | back to summary |
|---|---|
| public DeploymentOptions setMaxWorkerExecuteTime(long maxWorkerExecuteTime) Sets the value of max worker execute time, in
The default value of
When the verticle does not use a
| |
| setMaxWorkerExecuteTimeUnit | back to summary |
|---|---|
| public DeploymentOptions setMaxWorkerExecuteTimeUnit(TimeUnit maxWorkerExecuteTimeUnit) Set the time unit of
When the verticle does not use a
| |
| setThreadingModel | back to summary |
|---|---|
| public DeploymentOptions setThreadingModel(ThreadingModel threadingModel) Set the verticle(s) verticle(s) threading model, e.g. a worker or a virtual thread verticle
| |
| setWorker | back to summary |
|---|---|
| public DeploymentOptions setWorker(boolean worker)
Deprecated instead use Set whether the verticle(s) should be deployed as a worker verticle
| |
| setWorkerPoolName | back to summary |
|---|---|
| public DeploymentOptions setWorkerPoolName(String workerPoolName) 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.
| |
| setWorkerPoolSize | back to summary |
|---|---|
| public DeploymentOptions setWorkerPoolSize(int workerPoolSize) Set the maximum number of worker threads to be used by the Vert.x instance.
When the verticle does not use a
| |
| toJson | back to summary |
|---|---|
| public JsonObject toJson()
References Deprecated
See corresponding docs for further information. Convert this to JSON
| |