Cache Session Configuration Properties

Items that can be configured in a client application that wants to retrieve messages from the cache. More...

Macros
#define	SOLCLIENT_CACHESESSION_PROP_CACHE_NAME   "CACHESESSION_CACHE_NAME"
	The identifier for the Distributed Cache to send cache requests to. More...
#define	SOLCLIENT_CACHESESSION_PROP_MAX_MSGS   "CACHESESSION_MAX_MSGS"
	The maximum number of messages to retrieve from the cache for any one Topic. More...
#define	SOLCLIENT_CACHESESSION_PROP_MAX_AGE   "CACHESESSION_MAX_AGE"
	The oldest message (in seconds) to retrieve from the cache. More...
#define	SOLCLIENT_CACHESESSION_PROP_REQUESTREPLY_TIMEOUT_MS   "CACHESESSION_RR_TIMEOUT_MS"
	The timeout period (in milliseconds) to wait for a response from the cache. More...
#define	SOLCLIENT_CACHESESSION_PROP_REPLY_TO   "CACHESESSION_REPLY_TO"
	Deprecated: The reply-to topic for the cache request. More...

Detailed Description

Items that can be configured in a client application that wants to retrieve messages from the cache.

Macro Definition Documentation

#define SOLCLIENT_CACHESESSION_PROP_CACHE_NAME   "CACHESESSION_CACHE_NAME"

The identifier for the Distributed Cache to send cache requests to.

Examples:

ex/asyncCacheRequest.c, ex/ios/examples/AsyncCacheRequestExample.m, ex/ios/examples/SyncCacheRequestExample.m, and ex/syncCacheRequest.c.

#define SOLCLIENT_CACHESESSION_PROP_MAX_AGE   "CACHESESSION_MAX_AGE"

The oldest message (in seconds) to retrieve from the cache.

#define SOLCLIENT_CACHESESSION_PROP_MAX_MSGS   "CACHESESSION_MAX_MSGS"

The maximum number of messages to retrieve from the cache for any one Topic.

#define SOLCLIENT_CACHESESSION_PROP_REPLY_TO   "CACHESESSION_REPLY_TO"

Deprecated: The reply-to topic for the cache request.

It is preferred to leave this property unspecified and let the API use the Session P2P Reply To Topic: SOLCLIENT_SESSION_PROP_P2PINBOX_IN_USE.

#define SOLCLIENT_CACHESESSION_PROP_REQUESTREPLY_TIMEOUT_MS   "CACHESESSION_RR_TIMEOUT_MS"

The timeout period (in milliseconds) to wait for a response from the cache.

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 solClient_cacheSession_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 satisfied in time.