LifecycleSubject

1. Documentation
2. API reference
3. Microsoft.Orleans.Core
4. LifecycleSubject

class

Namespace: Orleans

NuGetSourceMarkdown

Provides functionality for observing a lifecycle.

public abstract class LifecycleSubject : ILifecycleObservable, ILifecycleObserver, ILifecycleSubject

Remarks

• Single use, does not support multiple start/stop cycles.
• Once started, no other observers can be subscribed.
• OnStart starts stages in order until first failure or cancellation.
• OnStop stops states in reverse order starting from highest started stage.
• OnStop stops all stages regardless of errors even if canceled.

Constructors

• LifecycleSubject(ILogger) Initializes a new instance of the LifecycleSubject class.

Methods

• CallObserverStopAsync(ILifecycleObserver, CancellationToken) Invokes the stop callback for a lifecycle observer.
• GetStageName(int) Gets the name of the specified numeric stage.
• GetStageNames(Type) Gets the collection of all stage numbers and their corresponding names.
• OnStart(CancellationToken) Handle start notifications.
• OnStartStageCompleted(int) Signifies that LifecycleSubject completed.
• OnStop(CancellationToken) Handle stop notifications.
• OnStopStageCompleted(int) Signifies that LifecycleSubject completed.
• PerfMeasureOnStart(int, TimeSpan) Logs the observed performance of an LifecycleSubject call.
• PerfMeasureOnStop(int, TimeSpan) Logs the observed performance of an LifecycleSubject call.
• Subscribe(string, int, ILifecycleObserver) Subscribe for notification when a stage is reached while starting or stopping.

Fields

• Logger Gets the logger used to report lifecycle activity.