Click or drag to resize

FlowProperties Class

version: 10.9.0
Defines Flow properties.
Inheritance Hierarchy
SystemObject
  SolaceSystems.Solclient.MessagingBaseProperties
    SolaceSystems.Solclient.MessagingFlowProperties

Namespace:  SolaceSystems.Solclient.Messaging
Assembly:  SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 10.9.0
Syntax
[SerializableAttribute]
public class FlowProperties : BaseProperties

The FlowProperties type exposes the following members.

Constructors
  NameDescription
Public methodFlowProperties
Class constructor
Top
Properties
  NameDescription
Public propertyAckMode
Controls how acknowledgements are generated for received Guaranteed messages. Possible values are defined in MessageAckMode Default MessageAckMode.AutoAck
Public propertyAckThreshold
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.
Public propertyAckTimerInMsecs
The duration of the flow acknowledgement timer (in milliseconds). The valid range is 20..1500. The default value is 1000.
Public propertyActiveFlowInd
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
Public propertyAutoAck Obsolete.
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
Public propertyBindBlocking
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.
Public propertyBindRetries
The maximum number of bind attempts to make. The default value is 3.
Public propertyBindTimeoutInMsecs
The timeout used (in milliseconds) when creating a flow in blocking mode. Default: 10000 msecs
Public propertyCount
Returns the count of properties.
(Inherited from BaseProperties.)
Public propertyFlowStartState
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
Public propertyMaxReconnectTries
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.
Public propertyMaxUnackedMessages
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.
Public propertyNoLocal
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.
Public propertyReconnectRetryIntervalMs
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.
Public propertyReplayStartLocation
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 ::SOLCLIENT_FLOW_PROP_REPLAY_START_LOCATION_BEGINNING to indicate that all messages available should be replayed. Or the replay start location may be a string that begins with "DATE:" followed by a date in one of two formats. The date may be a string representing a long integer, which is the number of nanoseconds since the epoch - 0:00:00 Jan 1, 1970. The data may be a string as specified in RFC3339: 'YYYY-MM-DDTHH:MM:SS[.1*DIGIT]Z' oe 'YYYY-MM-DDTHH:MM:SS[.1*DIGIT]("+"/"-")HH:MM'.
Public propertySelector
A JMS-defined selector. Default: Empty string
Public propertyWindowSize
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.
Top
Methods
  NameDescription
Public methodClear
Removes all properties.
(Inherited from BaseProperties.)
Public methodClone
Creates a new object that is a deep copy of the current instance.
(Inherited from BaseProperties.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from BaseProperties.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodStatic memberFromDictionary
Creates and returns a new FlowProperties given a dictionary of key/value strings

where:

key: is a string representation of a given FlowProperties property FlowPropertiesPROPERTY

value: is a string representation of the value of that property

Rules:

1. Keys that are not in the FlowProperties' property set FlowPropertiesPROPERTY, are ignored and a warning log is generated.

2. If a property is omitted, the default value is used.

3. Validation and type checking are performed on the provided values, and a conversion exception is thrown if any of the provided values cannot be converted.

4. Read-only properties are ignored.

Public methodStatic memberFromDictionaryWithPrefix
Creates and returns a new FlowProperties given a dictionary of key/value strings

where:

key: is a string representation of a given FlowProperties property FlowPropertiesPROPERTY prefixed with a string "prefix".

value: is a string representation of the value of that property.

Rules:

1. Keys that are not in the FlowProperties's property set FlowPropertiesPROPERTY, are ignored and a warning log is generated

2. If a property is omitted, the default value is used.

3. Validation and type checking is performed on the provided values; a conversion exception is thrown if any of the provided values cannot be converted.

4. Read-only properties are ignored.

Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from BaseProperties.)
Protected methodGetPropertyValue
Gets the property value associated with the given key.
(Inherited from BaseProperties.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodRemoveProperty
internal method to remove property from property map
(Inherited from BaseProperties.)
Public methodSetCCSMPProperty
Sets a property to be passed directly to CCSMP. Properties set in this manner will always override properties set using the shortcut properties, regardless of order.
(Inherited from BaseProperties.)
Protected methodSetPropertyValue
Associates a property key with a property value.
(Inherited from BaseProperties.)
Protected methodSetReferencePropertyValue
Associates a property key with a property value. The value will not be marked for serialization.
(Inherited from BaseProperties.)
Public methodToDictionary
Returns a new IDictionary instance where:

key: is a string representation of a given FlowProperties property FlowPropertiesPROPERTY.

value: is a string representation of the value of that property, or null if the property's value is null.

Note that only readable and writable properties are returned in the dictionary. Read-only properties are ignored.
Public methodToDictionaryWithPrefix
Returns a new IDictionary instance where:

key: is a string representation of a given FlowProperties property FlowPropertiesPROPERTY prefixed with a string "prefix"

value: is a string representation of the value of that property, or null if the property's value is null.

Note that only readable and writable properties are returned in the dictionary. Read-only properties are ignored.
Public methodToString
Returns a String that represents the current Object.
(Overrides ObjectToString.)
Top
See Also