CacheSessionProperties Class

Solclient

CacheSessionProperties Class
version: 7.2.1.27
Defines cache session properties.
Inheritance Hierarchy
SystemObject  SolaceSystems.Solclient.MessagingBaseProperties
    SolaceSystems.Solclient.Messaging.CacheCacheSessionProperties

Namespace: SolaceSystems.Solclient.Messaging.Cache
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)
Syntax
[SerializableAttribute]
public class CacheSessionProperties : BaseProperties
<SerializableAttribute>
Public Class CacheSessionProperties
	Inherits BaseProperties
[SerializableAttribute]
public ref class CacheSessionProperties : public BaseProperties

The CacheSessionProperties type exposes the following members.

Constructors
  NameDescription
Public methodCacheSessionProperties
Class constructor
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 attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodStatic memberFromDictionary
Creates and returns a new CacheSessionProperties from a dictionary of key/value strings

where:

key: is a string representation of a given CacheSessionProperties property CacheSessionPropertiesPROPERTY

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

Rules:

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

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

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

4. Read-only properties are ignored.

Public methodStatic memberFromDictionaryWithPrefix
Creates and returns a new CacheSessionProperties from a dictionary of key/value strings

where:

key: is a string representation of a given CacheSessionProperties property CacheSessionPropertiesPROPERTY prefixed with a string "prefix"

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

Rules:

1. Keys that are not in the CacheSessionProperties's property set CacheSessionPropertiesPROPERTY, 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, 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.)
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.)
Public methodToDictionary
Returns a new IDictionary instance where:

key: is a string representation of a given SessionProperties property SessionPropertiesPROPERTY

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 SessionProperties property SessionPropertiesPROPERTY 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
Properties
  NameDescription
Public propertyCacheName
The identifier for the cache to send cache requests to. Default: ""
Public propertyCacheRequestTimeoutInMsecs
The timeout period (in milliseconds) to wait for a response from the cache. The default value is 10000 (10 seconds) The minimum configurable value is 3000 (3 seconds). This is a protocol timer used internally by the API on each message exchange with solCache. A single call to ICacheSession.SendCacheRequest() may lead to many request-reply exchanges with solCache and so is not bounded by this timer as long as each internal request is satisified in time.
Public propertyCount
Returns the count of properties.
(Inherited from BaseProperties.)
Public propertyMaxMessageAgeInSecs
The age (in seconds) of the oldest message to retrieve from the cache. Default: 0 scecs
Public propertyMaxMessagesPerTopic
The maximum number of messages to retrieve from the cache for any one topic. Default: 1
Top
See Also