Класс CGlobalModule

Статья
07/19/2023

Определяет базовый класс для модулей HTTP глобального уровня.

Синтаксис

class CGlobalModule

Методы

В следующей таблице перечислены методы, предоставляемые классом CGlobalModule .

Имя	Описание
OnGlobalApplicationPreload	deddc775-1ab0-492c-bda0-b32be5d4f4cc
OnGlobalApplicationResolveModules	Представляет метод, который будет обрабатывать `GlobalApplicationResolveModules` событие, которое возникает при разрешении служб IIS зарегистрированных модулей.
OnGlobalApplicationStart	Представляет метод, который будет обрабатывать `GlobalApplicationStart` событие, которое возникает при запуске приложения IIS.
OnGlobalApplicationStop	Представляет метод, который будет обрабатывать `GlobalApplicationStop` событие, которое происходит при завершении работы приложения IIS.
OnGlobalCacheCleanup	Представляет метод, обрабатывающий событие `GlobalCacheCleanup`.
OnGlobalCacheOperation	Представляет метод, который будет обрабатывать `GlobalCacheOperation` событие, которое происходит при выполнении iis операции, связанной с кэшем.
OnGlobalConfigurationChange	Представляет метод, который будет обрабатывать `GlobalConfigurationChange` событие, которое происходит при изменении файла конфигурации.
OnGlobalCustomNotification	Представляет метод, который будет обрабатывать `GlobalCustomNotification` событие, которое возникает, когда модуль создает определяемое пользователем уведомление.
OnGlobalFileChange	Представляет метод, который будет обрабатывать `GlobalFileChange` событие, которое возникает при изменении файла на веб-сайте.
OnGlobalHealthCheck	Представляет метод, который будет обрабатывать `GlobalHealthCheck` событие, которое возникает при выполнении операции, связанной с работоспособностью.
OnGlobalPreBeginRequest	Представляет метод, который будет обрабатывать `GlobalPreBeginRequest` событие, которое происходит до того, как запрос войдет в конвейер.
OnGlobalRSCAQuery	Представляет метод, который будет обрабатывать `GlobalRSCAQuery` событие, которое возникает при выполнении запроса состояния Run-Time и управления.
OnGlobalStopListening	Представляет метод, который будет обрабатывать `GlobalStopListening` событие, которое возникает, когда СЛУЖБЫ IIS перестают принимать новые запросы.
OnGlobalThreadCleanup	Представляет метод, который будет обрабатывать `GlobalThreadCleanup` событие, которое происходит, когда СЛУЖБЫ IIS возвращают поток в пул потоков.
OnGlobalTraceEvent	Представляет метод, который будет обрабатывать `GlobalTraceEvent` событие, которое возникает при возникновении события трассировки.
Завершение	Представляет метод, который iis вызывает, когда глобальный модуль завершил обработку.

Производные классы

Этот класс не содержит производных классов.

Класс CGlobalModule является базовым классом для модулей HTTP глобального уровня. Модули HTTP глобального уровня должны содержать класс, наследующий от CGlobalModule. CGlobalModule определяет методы, которые iis 7 вызывает для обработки уведомлений глобального уровня при возникновении событий глобального уровня. Модуль HTTP может регистрироваться для определенных событий, определяя список уведомлений в экспортируемой функции RegisterModule модуля. После завершения обработки модуля глобального уровня модуль должен использовать метод CGlobalModule::Terminate для удаления CGlobalModule экземпляров из памяти.

Пример

В следующем примере кода показано, как создать простой http-модуль глобального уровня "Hello World". Модуль определяет экспортированную функцию RegisterModule , которая создает экземпляр класса, производного от CGlobalModule. Если не удается создать класс, функция завершает работу с кодом ошибки; В противном случае функция вызывает метод IHttpModuleRegistrationInfo::SetRequestNotifications для регистрации уведомления GL_PRE_BEGIN_REQUEST .

При появлении GL_PRE_BEGIN_REQUEST уведомления IIS вызывает метод CGlobalModule::OnGlobalPreBeginRequest модуля для обработки уведомления. Метод вызывает частный метод для записи события в журнал приложения Просмотр событий, а затем возвращает GL_NOTIFICATION_CONTINUE, чтобы уведомить IIS о продолжении обработки других уведомлений. После завершения обработки IIS вызывает метод CGlobalModule::Terminate модуля, чтобы удалить класс из памяти.

#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_APPLICATION_START notification.
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalPreBeginRequest(
        IN IPreBeginRequestProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        WriteEventViewerLog( "Hello World!" );
        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_PRE_BEGIN_REQUEST );
}

Модуль должен экспортировать функцию 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

См. также:

Классы основных веб-серверов
Создание Native-Code http-модулей
Класс CHttpModule

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