Photomechanics API
AsyncDisposableExtendedImpl Class Reference

When inheriting from AsyncDisposableExtendedBase directly is not possible, use this to implement IAsyncDisposableExtended pattern. Implementation of every interface member can be passed through to instance of this class. More...

Inheritance diagram for AsyncDisposableExtendedImpl:
[legend]

Public Member Functions

 AsyncDisposableExtendedImpl (ILogger logger, Func< ValueTask > onDispose, IAsyncDisposableExtended owner)
 
override? String ToString ()
 
new void UpdateLoggerContext ()
 AsyncDisposableExtendedBase.UpdateLoggerContext.
 
- Public Member Functions inherited from AsyncDisposableExtendedBase
async ValueTask DisposeAsync ()
 

Protected Member Functions

override async ValueTask DisposeAsyncCore ()
 Derived type disposal logic. More...
 
- Protected Member Functions inherited from AsyncDisposableExtendedBase
 AsyncDisposableExtendedBase (ILogger logger)
 Base constructor for device api. More...
 
abstract ValueTask DisposeAsyncCore ()
 Derived type disposal logic. More...
 
void UpdateLoggerContext ()
 Unfortunately Serilog ForContext method does not store provided object as property value, calling its ToString method immediately instead. In some cases, we want to use information like device name/id as log context but it is only available when derived type is fully constructed and maybe some other initialization took place. For such cases, derived type can use this method to update Logger context value.
 

Properties

override IAsyncDisposableExtended Owner [get]
 
- Properties inherited from AsyncDisposableExtendedBase
ILogger Logger [get]
 Logger associated with this instance. This way extension methods can use logging without requiring it as parameter. More...
 
Boolean IsDisposed [get]
 Determines whether the object is being disposed or already disposed and no longer functional. More...
 
virtual IAsyncDisposableExtended Owner [get]
 Type and ToString values of this object will appear when logging begin/end of DisposeAsync. This object will also be used as Disposed sender, essentially allowing seamlessly using AsyncDisposableExtendedBase logic even when directly inheriting from it is not possible. Usually it simply returns "this" value, but AsyncDisposableExtendedImpl overrides it to return its owner instance for the aforementioned reason.
 
- Properties inherited from IAsyncDisposableExtended
Boolean IsDisposed [get]
 Determines whether the object is being disposed or already disposed and no longer functional. More...
 
ILogger Logger [get]
 Logger associated with this instance. This way extension methods can use logging without requiring it as parameter. More...
 

Additional Inherited Members

- Events inherited from AsyncDisposableExtendedBase
AsyncTypedEventHandler< IAsyncDisposableExtended >? Disposed
 
- Events inherited from IAsyncDisposableExtended
AsyncTypedEventHandler< IAsyncDisposableExtendedDisposed
 Occurs when object is disposed. It should be invoked at the end of IAsyncDisposable.DisposeAsync implementation in a Fire-and-Forget fashion (non-blocking).
 

Detailed Description

When inheriting from AsyncDisposableExtendedBase directly is not possible, use this to implement IAsyncDisposableExtended pattern. Implementation of every interface member can be passed through to instance of this class.

Member Function Documentation

◆ DisposeAsyncCore()

override async ValueTask AsyncDisposableExtendedImpl.DisposeAsyncCore ( )
protectedvirtual

Derived type disposal logic.

Implements AsyncDisposableExtendedBase.