com.solacesystems.jcsmp

Class JCSMPGlobalProperties

java.lang.Object

com.solacesystems.jcsmp.JCSMPGlobalProperties

All Implemented Interfaces:

Serializable, Cloneable

public class JCSMPGlobalProperties
extends Object
implements Cloneable, Serializable

This class exposes tunable settings for some of the Messaging API's internal functionality. A JCSMPGlobalProperties instance, once populated, must be set on JCSMPFactory, as in the following example:

 JCSMPGlobalProperties gp = new JCSMPGlobalProperties();
 // override default properties
 gp.setConsumerDispatcherQueueSize(10000);
 JCSMPFactory.onlyInstance().setGlobalProperties(gp);
 

Global properties may only be set before any sessions have been created from the JCSMPFactory.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JCSMPGlobalProperties() Constructs a new instance with default values.

Method Summary

Modifier and Type	Method and Description
Object	clone()
int	getConsumerDefaultFlowCongestionLimit() Gets the default consumer's congestion limit.
int	getConsumerDefaultFlowUncongestedLimit() Gets the default consumer's uncongested threshold (calculated as 0.2 * getConsumerDefaultFlowCongestionLimit()).
int	getConsumerDispatcherQueueSize() Gets the size of the consumer notification dispatcher queue.
int	getContentBufferResizeMultiplier() Get content buffer resize multiplier.
int	getContentBufferSizeDefault() Get content buffer size default
int	getProducerDispatcherQueueSize() Gets the size of the producer notification dispatcher queue.
int	getReconnectFreqManagerMaxReconnects() Gets the maximum number of reconnects to allow before the reconnect frequency manager kills a connection.
void	setConsumerDefaultFlowCongestionLimit(int consumerDefaultFlowCongestionLimit) Sets the the default consumer's congestion limit.
void	setConsumerDispatcherQueueSize(int consumerDispatcherQueueSize) Sets the size of the consumer notification dispatcher queue.
void	setContentBufferResizeMultiplier(int multiplier) Set content buffer multiplier (the default is 25).
void	setContentBufferSizeDefault(int sz) Set content buffer size default (the default is 4096).
void	setProducerDispatcherQueueSize(int producerDispatcherQueueSize) Sets the size of the producer notification dispatcher queue.
void	setReconnectFreqManagerMaxReconnects(int reconnectFreqManagerMaxReconnects) Sets the maximum number of reconnects to allow before the reconnect frequency manager kills a connection.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JCSMPGlobalProperties

public JCSMPGlobalProperties()

Constructs a new instance with default values.

Method Detail

clone

public Object clone()

Overrides:

clone in class Object

getProducerDispatcherQueueSize

public int getProducerDispatcherQueueSize()

Gets the size of the producer notification dispatcher queue.

Returns:

The size of the producer notification dispatcher queue.

See Also:

JCSMPGlobalProperties.setProducerDispatcherQueueSize(int)

setProducerDispatcherQueueSize

public void setProducerDispatcherQueueSize(int producerDispatcherQueueSize)

Sets the size of the producer notification dispatcher queue. (The default is 2000 elements.)

The producer notification dispatcher queue is used by the API to notify streaming producers of message acknowledgements and message publishing exceptions through their JCSMPStreamingPublishCorrelatingEventHandler. Internal API threads append notifications to the queue, blocking, if necessary, until space is available. There is one such queue per Context.

Parameters:

producerDispatcherQueueSize - The queue size.

getConsumerDispatcherQueueSize

public int getConsumerDispatcherQueueSize()

Gets the size of the consumer notification dispatcher queue.

Returns:

The size of the consumer notification dispatcher queue.

See Also:

JCSMPGlobalProperties.setConsumerDispatcherQueueSize(int)

setConsumerDispatcherQueueSize

public void setConsumerDispatcherQueueSize(int consumerDispatcherQueueSize)

Sets the size of the consumer notification dispatcher queue. (The default is 75000 elements.)

The API uses the consumer notification dispatcher queue to notify asynchronous consumers of messages and exceptions through their XMLMessageListener. Internal API threads append notifications to the queue, blocking if necessary until space is available. There is one such queue per Context.

Best Practices

The API allocates a thread to service this queue and dispatch notifications to an application's XMLMessageListeners. If an XMLMessageListener does not always return control quickly and the notification queue fills up, then other API threads can become blocked when attempting to enqueue notifications to this queue.

To avoid this possibility, applications should ensure this queue is large enough to buffer the maximum number of notifications that can be generated by all consumer flows (guaranteed flows as well as direct consumers) contained in all sessions in a Context, i.e.,

    queueSize > Σ (f.windowSize) + (FCL * Nconsumers)
               f ∈ GDFlows
 

Where

    GDFlows  : Set of all guaranteed delivery consumer flows in a Context
    FCL      : Default consumer flow congestion limit
    Nconsumers: Number of direct consumers in a Context
 

Parameters:

consumerDispatcherQueueSize - queue size

getConsumerDefaultFlowCongestionLimit

public int getConsumerDefaultFlowCongestionLimit()

Gets the default consumer's congestion limit.

Returns:

The congestion limit for the default consumer.

See Also:

JCSMPGlobalProperties.setConsumerDefaultFlowCongestionLimit(int)

setConsumerDefaultFlowCongestionLimit

public void setConsumerDefaultFlowCongestionLimit(int consumerDefaultFlowCongestionLimit)

Sets the the default consumer's congestion limit. (The default is 5000 elements.)

If a JCSMPXMLMessageConsumer accumulates more than this number of messages not yet handled by the consuming application, it will temporarily suspend reading from the underlying TCP connection.

Parameters:

consumerDefaultFlowCongestionLimit - The new congestion limit to set.

getConsumerDefaultFlowUncongestedLimit

public int getConsumerDefaultFlowUncongestedLimit()

Gets the default consumer's uncongested threshold (calculated as 0.2 * getConsumerDefaultFlowCongestionLimit()).

Returns:

The uncongested threshold for the default consumer.

getReconnectFreqManagerMaxReconnects

public int getReconnectFreqManagerMaxReconnects()

Gets the maximum number of reconnects to allow before the reconnect frequency manager kills a connection.

Returns:

The maximum number of reconnects to allow before killing a connection.

See Also:

JCSMPGlobalProperties.setReconnectFreqManagerMaxReconnects(int)

setReconnectFreqManagerMaxReconnects

public void setReconnectFreqManagerMaxReconnects(int reconnectFreqManagerMaxReconnects)

Sets the maximum number of reconnects to allow before the reconnect frequency manager kills a connection. (The default is 10.)

To prevent competing clients with the same name kicking each other out from the appliance indefinitely, the Messaging API kills connections when they reconnect too fast to the appliance. This is normally due to a misconfiguration of application connection and authentication parameters.

The threshold is the configured number of reconnections allowed in a four second period. If this number is exceeded, the connection is closed.

Parameters:

reconnectFreqManagerMaxReconnects - Maximum number of reconnections to allow in a four second period.

getContentBufferResizeMultiplier

public int getContentBufferResizeMultiplier()

Get content buffer resize multiplier.

Returns:

content buffer resize multiplier

setContentBufferResizeMultiplier

public void setContentBufferResizeMultiplier(int multiplier)

Set content buffer multiplier (the default is 25). The multiplier is used to calculate content buffer resize threshold. Content buffer resizing is disabled when the multiplier is set to 0.

Parameters:

multiplier - content buffer resize multiplier

getContentBufferSizeDefault

public int getContentBufferSizeDefault()

Get content buffer size default

Returns:

content buffer size default

setContentBufferSizeDefault

public void setContentBufferSizeDefault(int sz)
                                 throws InvalidPropertiesException

Set content buffer size default (the default is 4096).

Parameters:

sz - content buffer size default

Throws:

InvalidPropertiesException