LifecycleSubject Class

Definition

Namespace:: Orleans

Assembly:: Orleans.Core.dll

Package:: Microsoft.Orleans.Core v10.0.0

Package:: Microsoft.Orleans.Core v2.4.5

Package:: Microsoft.Orleans.Core v3.6.5

Package:: Microsoft.Orleans.Core v7.2.5

Package:: Microsoft.Orleans.Core v8.0.0

Package:: Microsoft.Orleans.Core v8.1.0

Package:: Microsoft.Orleans.Core v8.2.0

Package:: Microsoft.Orleans.Core v9.0.0

Package:: Microsoft.Orleans.Core v9.1.2

Source:: LifecycleSubject.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides functionality for observing a lifecycle.

public abstract class LifecycleSubject : Orleans.ILifecycleSubject

public class LifecycleSubject : Orleans.ILifecycleSubject

type LifecycleSubject = class
    interface ILifecycleSubject
    interface ILifecycleObservable
    interface ILifecycleObserver

Public MustInherit Class LifecycleSubject
Implements ILifecycleSubject

Public Class LifecycleSubject
Implements ILifecycleSubject

Inheritance: Object
LifecycleSubject

Derived: Orleans.Runtime.SiloLifecycleSubject

Implements: 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

Name	Description
LifecycleSubject(ILogger)
LifecycleSubject(ILogger<LifecycleSubject>)

Fields

Name	Description
logger
Logger

Methods

Name	Description
CallObserverStopAsync(ILifecycleObserver, CancellationToken)
GetStageName(Int32)	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(Int32)	Signifies that OnStart(CancellationToken) completed.
OnStop(CancellationToken)	Handle stop notifications.
OnStopStageCompleted(Int32)	Signifies that OnStop(CancellationToken) completed.
PerfMeasureOnStart(Int32, TimeSpan)	Logs the observed performance of an OnStart(CancellationToken) call.
PerfMeasureOnStop(Int32, TimeSpan)	Logs the observed performance of an OnStop(CancellationToken) call.
Subscribe(String, Int32, ILifecycleObserver)

Extension Methods

Name	Description
OnStart(ILifecycleObserver)
OnStop(ILifecycleObserver)
Subscribe(ILifecycleObservable, Int32, ILifecycleObserver)	Creates a disposable subscription to the lifecycle.
Subscribe(ILifecycleObservable, String, Int32, Func<CancellationToken,Task>, Func<CancellationToken,Task>)	Creates a disposable subscription to the lifecycle.
Subscribe(ILifecycleObservable, String, Int32, Func<CancellationToken,Task>)	Creates a disposable subscription to the lifecycle.
Subscribe<TObserver>(ILifecycleObservable, Int32, Func<CancellationToken,Task>, Func<CancellationToken,Task>)	Creates a disposable subscription to the lifecycle.
Subscribe<TObserver>(ILifecycleObservable, Int32, Func<CancellationToken,Task>)	Creates a disposable subscription to the lifecycle.
Subscribe<TObserver>(ILifecycleObservable, Int32, ILifecycleObserver)	Creates a disposable subscription to the lifecycle.

Applies to

Share via