Contents
class solace.CacheSession
This class is not exposed for construction by API users. Users should obtain an instance from solace.Session#createCacheSession
A session for performing cache requests.
Applications must use solace.Session#createCacheSession to construct this class.
The supplied solace.CacheSessionProperties will be copied. Subsequent modifications to the passed properties will not modify the session. The properties may be reused.
Constructor Top
| CacheSession ( ) |
Methods Top
| void | dispose ( ) | |
| solace.CacheSessionProperties | getProperties ( ) | |
| void | sendCacheRequest ( Number requestID, solace.Destination topic, Boolean subscribe, solace.CacheLiveDataAction liveDataAction, solace.CacheCBInfo cbInfo ) |
Constructor details
Top
CacheSession
( )
This class is not exposed for construction by API users. Users should obtain an instance from
solace.Session#createCacheSession
A session for performing cache requests.
Applications must use solace.Session#createCacheSession to construct this class.
The supplied solace.CacheSessionProperties will be copied. Subsequent modifications
to the passed properties will not modify the session. The properties may be reused.
This class is not exposed for construction by API users. Users should obtain an instance from solace.Session#createCacheSession
A session for performing cache requests.
Applications must use solace.Session#createCacheSession to construct this class.
The supplied solace.CacheSessionProperties will be copied. Subsequent modifications to the passed properties will not modify the session. The properties may be reused.
Methods Detail Top
public
void
dispose
( )
Disposes the session. No cache requests will be sent by this CacheSession after it is _disposed.
Any subsequent operations on the session will throw {OperationError}.
Any pending operations will immediately terminate, returning
- solace.CacheRequestResult
- #returnCode === solace.CacheReturnCode.INCOMPLETE
- #subcode === solace.CacheReturnSubcode.CACHE_SESSION_DISPOSED
Gets the cache session properties.
public
void
sendCacheRequest
( Number requestID, solace.Destination topic, Boolean subscribe, solace.CacheLiveDataAction liveDataAction, solace.CacheCBInfo cbInfo )
Issues an asynchronous cache request. The result of the request will be returned via the listener. Messages returned as a result of issuing the request will be returned to the application via the solace.MessageRxCBInfo associated with this solace.CacheSession's solace.Session