Метод CGlobalModule::OnGlobalHealthCheck

Статья
07/19/2023

Представляет метод, который будет обрабатывать GlobalHealthCheck событие, которое возникает при выполнении операции, связанной с работоспособностью.

Синтаксис

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalHealthCheck(  
   VOID  
);

Параметры

Этот метод не принимает параметров.

Возвращаемое значение

Значение GLOBAL_NOTIFICATION_STATUS.

Если глобальный модуль зарегистрирован для уведомления о событии GL_HEALTH_CHECK , службы IIS будут вызывать метод модуля OnGlobalHealthCheck при выполнении операции, связанной с работоспособностью. Например, если другой модуль вызывает метод IHttpServer::ReportUnhealthy , СЛУЖБЫ IIS будут вызывать OnGlobalHealthCheck все модули, зарегистрированные для GL_HEALTH_CHECK уведомления.

Примечание

Глобальные модули можно зарегистрироваться для уведомления о GlobalHealthCheck событии, зарегистрировав для GL_HEALTH_CHECK в функции RegisterModule модуля.

Пример

В следующем примере кода показано, как создать 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 параметра . Дополнительные сведения см. в разделе Пошаговое руководство. Создание модуля HTTP Global-Level с помощью машинного кода.

При необходимости можно компилировать код с помощью соглашения о __stdcall (/Gz) вызовах вместо явного объявления соглашения о вызовах для каждой функции.

Требования

Тип	Описание
клиент	— IIS 7.0 в Windows Vista — IIS 7.5 в Windows 7 — IIS 8.0 в Windows 8 — IIS 10.0 в Windows 10
Сервер	— IIS 7.0 в Windows Server 2008 — IIS 7.5 в Windows Server 2008 R2 — IIS 8.0 в Windows Server 2012 — IIS 8.5 в Windows Server 2012 R2 — IIS 10.0 в Windows Server 2016
Продукт	— 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
Заголовок	Httpserv.h

См. также:

Класс CGlobalModule

Поделиться через