10.27.03

FlowProperties Properties

Properties

AckMode Controls how acknowledgements are generated for received Guaranteed messages. Possible values are defined in MessageAckMode Default MessageAckMode.AutoAck
AckThreshold The threshold for sending an acknowledgement, configured as a percentage. The API sends a transport acknowledgment every N messages where N is calculated as this percentage of the flow window size if the endpoint's max-delivered-unacked-msgs-per-flow setting at bind time is greater than or equal to the transport window size. Otherwise, N is calculated as this percentage of the endpoint's max-delivered-unacked-msgs-per-flow setting at bind time. The valid range is 1..75. The default value is 60.
AckTimerInMsecs The duration of the flow acknowledgement timer (in milliseconds). The valid range is 20..1500. The default value is 1000.
ActiveFlowInd When a Flow has the Active Flow Indication property enabled, the application will receive flow events when the flow becomes active, or inactive. If the underlying session capabilities indicate that the appliance does not support active flow indications, then ISession.CreateFlow() will fail immediately and set the subCode ActiveFlowIndicationUnsupported Default: false
AutoAck When set to true, the API generates application level acknowledgments for Guaranteed messages, when the receive delegate returns, this is equivalent to specifying AutoAck for AckMode.

When set to false, client applications must explicitly acknowledge Guaranteed messages, if they do not want to receive them again when reconnecting.

Default: true
Obsolete.
BindBlocking Controls whether or not to block when creating a flow. When set to true, the create flow operation blocks awaiting appliance's response. The default value is true.
BindRetries The maximum number of bind attempts to make. The default value is 3.
BindTimeoutInMsecs The timeout used (in milliseconds) when creating a flow in blocking mode. Default: 10000 msecs
Count Returns the count of properties.
(Inherited from BaseProperties)
FlowStartState Controls whether the flow should be created in a "start" or "stop" state with respect to receiving messages. Flow start/stop state can be changed later through Start() or Stop(). Default: true
MaxReconnectTries Flows can be configured to attempt re-binding automatically, mainly when a replay is started. This property controls the number of times the re-bind is attempted. -1 means infinite retries. 0 means no auto rebind.
MaxUnackedMessages This property may only be set when the Flow property AckMode is set to ClientAck. When set to a positive value, this property controls the maximum number of messages that may be unacknowledged on the Flow (Ack(Int64) is called to acknowledge messages and remove those messages from the message spool.) This property cannot be used to increase the appliance configured maximum number of acknowledged messages on the endpoint. When set to -1, the appliance configured maximum controls how many unacknowledged messages may be received by the application. Valid values are -1 and >0.
NoLocal If the connected peer supports No Local, then messages published on the session will not appear in flows created with this property set to true, even if the endpoint contains a subscription that matches the published topic. The ISession.CreateFlow(...) will fail and set subcode NoLocalNotSupported if the connected peer does not support No Local.
ReconnectRetryIntervalMs Flows can be configured to attempt re-binding automatically, mainly when a replay is started. This property controls how long to wait between re-bind attempts, in milliseconds.
ReplayStartLocation Deprecated: use ReplayStartLocationEx instead. When a Flow is created, the application may request replay of messages from the replay log, even messages that have been previously delivered and removed the from topic endpoint or queue. The replay start location may be one of the following:
  • Beginning to indicate that all messages available should be replayed.
  • A start location created from Date(DateTime). All messages after the specificed date will be replayed.

Obsolete.
ReplayStartLocationEx When a Flow is created, the application may request replay of messages from the replay log, even messages that have been previously delivered and removed the from topic endpoint or queue. The replay start location may be one of the following:
RequiredOutcomeFailed Allows flow to use Settle(Int64, MessageOutcome) with "Failed" outcome. Requires broker capability AD_APP_ACK_FAILED. Default Value: false (disabled).
RequiredOutcomeRejected Allows flow to use Settle(Int64, MessageOutcome) with "Rejected" outcome. Requires broker capability AD_APP_ACK_FAILED. Default Value: false (disabled).
Selector A JMS-defined selector. Default: Empty string
WindowSize The Guaranteed message window size for the flow. This sets the maximum number of messages that can be in transit (that is, the messages are sent from the appliance, but are not yet delivered to the application). The valid range is 1..255. The default window size is 255.

See Also