Перечисление GLOBAL_NOTIFICATION_STATUS

Статья
07/19/2023

Определяет возвращаемые значения для уведомлений глобального уровня.

Синтаксис

typedef enum GLOBAL_NOTIFICATION_STATUS{  
   GL_NOTIFICATION_CONTINUE,  
   GL_NOTIFICATION_HANDLED  
};

Члены

Имя участника	Описание
`GL_NOTIFICATION_CONTINUE`	Указывает, что СЛУЖБЫ IIS должны продолжать обработку дополнительных уведомлений глобального уровня.
`GL_NOTIFICATION_HANDLED`	Указывает, что службы IIS завершили обработку уведомлений глобального уровня и не должны обрабатывать дополнительные уведомления глобального уровня.

Члены перечисления GLOBAL_NOTIFICATION_STATUS используются в качестве возвращаемых значений из уведомлений глобального уровня, а члены помогают управлять потоком процесса в конвейере обработки уведомлений глобального уровня. Например, при возврате GL_NOTIFICATION_CONTINUE из обработчика уведомлений глобального уровня службам IIS предписывается продолжить обработку дополнительных уведомлений глобального уровня, тогда как при возврате GL_NOTIFICATION_HANDLED из обработчика уведомлений глобального уровня iis сообщается, что обработка на глобальном уровне завершена, и iis не должны обрабатывать дополнительные уведомления глобального уровня.

Пример

В следующем примере кода показано, как создать простой модуль 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

См. также:

Перечисления основных веб-серверов
Перечисление REQUEST_NOTIFICATION_STATUS

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