Pip-Services-Commons-Dotnet
Static Public Member Functions | List of all members
PipServices3.Commons.Run.Cleaner Class Reference

Helper class that cleans stored object state. More...

Static Public Member Functions

static async Task ClearOneAsync (string correlationId, object component)
 Clears state of specific component. To be cleaned state components must implement ICleanable interface. If they don't the call to this method has no effect. More...
 
static async Task ClearAsync (string correlationId, IEnumerable components)
 Clears state of multiple components. To be cleaned state components must implement ICleanable interface. If they don't the call to this method has no effect. More...
 

Detailed Description

Helper class that cleans stored object state.

See ICleanable

Member Function Documentation

◆ ClearAsync()

static async Task PipServices3.Commons.Run.Cleaner.ClearAsync ( string  correlationId,
IEnumerable  components 
)
static

Clears state of multiple components. To be cleaned state components must implement ICleanable interface. If they don't the call to this method has no effect.

Parameters
correlationId(optional) transaction id to trace execution through call chain.
componentsa list of components to be cleaned

See ClearOneAsync(string, object), ICleanable

◆ ClearOneAsync()

static async Task PipServices3.Commons.Run.Cleaner.ClearOneAsync ( string  correlationId,
object  component 
)
static

Clears state of specific component. To be cleaned state components must implement ICleanable interface. If they don't the call to this method has no effect.

Parameters
correlationId(optional) transaction id to trace execution through call chain.
componenta component to be cleaned

See ICleanable


The documentation for this class was generated from the following file: