ReliableStateManager.IReliableStateManager.RemoveAsync Method

Definition

Overloads

IReliableStateManager.RemoveAsync(ITransaction, Uri, TimeSpan)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.

IReliableStateManager.RemoveAsync(String, TimeSpan)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.

IReliableStateManager.RemoveAsync(Uri, TimeSpan)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.

IReliableStateManager.RemoveAsync(ITransaction, Uri)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.

IReliableStateManager.RemoveAsync(ITransaction, String)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.

IReliableStateManager.RemoveAsync(Uri)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.

IReliableStateManager.RemoveAsync(String)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.

IReliableStateManager.RemoveAsync(ITransaction, String, TimeSpan)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.

IReliableStateManager.RemoveAsync(ITransaction, Uri, TimeSpan)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, Uri name, TimeSpan timeout);
Function RemoveAsync (tx As ITransaction, name As Uri, timeout As TimeSpan) As Task Implements IReliableStateManager.RemoveAsync

Parameters

tx
ITransaction

Transaction to associate this operation with.

name
System.Uri

The name of the IReliableState to remove.

timeout
System.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.

Returns

System.Threading.Tasks.Task

Task that represents the asynchronous remove operation.

Implements

Exceptions

System.ArgumentNullException

tx is null, or name is null.

System.ArgumentException

An IReliableState with the given name does not exist, or timeout is negative.

System.TimeoutException

The operation failed to complete within the given timeout.

System.InvalidOperationException

Thrown when a method call is invalid for the object's current state. For example, transaction used is already terminated: committed or aborted.

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact. If this method throws an exception, the transaction must be aborted.

Applies to

IReliableStateManager.RemoveAsync(String, TimeSpan)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (string name, TimeSpan timeout);
Function RemoveAsync (name As String, timeout As TimeSpan) As Task Implements IReliableStateManager.RemoveAsync

Parameters

name
System.String

The name of the IReliableState to remove.

timeout
System.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.

Returns

System.Threading.Tasks.Task

Task that represents the asynchronous remove operation.

Implements

Exceptions

System.ArgumentNullException

name is null.

System.ArgumentException

An IReliableState with the given name does not exist, or timeout is negative.

System.TimeoutException

The operation failed to complete within the given timeout.

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact.

Applies to

IReliableStateManager.RemoveAsync(Uri, TimeSpan)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Uri name, TimeSpan timeout);
Function RemoveAsync (name As Uri, timeout As TimeSpan) As Task Implements IReliableStateManager.RemoveAsync

Parameters

name
System.Uri

The name of the IReliableState to remove.

timeout
System.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.

Returns

System.Threading.Tasks.Task

Task that represents the asynchronous remove operation.

Implements

Exceptions

System.ArgumentNullException

name is null.

System.ArgumentException

An IReliableState with the given name does not exist, or timeout is negative.

System.TimeoutException

The operation failed to complete within the given timeout.

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact.

Applies to

IReliableStateManager.RemoveAsync(ITransaction, Uri)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, Uri name);
Function RemoveAsync (tx As ITransaction, name As Uri) As Task Implements IReliableStateManager.RemoveAsync

Parameters

tx
ITransaction

Transaction to associate this operation with.

name
System.Uri

The name of the IReliableState to remove.

Returns

System.Threading.Tasks.Task

Task that represents the asynchronous remove operation.

Implements

Exceptions

System.ArgumentNullException

tx is null, or name is null.

System.ArgumentException

An IReliableState with the given name does not exist.

System.TimeoutException

The operation failed to complete within the default timeout.

System.InvalidOperationException

Thrown when a method call is invalid for the object's current state. For example, transaction used is already terminated: committed or aborted.

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact. If this method throws an exception, the transaction must be aborted.

Applies to

IReliableStateManager.RemoveAsync(ITransaction, String)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, string name);
Function RemoveAsync (tx As ITransaction, name As String) As Task Implements IReliableStateManager.RemoveAsync

Parameters

tx
ITransaction

Transaction to associate this operation with.

name
System.String

The name of the IReliableState to remove.

Returns

System.Threading.Tasks.Task

Task that represents the asynchronous remove operation.

Implements

Exceptions

System.ArgumentNullException

tx is null, or name is null.

System.ArgumentException

An IReliableState with the given name does not exist.

System.TimeoutException

The operation failed to complete within the default timeout.

System.InvalidOperationException

Thrown when a method call is invalid for the object's current state. For example, transaction used is already terminated: committed or aborted.

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact. If this method throws an exception, the transaction must be aborted.

Applies to

IReliableStateManager.RemoveAsync(Uri)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Uri name);
Function RemoveAsync (name As Uri) As Task Implements IReliableStateManager.RemoveAsync

Parameters

name
System.Uri

The name of the IReliableState to remove.

Returns

System.Threading.Tasks.Task

Task that represents the asynchronous remove operation.

Implements

Exceptions

System.ArgumentNullException

name is null.

System.ArgumentException

An IReliableState with the given name does not exist.

System.TimeoutException

The operation failed to complete within the default timeout.

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact.

Applies to

IReliableStateManager.RemoveAsync(String)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (string name);
Function RemoveAsync (name As String) As Task Implements IReliableStateManager.RemoveAsync

Parameters

name
System.String

The name of the IReliableState to remove.

Returns

System.Threading.Tasks.Task

Task that represents the asynchronous remove operation.

Implements

Exceptions

System.ArgumentNullException

name is null.

System.ArgumentException

An IReliableState with the given name does not exist.

System.TimeoutException

The operation failed to complete within the default timeout.

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact.

Applies to

IReliableStateManager.RemoveAsync(ITransaction, String, TimeSpan)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, string name, TimeSpan timeout);
Function RemoveAsync (tx As ITransaction, name As String, timeout As TimeSpan) As Task Implements IReliableStateManager.RemoveAsync

Parameters

tx
ITransaction

Transaction to associate this operation with.

name
System.String

The name of the IReliableState to remove.

timeout
System.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.

Returns

System.Threading.Tasks.Task

Task that represents the asynchronous remove operation.

Implements

Exceptions

System.ArgumentNullException

tx is null, or name is null.

System.ArgumentException

An IReliableState with the given name does not exist, or timeout is negative.

System.TimeoutException

The operation failed to complete within the given timeout.

System.InvalidOperationException

Thrown when a method call is invalid for the object's current state. For example, transaction used is already terminated: committed or aborted.

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact. If this method throws an exception, the transaction must be aborted.

Applies to