|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.citrusleaf.CitrusleafClient.ClScanningOptions
public static class CitrusleafClient.ClScanningOptions
Container object for optional parameters used in scan operations.
This object is passed in scan...()
calls to specify options.
null
may be passed to use defaults for all options.
Constructor Summary | |
---|---|
CitrusleafClient.ClScanningOptions()
Constructor, sets default scan options. |
Method Summary | |
---|---|
CitrusleafClient.ClScanningPriority |
getPriority()
Get server scan priority setting. |
int |
getThreadsPerNode()
Get number of client scan threads per node. |
boolean |
isConcurrentNodes()
Get concurrent nodes scan setting. |
boolean |
isFailOnClusterChange()
Get scan termination setting. |
void |
setConcurrentNodes(boolean concurrentNodes)
Specify concurrent nodes scan setting. |
void |
setFailOnClusterChange(boolean failOnClusterChange)
Specify scan termination setting. |
void |
setPriority(CitrusleafClient.ClScanningPriority priority)
Specify server scan priority setting. |
void |
setThreadsPerNode(int threadsPerNode)
Specify number of client scan threads per node - not yet supported. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CitrusleafClient.ClScanningOptions()
The object is constructed with concurrent nodes scan enabled, one
thread per node, scan priority CitrusleafClient.ClScanningPriority.AUTO
, and
scan termination on cluster changes disabled.
Method Detail |
---|
public boolean isConcurrentNodes()
true
if concurrent nodes scan
is enabled, false
if notpublic void setConcurrentNodes(boolean concurrentNodes)
concurrentNodes
- true
to enable concurrent nodes
scan, false
to disablepublic int getThreadsPerNode()
public void setThreadsPerNode(int threadsPerNode)
threadsPerNode
- number of client threads used to scan a nodepublic CitrusleafClient.ClScanningPriority getPriority()
scan priority
to
be used by serverpublic void setPriority(CitrusleafClient.ClScanningPriority priority)
priority
- scan priority
to
be used by serverpublic boolean isFailOnClusterChange()
true
if scan will terminate on
cluster change, false
if notpublic void setFailOnClusterChange(boolean failOnClusterChange)
failOnClusterChange
- true
to terminate scan on
cluster change, false
to
continue scan
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |