com.solacesystems.jcsmp

Class ProducerFlowProperties

java.lang.Object

com.solacesystems.jcsmp.ProducerFlowProperties

public class ProducerFlowProperties
extends Object

Properties used for creating producer flows.

Constructor Summary

Constructors

Constructor and Description
ProducerFlowProperties() ProducerFlowProperties constructor.
ProducerFlowProperties(ProducerFlowProperties tocopy) ProducerFlowProperties copy constructor.

Method Summary

Modifier and Type	Method and Description
String	getAckEventMode() If this property is set to SUPPORTED_ACK_EVENT_MODE_PER_MSG, the message acknowledgement event acknowledges a single published Guaranteed message; if this property is set to SUPPORTED_ACK_EVENT_MODE_WINDOWED, the message acknowledgement event acknowledges a range of published Guaranteed messages.
int	getWindowSize() The size of the sliding publisher window for Guaranteed messages.
ProducerFlowProperties	setAckEventMode(String ackEventMode) If this property is set to SUPPORTED_ACK_EVENT_MODE_PER_MSG, the message acknowledgement event acknowledges a single published Guaranteed message; if this property is set to SUPPORTED_ACK_EVENT_MODE_WINDOWED, the message acknowledgement event acknowledges a range of published Guaranteed messages.
ProducerFlowProperties	setWindowSize(int windowSize) The size of the sliding publisher window for Guaranteed messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProducerFlowProperties

public ProducerFlowProperties()

ProducerFlowProperties constructor.

ProducerFlowProperties

public ProducerFlowProperties(ProducerFlowProperties tocopy)

ProducerFlowProperties copy constructor.

Parameters:

tocopy - The ProducerFlowProperties to copy

Method Detail

getWindowSize

public int getWindowSize()

The size of the sliding publisher window for Guaranteed messages. The Guaranteed Message Publish Window Size property limits the maximum number of messages that can be published before the API must receive an acknowledgement from the appliance. The valid range is 1-255.

Returns:

The producer's window size.

setWindowSize

public ProducerFlowProperties setWindowSize(int windowSize)

The size of the sliding publisher window for Guaranteed messages. The Guaranteed Message Publish Window Size property limits the maximum number of messages that can be published before the API must receive an acknowledgement from the appliance. The valid range is 1-255.

Parameters:

windowSize - The window size for the producer.

Returns:

This object

getAckEventMode

public String getAckEventMode()

If this property is set to SUPPORTED_ACK_EVENT_MODE_PER_MSG, the message acknowledgement event acknowledges a single published Guaranteed message; if this property is set to SUPPORTED_ACK_EVENT_MODE_WINDOWED, the message acknowledgement event acknowledges a range of published Guaranteed messages. Message acknowledgement events are sent from JCSMPStreamingPublishCorrelatingEventHandler or JCSMPStreamingPublishEventHandler

Returns:

The ack event mode.

setAckEventMode

public ProducerFlowProperties setAckEventMode(String ackEventMode)

If this property is set to SUPPORTED_ACK_EVENT_MODE_PER_MSG, the message acknowledgement event acknowledges a single published Guaranteed message; if this property is set to SUPPORTED_ACK_EVENT_MODE_WINDOWED, the message acknowledgement event acknowledges a range of published Guaranteed messages. Message acknowledgement events are sent from JCSMPStreamingPublishCorrelatingEventHandler or JCSMPStreamingPublishEventHandler

Parameters:

ackEventMode - The ack event mode.

Returns:

This Object