FlowProperties Class

Class constructor

Removes all properties.

Creates a new object that is a deep copy of the current instance.

Determines whether the specified Object is equal to the current Object.

Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

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.

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.

Serves as a hash function for a particular type.

Gets the property value associated with the given key.

Gets the Type of the current instance.

Creates a shallow copy of the current Object.

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.

Associates a property key with a property value.

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.

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.

Returns a String that represents the current Object.

Controls how acknowledgements are generated for received Guaranteed messages. Possible values are defined in MessageAckMode Default MessageAckMode.AutoAck

The default threshold for sending an acknowledgement, as a percentage of flow window size. The valid range is 1..75. The default value is 60.

The duration of the flow acknowledgement timer (in milliseconds). The valid range is 20..1500. The default value is 1000.

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

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

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.

The maximum number of bind attempts to make. The default value is 3.

The timeout used (in milliseconds) when creating a flow in blocking mode. Default: 10000 msecs

Returns the count of properties.

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

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.

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.

A JMS-defined selector. Default: Empty string

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.