CGlobalModule::OnGlobalHealthCheck メソッド

正常性関連の操作が実行されたときに発生するイベントを処理 GlobalHealthCheck するメソッドを表します。

構文

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalHealthCheck(  
   VOID  
);  

パラメーター

このメソッドは、パラメーターを受け取りません。

戻り値

GLOBAL_NOTIFICATION_STATUS値。

解説

グローバル モジュールが GL_HEALTH_CHECK イベント通知に登録されている場合、IIS は正常性関連の操作が発生したときにモジュールの OnGlobalHealthCheck メソッドを呼び出します。 たとえば、別のモジュールが IHttpServer::ReportUnhealthy メソッドを呼び出すと、IIS は通知に登録されているGL_HEALTH_CHECKモジュールを呼び出OnGlobalHealthCheckします。

注意

グローバル モジュールは、モジュールの GlobalHealthCheckRegisterModule 関数に をGL_HEALTH_CHECK登録することで、イベント通知に登録できます。

例

次のコード例では、イベント通知に登録するグローバル レベルの HTTP モジュールを作成する方法を GL_HEALTH_CHECK 示します。 正常性関連の操作が発生した場合、IIS はモジュールの例の OnGlobalHealthCheck メソッドを呼び出します。 このメソッドは、Windows イベント ビューアーのアプリケーション ログにエントリを書き込み、終了します。

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>

// Create the module's global class.
class MyGlobalModule : public CGlobalModule
{
public:

    // Process a GL_HEALTH_CHECK notification.
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalHealthCheck(
        VOID
    )
    {
        WriteEventViewerLog("OnGlobalHealthCheck");
        return GL_NOTIFICATION_CONTINUE;
    }

    VOID Terminate()
    {
        // Remove the class from memory.
        delete this;
    }

    MyGlobalModule()
    {
        // Open a handle to the Event Viewer.
        m_hEventLog = RegisterEventSource( NULL,"IISADMIN" );
    }

    ~MyGlobalModule()
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != m_hEventLog)
        {
            // Close the handle to the Event Viewer.
            DeregisterEventSource( m_hEventLog );
            m_hEventLog = NULL;
        }
    }

private:

    // Create a handle for the event viewer.
    HANDLE m_hEventLog;

    // Define a method that writes to the Event Viewer.
    BOOL WriteEventViewerLog(LPCSTR szNotification)
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != m_hEventLog)
        {
            // Write any strings to the Event Viewer and return.
            return ReportEvent(
                m_hEventLog,
                EVENTLOG_INFORMATION_TYPE, 0, 0,
                NULL, 1, 0, &szNotification, NULL );
        }
        return FALSE;
    }
};

// Create the module's exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( pGlobalInfo );

    // Create an instance of the global module class.
    MyGlobalModule * pGlobalModule = new MyGlobalModule;
    // Test for an error.
    if (NULL == pGlobalModule)
    {
        return HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
    }
    // Set the global notifications and exit.
    return pModuleInfo->SetGlobalNotifications(
        pGlobalModule, GL_HEALTH_CHECK );
}

モジュールは RegisterModule 関数をエクスポートする必要があります。 この関数をエクスポートするには、プロジェクトのモジュール定義 (.def) ファイルを作成するか、スイッチを使用してモジュールを /EXPORT:RegisterModule コンパイルします。 詳細については、「 チュートリアル: ネイティブ コードを使用したGlobal-Level HTTP モジュールの作成」を参照してください。

必要に応じて、各関数の呼び出し規約を __stdcall (/Gz) 明示的に宣言するのではなく、呼び出し規約を使用してコードをコンパイルできます。

要件

Type	説明
Client	- Windows Vista 上の IIS 7.0 - Windows 7 上の IIS 7.5 - Windows 8 の IIS 8.0 - Windows 10の IIS 10.0
サーバー	- Windows Server 2008 の IIS 7.0 - Windows Server 2008 R2 上の IIS 7.5 - Windows Server 2012 上の IIS 8.0 - Windows Server 2012 R2 上の IIS 8.5 - Windows Server 2016上の IIS 10.0
製品	- IIS 7.0、IIS 7.5、IIS 8.0、IIS 8.5、IIS 10.0 - IIS Express 7.5、IIS Express 8.0、IIS Express 10.0
Header	Httpserv.h

参照

CGlobalModule クラス