Method Read
Read(TKey, ReadOptions, CancellationToken)
Retrieves an existing object from the cache.
public CacheResponse<TKey, TValue> Read(TKey key, ReadOptions options = default, CancellationToken cancellationToken = default)
Parameters
key
TKeyIdentifier of the object in the cache.
options
ReadOptionsOptions that can be used when retrieving an object from the ScaleOut service.
cancellationToken
CancellationTokenA token used to propagate notification that this operation should be canceled.
Returns
- CacheResponse<TKey, TValue>
A CacheResponse<TKey, TValue> containing the outcome of the operation and the retrieved object (if successful).
Remarks
The Result property of the response will contain one of the following ServerResult outcomes:
ServerResult | Description |
---|---|
Retrieved | The object was successfully retrieved from the ScaleOut service. |
NotFound | The requested object was not found in the ScaleOut service. |
RetrievedStale | If GeoServer Pull replication is used but the WAN link between datacenters is down, RetrievedStale is returned to indicate that the proxy returned from the local ScaleOut service may be stale. |
This operation does not use locking and will not block if another client/thread holds an exclusive lock on the object in the ScaleOut service. Use an exclusive variant to perform a synchronized read operation.