Modifier and Type | Method and Description |
---|---|
boolean |
conflates()
Gets whether the queue has conflation enabled by default.
|
int |
getLowerThreshold()
Gets the lower threshold.
|
long |
getMaximumBytes()
Gets the maximum size of the outbound message queue in bytes.
|
int |
getMaximumDepth()
Gets the maximum queue depth.
|
String |
getName()
Gets the queue definition name.
|
int |
getUpperThreshold()
Gets the upper threshold.
|
void |
setConflates(boolean conflates)
Sets whether the queue has conflation enabled by default.
|
void |
setLowerThreshold(int threshold)
Sets the lower threshold.
|
void |
setMaximumBytes(long maximumBytes)
Sets the maximum size of the outbound message queue in bytes.
|
void |
setMaximumDepth(int maximumDepth)
Sets the maximum depth of the queue.
|
void |
setUpperThreshold(int threshold)
Sets the upper threshold.
|
String getName()
void setMaximumDepth(int maximumDepth) throws ConfigException
If the queue depth exceeds this maximum, the server may attempt to free
some space by compacting the message queue. If the number of messages
queued remains above this maximum, the session will be closed to free
memory. If not specified, it defaults to Integer.MAX_VALUE
.
This is considered separately from
SessionConfig.getMaximumQueuedBytes()
and
getMaximumBytes()
.
maximumDepth
- the maximum queue depth, must be positiveConfigException
- if the property can not be setint getMaximumDepth()
void setConflates(boolean conflates) throws ConfigException
The default setting is true. Conflation can be enabled or disabled for individual sessions at runtime. The behavior when conflation is enabled is determined by the conflation policies of topics.
conflates
- true if the queue can be conflated by defaultConfigException
- if unable to set the conflates propertyboolean conflates()
void setUpperThreshold(int threshold) throws ConfigException
When the upper percentage of the queue reached, any queue listeners will be notified. This currently only has an effect server side.
By default the upper threshold will not be notified.
threshold
- the upper threshold percentage. A value of -1 means that
upper threshold will not be notified otherwise the value must be
in the range 1 to 100 and greater than the lower threshold.ConfigException
- if the property can not be setint getUpperThreshold()
void setLowerThreshold(int threshold) throws ConfigException
After an upper threshold event has occurred, this specifies the percentage queue size at which listeners for queue threshold notifications will be notified.
This only has an effect when used in conjunction with the upper threshold.
By default no lower threshold notification would occur.
threshold
- the lower threshold percentage. A value of -1 means that
lower threshold will not be notified otherwise the value must be
in the range 0 to 100 and less than the upper threshold.ConfigException
- if the property can not be setint getLowerThreshold()
void setMaximumBytes(long maximumBytes) throws ConfigException
If the number of bytes queued exceeds this maximum, the server may
attempt to free some memory by compacting the message queue. If the
number of bytes queued remains above this maximum, the session will be
closed to free memory. If not specified, it defaults to
Long.MAX_VALUE
.
This is considered separately from
SessionConfig.getMaximumQueuedBytes()
and
getMaximumDepth()
.
maximumBytes
- the maximum queue bytes, must be positiveConfigException
- if the property can not be setlong getMaximumBytes()
Copyright © 2021 Push Technology Ltd. All Rights Reserved.