IReliableDictionary<TKey,TValue>.TryGetValueAsync Method

Definition

Namespace:

Microsoft.ServiceFabric.Data.Collections

Assembly:

Microsoft.ServiceFabric.Data.Interfaces.dll

Package:

Microsoft.ServiceFabric.Data.Interfaces v6.1.1583

Overloads

TryGetValueAsync(ITransaction, TKey)	Attempts to get the value associated with the specified key from the Reliable Dictionary.
TryGetValueAsync(ITransaction, TKey, LockMode)	Attempts to get the value associated with the specified key from the Reliable Dictionary.
TryGetValueAsync(ITransaction, TKey, TimeSpan, CancellationToken)	Attempts to get the value associated with the specified key from the Reliable Dictionary.
TryGetValueAsync(ITransaction, TKey, LockMode, TimeSpan, CancellationToken)	Attempts to get the value associated with the specified key from the Reliable Dictionary.

TryGetValueAsync(ITransaction, TKey)

Attempts to get the value associated with the specified key from the Reliable Dictionary.

public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<TValue>> TryGetValueAsync (Microsoft.ServiceFabric.Data.ITransaction tx, TKey key);

abstract member TryGetValueAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<'Value>>

Public Function TryGetValueAsync (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 value to get.

Returns

Task<ConditionalValue<TValue>>

A task that represents the asynchronous read operation. The task result is a tuple indicating whether the key was found in the Reliable Dictionary and if so, the value.

Exceptions

ArgumentNullException

tx is null, or key is null or cannot be serialized.

TimeoutException

The operation failed to complete within the default timeout.

FabricNotReadableException

Indicates that the IReliableDictionary cannot serve reads at the moment. This exception can be thrown in all ReplicaRoles. One reason it may be thrown in the Primary role is loss of ReadStatus. One reason it may be thrown in the ActiveSecondary role is that Reliable Collection's state is not yet consistent.

TransactionFaultedException

The transaction has been internally faulted by the system. Retry the operation on a new transaction

InvalidOperationException

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.

FabricObjectClosedException

Indicates that the Reliable Dictionary is closed or deleted.

TryGetValueAsync(ITransaction, TKey, LockMode)

Attempts to get the value associated with the specified key from the Reliable Dictionary.

public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<TValue>> TryGetValueAsync (Microsoft.ServiceFabric.Data.ITransaction tx, TKey key, Microsoft.ServiceFabric.Data.Collections.LockMode lockMode);

abstract member TryGetValueAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key * Microsoft.ServiceFabric.Data.Collections.LockMode -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<'Value>>

Public Function TryGetValueAsync (tx As ITransaction, key As TKey, lockMode As LockMode) As Task(Of ConditionalValue(Of TValue))

Parameters

tx

ITransaction

Transaction to associate this operation with.

key

TKey

The key of the value to get.

lockMode

LockMode

Type of locking to use for this read operation.

Returns

Task<ConditionalValue<TValue>>

A task that represents the asynchronous read operation. The task result is a tuple indicating whether the key was found in the Reliable Dictionary and if so, the value.

Exceptions

ArgumentNullException

tx is null, or key is null or cannot be serialized.

TimeoutException

The operation failed to complete within the default timeout.

FabricNotReadableException

Indicates that the IReliableDictionary cannot serve reads at the moment. This exception can be thrown in all ReplicaRoles. One reason it may be thrown in the Primary role is loss of ReadStatus. One reason it may be thrown in the ActiveSecondary role is that Reliable Collection's state is not yet consistent.

TransactionFaultedException

The transaction has been internally faulted by the system. Retry the operation on a new transaction

InvalidOperationException

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.

FabricObjectClosedException

Indicates that the Reliable Dictionary is closed or deleted.

TryGetValueAsync(ITransaction, TKey, TimeSpan, CancellationToken)

Attempts to get the value associated with the specified key from the Reliable Dictionary.

public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<TValue>> TryGetValueAsync (Microsoft.ServiceFabric.Data.ITransaction tx, TKey key, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

abstract member TryGetValueAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<'Value>>

Public Function TryGetValueAsync (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 value to get.

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<ConditionalValue<TValue>>

A task that represents the asynchronous read operation. The task result is a tuple indicating whether the key was found in the Reliable Dictionary and if so, the value.

Exceptions

ArgumentNullException

tx is null, or key is null or cannot be serialized.

ArgumentException

timeout is negative.

TimeoutException

The operation failed to complete within the given timeout.

OperationCanceledException

The operation was canceled.

FabricNotReadableException

Indicates that the IReliableDictionary cannot serve reads at the moment. This exception can be thrown in all ReplicaRoles. One reason it may be thrown in the Primary role is loss of ReadStatus. One reason it may be thrown in the ActiveSecondary role is that Reliable Collection's state is not yet consistent.

TransactionFaultedException

The transaction has been internally faulted by the system. Retry the operation on a new transaction

InvalidOperationException

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.

FabricObjectClosedException

Indicates that the Reliable Dictionary is closed or deleted.

TryGetValueAsync(ITransaction, TKey, LockMode, TimeSpan, CancellationToken)

Attempts to get the value associated with the specified key from the Reliable Dictionary.

public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<TValue>> TryGetValueAsync (Microsoft.ServiceFabric.Data.ITransaction tx, TKey key, Microsoft.ServiceFabric.Data.Collections.LockMode lockMode, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

abstract member TryGetValueAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key * Microsoft.ServiceFabric.Data.Collections.LockMode * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<'Value>>

Public Function TryGetValueAsync (tx As ITransaction, key As TKey, lockMode As LockMode, 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 value to get.

lockMode

LockMode

Type of locking to use for this read operation.

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<ConditionalValue<TValue>>

A task that represents the asynchronous read operation. The task result is a tuple indicating whether the key was found in the Reliable Dictionary and if so, the value.

Exceptions

ArgumentNullException

tx is null, or key is null or cannot be serialized.

ArgumentException

timeout is negative.

TimeoutException

The operation failed to complete within the given timeout.

OperationCanceledException

The operation was canceled.

FabricNotReadableException

Indicates that the IReliableDictionary cannot serve reads at the moment. This exception can be thrown in all ReplicaRoles. One reason it may be thrown in the Primary role is loss of ReadStatus. One reason it may be thrown in the ActiveSecondary role is that Reliable Collection's state is not yet consistent.

TransactionFaultedException

The transaction has been internally faulted by the system. Retry the operation on a new transaction

InvalidOperationException

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.

FabricObjectClosedException

Indicates that the Reliable Dictionary is closed or deleted.