WindowsServiceLifetime クラス

定義

シャットダウン信号をリッスンし、Windows サービスの状態を追跡します。

public ref class WindowsServiceLifetime : System::ServiceProcess::ServiceBase, Microsoft::Extensions::Hosting::IHostLifetime
[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public class WindowsServiceLifetime : System.ServiceProcess.ServiceBase, Microsoft.Extensions.Hosting.IHostLifetime
public class WindowsServiceLifetime : System.ServiceProcess.ServiceBase, Microsoft.Extensions.Hosting.IHostLifetime
[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
type WindowsServiceLifetime = class
    inherit ServiceBase
    interface IHostLifetime
type WindowsServiceLifetime = class
    inherit ServiceBase
    interface IHostLifetime
Public Class WindowsServiceLifetime
Inherits ServiceBase
Implements IHostLifetime
継承
属性
実装

コンストラクター

名前 説明
WindowsServiceLifetime(IHostEnvironment, IHostApplicationLifetime, ILoggerFactory, IOptions<HostOptions>, IOptions<WindowsServiceLifetimeOptions>)

WindowsServiceLifetime クラスの新しいインスタンスを初期化します。

WindowsServiceLifetime(IHostEnvironment, IHostApplicationLifetime, ILoggerFactory, IOptions<HostOptions>)

新しい WindowsServiceLifetime インスタンスを初期化します。

フィールド

名前 説明
MaxNameLength

サービス名の最大サイズを示します。

(継承元 ServiceBase)

プロパティ

名前 説明
AutoLog

イベント ログで Start、Stop、Pause、Continue のコマンドを報告するかどうかを示します。

(継承元 ServiceBase)
CanHandlePowerEvent

コンピューターの電源状態の変更に関する通知をサービスが処理できるかどうかを示す値を取得または設定します。

(継承元 ServiceBase)
CanHandleSessionChangeEvent

ターミナル サーバー セッションから受信したセッション変更イベントをサービスが処理できるかどうかを示す値を取得または設定します。

(継承元 ServiceBase)
CanPauseAndContinue

サービスを一時停止および再開できるかどうかを示す値を取得または設定します。

(継承元 ServiceBase)
CanShutdown

システムのシャットダウン時にサービスに通知する必要があるかどうかを示す値を取得または設定します。

(継承元 ServiceBase)
CanStop

開始後にサービスを停止できるかどうかを示す値を取得または設定します。

(継承元 ServiceBase)
EventLog

Start や Stop などのサービス コマンド呼び出しの通知をアプリケーション イベント ログに書き込むのに使用できるイベント ログを取得します。

(継承元 ServiceBase)
ExitCode

サービスの終了コードを取得または設定します。

(継承元 ServiceBase)
ServiceHandle

サービスのサービス コントロール ハンドルを取得します。

(継承元 ServiceBase)
ServiceName

システムに対するサービスを識別するために使用する短い名前を取得または設定します。

(継承元 ServiceBase)

メソッド

名前 説明
Dispose(Boolean)

WindowsServiceLifetimeによって使用されるリソースを解放します。

OnContinue()

派生クラスで実装すると、サービス コントロール マネージャー (SCM) によって Continue コマンドがサービスに送信されたときに、 OnContinue() が実行されます。 一時停止後にサービスが通常の機能を再開したときに実行するアクションを指定します。

(継承元 ServiceBase)
OnCustomCommand(Int32)

派生クラスで実装すると、サービス コントロール マネージャー (SCM) がカスタム コマンドをサービスに渡すと、 OnCustomCommand(Int32) が実行されます。 指定したパラメーター値を持つコマンドが発生したときに実行するアクションを指定します。

(継承元 ServiceBase)
OnPause()

派生クラスで実装された場合、Pause コマンドが Service Control Manager (SCM) によってサービスに送信されたときに実行されます。 サービスが一時停止したときに実行するアクションを指定します。

(継承元 ServiceBase)
OnPowerEvent(PowerBroadcastStatus)

派生クラスで実装された場合は、コンピューターの電源状態が変更されたときに実行されます。 これは、ラップトップ コンピューターが中断モードになったときに適用されます。これは、システムのシャットダウンと同じではありません。

(継承元 ServiceBase)
OnSessionChange(SessionChangeDescription)

ターミナル サーバー セッションから変更イベントを受信したときに実行されます。

(継承元 ServiceBase)
OnShutdown()

サービス コントロール マネージャー (SCM) によって Shutdown コマンドがサービスに送信されたときに実行されます。

OnStart(String[])

派生クラスで実装されている場合は、Service Control Manager (SCM) によって Start コマンドがサービスに送信されたとき、またはオペレーティング システムが起動したときに実行されます (自動的に開始されるサービスの場合)。 サービスの開始時に実行するアクションを指定します。

OnStop()

サービス コントロール マネージャー (SCM) によって Stop コマンドがサービスに送信されたときに実行されます。

RequestAdditionalTime(Int32)

保留中の操作に対して追加の時間を要求します。

(継承元 ServiceBase)
RequestAdditionalTime(TimeSpan)

このメソッドが OnStart、OnStop、OnPause、または OnContinue から呼び出されると、サービスが応答していないとマークされないように、指定された待機ヒントが Service Control Manager に渡されます。

(継承元 ServiceBase)
ServiceMainCallback(Int32, IntPtr)

コマンド ハンドラーを登録し、サービスを開始します。

(継承元 ServiceBase)
Stop()

実行中のサービスを停止します。

(継承元 ServiceBase)
StopAsync(CancellationToken)

ホストを非同期的に停止してシャットダウンします。 このメソッドは、 StopAsync(CancellationToken)から呼び出されます。

WaitForStartAsync(CancellationToken)

開始が完了するまで非同期的に待機してから続行します。 このメソッドは、 StartAsync(CancellationToken)の先頭で呼び出されます。 これを使って、外部イベントによって通知されるまで開始を遅らせることができます。

適用対象