Modifier and Type | Field and Description |
---|---|
static boolean |
DEFAULT_HA |
static int |
DEFAULT_INSTANCES |
static String |
DEFAULT_ISOLATION_GROUP |
static boolean |
DEFAULT_MULTI_THREADED |
static boolean |
DEFAULT_WORKER |
Constructor and Description |
---|
DeploymentOptions()
Default constructor
|
DeploymentOptions(DeploymentOptions other)
Copy constructor
|
DeploymentOptions(JsonObject json)
Constructor for creating a instance from JSON
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
void |
fromJson(JsonObject json)
Initialise the fields of this instance from the specified JSON
|
JsonObject |
getConfig()
Get the JSON configuration that will be passed to the verticle(s) when deployed.
|
List<String> |
getExtraClasspath()
Get any extra classpath to be used when deploying the verticle.
|
int |
getInstances()
Get the number of instances that should be deployed.
|
List<String> |
getIsolatedClasses()
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.*`.
|
String |
getIsolationGroup()
Get the isolation group that will be used when deploying the verticle(s)
|
long |
getMaxWorkerExecuteTime()
Get the value of max worker execute time, in
maxWorkerExecuteTimeUnit . |
TimeUnit |
getMaxWorkerExecuteTimeUnit() |
String |
getWorkerPoolName() |
int |
getWorkerPoolSize()
Get the maximum number of worker threads to be used by the worker pool when the verticle is deployed
with a
setWorkerPoolName(java.lang.String) . |
int |
hashCode() |
boolean |
isHa()
Will the verticle(s) be deployed as HA (highly available) ?
|
boolean |
isMultiThreaded()
Should the verticle(s) be deployed as a multi-threaded worker verticle?
|
boolean |
isWorker()
Should the verticle(s) be deployed as a worker verticle?
|
DeploymentOptions |
setConfig(JsonObject config)
Set the JSON configuration that will be passed to the verticle(s) when it's deployed
|
DeploymentOptions |
setExtraClasspath(List<String> extraClasspath)
Set any extra classpath to be used when deploying the verticle.
|
DeploymentOptions |
setHa(boolean ha)
Set whether the verticle(s) will be deployed as HA.
|
DeploymentOptions |
setInstances(int instances)
Set the number of instances that should be deployed.
|
DeploymentOptions |
setIsolatedClasses(List<String> isolatedClasses)
Set the isolated class names.
|
DeploymentOptions |
setIsolationGroup(String isolationGroup)
Set the isolation group that will be used when deploying the verticle(s)
|
DeploymentOptions |
setMaxWorkerExecuteTime(long maxWorkerExecuteTime)
Sets the value of max worker execute time, in
maxWorkerExecuteTimeUnit . |
DeploymentOptions |
setMaxWorkerExecuteTimeUnit(TimeUnit maxWorkerExecuteTimeUnit)
Set the time unit of
maxWorkerExecuteTime |
DeploymentOptions |
setMultiThreaded(boolean multiThreaded)
Deprecated.
as of 3.6.0
|
DeploymentOptions |
setWorker(boolean worker)
Set whether the verticle(s) should be deployed as a worker verticle
|
DeploymentOptions |
setWorkerPoolName(String workerPoolName)
Set the worker pool name to use for this verticle.
|
DeploymentOptions |
setWorkerPoolSize(int workerPoolSize)
Set the maximum number of worker threads to be used by the Vert.x instance.
|
JsonObject |
toJson()
Convert this to JSON
|
public static final boolean DEFAULT_WORKER
public static final boolean DEFAULT_MULTI_THREADED
public static final String DEFAULT_ISOLATION_GROUP
public static final boolean DEFAULT_HA
public static final int DEFAULT_INSTANCES
public DeploymentOptions()
public DeploymentOptions(DeploymentOptions other)
other
- the instance to copypublic DeploymentOptions(JsonObject json)
json
- the JSONpublic void fromJson(JsonObject json)
json
- the JSONpublic JsonObject getConfig()
public DeploymentOptions setConfig(JsonObject config)
config
- the JSON configpublic boolean isWorker()
public DeploymentOptions setWorker(boolean worker)
worker
- true for worker, false otherwisepublic boolean isMultiThreaded()
Ignored if isWorker()
is not true.
@Deprecated public DeploymentOptions setMultiThreaded(boolean multiThreaded)
WARNING: Multi-threaded worker verticles are a deprecated feature.
Most applications will have no need for them. Because of the concurrency in these verticles you have to be very careful to keep the verticle in a consistent state using standard Java techniques for multi-threaded programming.
You can read the documentation that explains how you can replace this feature by the usage of custom worker
pools or executeBlocking
calls.
multiThreaded
- true for multi-threaded worker, false otherwisepublic String getIsolationGroup()
public DeploymentOptions setIsolationGroup(String isolationGroup)
isolationGroup
- - the isolation grouppublic boolean isHa()
public DeploymentOptions setHa(boolean ha)
ha
- true if to be deployed as HA, false otherwisepublic List<String> getExtraClasspath()
Ignored if no isolation group is set.
public DeploymentOptions setExtraClasspath(List<String> extraClasspath)
Ignored if no isolation group is set.
public int getInstances()
public DeploymentOptions setInstances(int instances)
instances
- the number of instancespublic List<String> getIsolatedClasses()
public DeploymentOptions setIsolatedClasses(List<String> isolatedClasses)
isolatedClasses
- the list of isolated class namespublic String getWorkerPoolName()
public DeploymentOptions setWorkerPoolName(String workerPoolName)
workerPoolName
- the worker pool namepublic int getWorkerPoolSize()
setWorkerPoolName(java.lang.String)
. When the verticle does not use a named worker pool, this option
has no effect.
Worker threads are used for running blocking code and worker verticles.
public DeploymentOptions setWorkerPoolSize(int workerPoolSize)
workerPoolSize
- the number of threadspublic long getMaxWorkerExecuteTime()
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.
setMaxWorkerExecuteTimeUnit(java.util.concurrent.TimeUnit)
maxWorkerExecuteTimeUnit
is TimeUnit.NANOSECONDS
public DeploymentOptions setMaxWorkerExecuteTime(long maxWorkerExecuteTime)
maxWorkerExecuteTimeUnit
.
The default value of maxWorkerExecuteTimeUnit
is TimeUnit.NANOSECONDS
maxWorkerExecuteTime
- the value of max worker execute time, in in maxWorkerExecuteTimeUnit
.public TimeUnit getMaxWorkerExecuteTimeUnit()
maxWorkerExecuteTime
public DeploymentOptions setMaxWorkerExecuteTimeUnit(TimeUnit maxWorkerExecuteTimeUnit)
maxWorkerExecuteTime
maxWorkerExecuteTimeUnit
- the time unit of maxWorkerExecuteTime
public JsonObject toJson()
Copyright © 2023 Eclipse. All rights reserved.