Asynchronously creates or updates settable index values for a cached object; optionally
unlocks the object.
Namespace: Soss.Client
Assembly: soss_namedcache (in soss_namedcache.dll) Version: 6.2.0.0
Syntax
public Task SetMetadataAsync( CachedObjectId id, ObjectMetadata metadata, bool unlock, LockTicket lockTicket = null, CancellationToken cancellationToken = null )
Parameters
- id
- Type: Soss.ClientCachedObjectId
Object identifier. - metadata
- Type: Soss.ClientObjectMetadata
The new metadata for the object, containing a collection of index values. - unlock
- Type: SystemBoolean
If the object was previously locked with the current SossCahce and unlock is true then the object will be unlocked after the operation completes. - lockTicket (Optional)
- Type: Soss.ClientLockTicket
An optional LockTicket obtained from a previous locking call - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
An optional CancellationToken that can be used to cancel the asynchronous operation.
Return Value
Type: TaskExceptions
Exception | Condition |
---|---|
ObjectNotFoundException | Thrown if the object to update does not exist in the shared cache. |
ObjectLockedException | Thrown if the lock on the cached object exceeded the 90 second timeout period and another client acquired the lock. |
StateServerException | Thrown if ScaleOut StateServer is unavailable or has experienced an internal error. |
ArgumentNullException | Thrown if metadata is null. |
Remarks
The SetMetadata(CachedObjectId, ObjectMetadata, Boolean) method does not honor the UseLocking property. Use the AcquireLock(CachedObjectId) or Retrieve(CachedObjectId, Boolean) methods prior to calling SetMetadata(CachedObjectId, ObjectMetadata, Boolean) if the object needs to be locked.
Care should be taken when performing unlocked metadata changes on objects. An unlocked SetMetadata(CachedObjectId, ObjectMetadata, Boolean) operation will not block for locks held by another clients, so other clients may have the object metadata changed underneath them despite the locks they hold.
See Also