NamedCacheGet Method (CachedObjectId)

ScaleOut Software NamedCache API
Gets a cached object using default parameters.

Namespace:  Soss.Client
Assembly:  soss_namedcache (in soss_namedcache.dll) Version:

public Object Get(
	CachedObjectId id


Type: Soss.ClientCachedObjectId
Object identifier.

Return Value

Type: Object
The object stored in the cache, or null if the object is not in the cache.

ObjectLockedExceptionThrown if UseLocking is true but the object is locked by another client.
StateServerExceptionThrown if ScaleOut StateServer is unavailable or has experienced an internal error.
ReadThroughTimeoutExceptionThrown if backing store read-through or GeoServer pull replication is used with this NamedCache and the retrieval of the object is delayed beyond the number of retries specified by MaxReadThroughPendingAttempts.

If UseLocking is true then Get(CachedObjectId) will cause the object to be locked in the SOSS server, and no other clients will be able to acquire a lock until the lock from this instance of the NamedCache is released (either by updating the object to a new value, removing it from the cache, or calling ReleaseLock).

If GeoServer pull replication is being used, the NamedCache's DefaultGeoServerReadMode property will determine this Get call's GeoServer read behavior when accessing an object in a remote store.

See Also