IReliableDictionary<TKey,TValue>.TryRemoveAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| TryRemoveAsync(ITransaction, TKey) |
Attempts to remove the value with the specified key from the Reliable Dictionary. |
| TryRemoveAsync(ITransaction, TKey, TimeSpan, CancellationToken) |
Attempts to remove the value with the specified key from the Reliable Dictionary. |
TryRemoveAsync(ITransaction, TKey)
Attempts to remove the value with the specified key from the Reliable Dictionary.
public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<TValue>> TryRemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, TKey key);abstract member TryRemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<'Value>>Public Function TryRemoveAsync (tx As ITransaction, key As TKey) As Task(Of ConditionalValue(Of TValue))Parameters
- tx
- ITransaction
Transaction to associate this operation with.
- key
- TKey
The key of the element to remove.
Returns
Task that represents the asynchronous remove operation. The task result is a tuple indicating whether the key was removed from the Reliable Dictionary and if so, the value.
Exceptions
tx is null, or key is null or cannot be serialized.
The operation failed to complete within the default timeout.
The exception that is thrown when the IReliableDictionary<TKey,TValue> is not in Primary.
The transaction has been internally faulted by the system. Retry the operation on a new transaction
Thrown when a method call is invalid for the object's current state. Example, transaction used is already terminated: committed or aborted by the user. If this exception is thrown, it is highly likely that there is a bug in the service code of the use of transactions.
Indicates that the Reliable Dictionary is closed or deleted.
Applies to
TryRemoveAsync(ITransaction, TKey, TimeSpan, CancellationToken)
Attempts to remove the value with the specified key from the Reliable Dictionary.
public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<TValue>> TryRemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, TKey key, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);abstract member TryRemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<'Value>>Public Function TryRemoveAsync (tx As ITransaction, key As TKey, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ConditionalValue(Of TValue))Parameters
- tx
- ITransaction
Transaction to associate this operation with.
- key
- TKey
The key of the element to remove.
- timeout
- TimeSpan
The amount of time to wait for the operation to complete before throwing a TimeoutException. Primarily used to prevent deadlocks. The default is 4 seconds.
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests. The default is None.
Returns
Task that represents the asynchronous remove operation. The task result is a tuple indicating whether the key was removed from the Reliable Dictionary and if so, the value.
Exceptions
tx is null, or key is null or cannot be serialized.
timeout is negative.
The operation failed to complete within the given timeout.
The operation was canceled.
The exception that is thrown when the IReliableDictionary<TKey,TValue> is not in Primary.
The transaction has been internally faulted by the system. Retry the operation on a new transaction
Thrown when a method call is invalid for the object's current state. Example, transaction used is already terminated: committed or aborted by the user. If this exception is thrown, it is highly likely that there is a bug in the service code of the use of transactions.
Indicates that the Reliable Dictionary is closed or deleted.
Applies to
Azure SDK for .NET