IReliableDictionary<TKey,TValue>.ClearAsync Method

Definition

Namespace:

Microsoft.ServiceFabric.Data.Collections

Assembly:

Microsoft.ServiceFabric.Data.Interfaces.dll

Package:

Microsoft.ServiceFabric.Data.Interfaces v6.1.1583

Removes all keys and values from the Reliable Dictionary.

public System.Threading.Tasks.Task ClearAsync (TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

abstract member ClearAsync : TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function ClearAsync (timeout As TimeSpan, cancellationToken As CancellationToken) As Task

Parameters

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

Task that represents the asynchronous clear operation.

Exceptions

ArgumentException

timeout is negative.

TimeoutException

The operation failed to complete within the given timeout.

OperationCanceledException

The operation was canceled.

FabricNotPrimaryException

The exception that is thrown when the IReliableDictionary<TKey,TValue> is not in Primary.