Class OptionsAccessorExtensions

Namespace

Acuit.Pinpoint.Workstation.Configuration

Assembly

Acuit.Pinpoint.Workstation.Abstractions.dll

Extension members for IOptionsAccessor<TOptions>.

public static class OptionsAccessorExtensions

Inheritance

object

OptionsAccessorExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

RegisterOptionsWatcher<TOptions>(IOptionsAccessor<TOptions>, Action, OptionsWatcherOptions, int)

Registers an options watcher with a synchronous callback.

public static IDisposable RegisterOptionsWatcher<TOptions>(this IOptionsAccessor<TOptions> optionsAccessor, Action callback, OptionsWatcherOptions options = OptionsWatcherOptions.None, int priority = 0) where TOptions : class

Parameters

optionsAccessor IOptionsAccessor<TOptions>

callback Action

The synchronous callback.

options OptionsWatcherOptions

Options for the options watcher optionsAccessor.

priority int

The watcher priority. Higher values indicate higher priority.

Returns

IDisposable

A IDisposable that can be used to unregister the watcher.

Type Parameters

TOptions

Remarks

See RegisterOptionsWatcherAsync(Func<Task>, OptionsWatcherOptions, int) for details about registering options watchers.

Exceptions

ArgumentNullException

callback is null.

RegisterOptionsWatcher<TOptions>(IOptionsAccessor<TOptions>, Func<Task>, OptionsWatcherOptions, int)

Synchronously registers an options watcher.

public static IDisposable RegisterOptionsWatcher<TOptions>(this IOptionsAccessor<TOptions> optionsAccessor, Func<Task> callback, OptionsWatcherOptions options = OptionsWatcherOptions.None, int priority = 0) where TOptions : class

Parameters

optionsAccessor IOptionsAccessor<TOptions>

callback Func<Task>

The asynchronous callback.

options OptionsWatcherOptions

Options for the options watcher optionsAccessor, which may not include InvokeNow.

priority int

The watcher priority. Higher values indicate higher priority.

Returns

IDisposable

A IDisposable that can be used to unregister the watcher.

Type Parameters

TOptions

Remarks

See RegisterOptionsWatcherAsync(Func<Task>, OptionsWatcherOptions, int) for details about registering options watchers.

Exceptions

ArgumentNullException

callback is null.

InvalidOperationException

The InvokeNow option is not allowed.