IReliableDictionary<TKey,TValue>.TryAddAsync Method

Definition

Overloads

TryAddAsync(ITransaction, TKey, TValue)

Attempts to add the specified key and value to the Reliable Dictionary.

TryAddAsync(ITransaction, TKey, TValue, TimeSpan, CancellationToken)

Attempts to add the specified key and value to the Reliable Dictionary.

TryAddAsync(ITransaction, TKey, TValue)

Attempts to add the specified key and value to the Reliable Dictionary.

public System.Threading.Tasks.Task<bool> TryAddAsync (Microsoft.ServiceFabric.Data.ITransaction tx, TKey key, TValue value);
abstract member TryAddAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key * 'Value -> System.Threading.Tasks.Task<bool>
Public Function TryAddAsync (tx As ITransaction, key As TKey, value As TValue) As Task(Of Boolean)

Parameters

tx
ITransaction

Transaction to associate this operation with.

key
TKey

The key of the element to add.

value
TValue

The value of the element to add. The value can be null for reference types.

Returns

Task<Boolean>

A task that represents the asynchronous add operation. The task result indicates whether the key/value pair was added.

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

Product Introduced

TryAddAsync(ITransaction, TKey, TValue, TimeSpan, CancellationToken)

Attempts to add the specified key and value to the Reliable Dictionary.

public System.Threading.Tasks.Task<bool> TryAddAsync (Microsoft.ServiceFabric.Data.ITransaction tx, TKey key, TValue value, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
abstract member TryAddAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key * 'Value * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

Parameters

tx
ITransaction

Transaction to associate this operation with.

key
TKey

The key of the element to add.

value
TValue

The value of the element to add. The value can be null for reference types.

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<Boolean>

A task that represents the asynchronous add operation. The task result indicates whether the key/value pair was added.

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

Product Introduced