ServiceBase.RequestAdditionalTime メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

ServiceBase.RequestAdditionalTime メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

保留中の操作について時間の延長を要求します。

名前空間: System.ServiceProcess
アセンブリ: System.ServiceProcess (system.serviceprocess.dll 内)
構文

Visual Basic (宣言)

<ComVisibleAttribute(False)> _
Public Sub RequestAdditionalTime ( _
    milliseconds As Integer _
)

Visual Basic (使用法)

Dim instance As ServiceBase
Dim milliseconds As Integer

instance.RequestAdditionalTime(milliseconds)

[ComVisibleAttribute(false)] 
public void RequestAdditionalTime (
    int milliseconds
)

C++

[ComVisibleAttribute(false)] 
public:
void RequestAdditionalTime (
    int milliseconds
)

/** @attribute ComVisibleAttribute(false) */ 
public void RequestAdditionalTime (
    int milliseconds
)

JScript

ComVisibleAttribute(false) 
public function RequestAdditionalTime (
    milliseconds : int
)

パラメータ

milliseconds: 要求する時間 (ミリ秒単位)。

例外

例外の種類	条件
InvalidOperationException	サービスは保留状態ではありません。

解説

RequestAdditionalTime メソッドはオーバーライドされた OnContinue、OnPause、OnStart、または OnStop メソッドから呼び出され、保留中の操作の延長時間を要求して、サービスコントロールマネージャ (SCM) がサービスに応答なしのマークを付けないようにします。保留中の操作が Continue、Pause、Start、または Stop のいずれでもない場合は、InvalidOperationException がスローされます。

使用例

ServiceBase から派生したクラスで RequestAdditionalTime メソッドを使用するコード例を次に示します。このコード例は、ServiceBase クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

    ' Stop this service.
    Protected Overrides Sub
 OnStop()
        ' New in .NET Framework version 2.0.
        Me.RequestAdditionalTime(4000)
        ' Signal the worker thread to exit.
        If Not (workerThread Is
 Nothing) AndAlso workerThread.IsAlive Then
#If LOGEVENTS Then
            System.Diagnostics.EventLog.WriteEntry("SimpleService.OnStop",
 DateTime.Now.ToLongTimeString() + _
                " - Stopping the service worker thread.")
#End If
            pause.Reset()
            Thread.Sleep(5000)

            workerThread.Abort()
        End If
        If Not (workerThread Is
 Nothing) Then
#If LOGEVENTS Then
            System.Diagnostics.EventLog.WriteEntry("SimpleService.OnStop",
 DateTime.Now.ToLongTimeString() + _
                " - OnStop Worker thread state = "
 + workerThread.ThreadState.ToString())
#End If
        End If
        ' Indicate a successful exit.
        Me.ExitCode = 0

    End Sub 'OnStop

        // Stop this service.
        protected override void OnStop()
        {
            // New in .NET Framework version 2.0.
            this.RequestAdditionalTime(4000);
            // Signal the worker thread to exit.
            if ((workerThread != null) &&
 (workerThread.IsAlive))
            {
#if LOGEVENTS
                EventLog.WriteEntry("SimpleService.OnStop", DateTime.Now.ToLongTimeString()
 +
                    " - Stopping the service worker thread.");
#endif
                pause.Reset();
                Thread.Sleep(5000);
                workerThread.Abort();

            }
            if (workerThread != null)
            {
#if LOGEVENTS
                EventLog.WriteEntry("SimpleService.OnStop", DateTime.Now.ToLongTimeString()
 +
                    " - OnStop Worker thread state = " +
                    workerThread.ThreadState.ToString());
#endif
            }
            // Indicate a successful exit.
            this.ExitCode = 0;
        }

C++

    // Stop this service.
protected:
    virtual void OnStop() override
    {
        // Signal the worker thread to exit.
        if ( (workerThread != nullptr) && (workerThread->IsAlive)
 )
        {
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Stopping
 the service worker thread.", "OnStop" );
            workerThread->Abort();

            // Wait up to 500 milliseconds for the thread to terminate.
            workerThread->Join( 500 );
        }

        if ( workerThread != nullptr )
        {
            Trace::WriteLine( DateTime::Now.ToLongTimeString() + " - Worker
 thread state = " + workerThread->ThreadState.ToString(), "OnStop"
 );
        }
    }