Функция PFN_REGISTERMODULE

Статья
07/19/2023

Определяет RegisterModule прототип функции для http-модулей машинного кода.

Синтаксис

typedef HRESULT(WINAPI* PFN_REGISTERMODULE)(  
   DWORD dwServerVersion,  
   IHttpModuleRegistrationInfo* pModuleInfo,  
   IHttpServer* pGlobalInfo  
);

Параметры

dwServerVersion
Объект DWORD , содержащий основной номер версии IIS.

pModuleInfo
Указатель на интерфейс IHttpModuleRegistrationInfo .

pGlobalInfo
Указатель на интерфейс IHttpServer .

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

Объект HRESULT. Допустимые значения включают, но не ограничиваются, значения, приведенные в следующей таблице.

Значение	Описание:
S_OK	Указывает, что операция выполнена успешно.

Примечание

Модуль может возвращать любое допустимое HRESULT значение, но он должен возвращать по крайней мере S_OK, чтобы указать, что RegisterModule функция выполнена успешно.

Все http-модули должны экспортировать свою RegisterModule функцию, чтобы iis загружали модуль. Функцию RegisterModule можно экспортировать, создав файл определения модуля (DEF) для проекта DLL или скомпилируя модуль с помощью /EXPORT:RegisterModule параметра .

Функция RegisterModule должна использовать IHttpModuleRegistrationInfo интерфейс для регистрации уведомлений с помощью методов SetRequestNotifications и SetGlobalNotifications . RegisterModule также потребуется использовать для IHttpModuleRegistrationInfo регистрации приоритетов модулей с помощью методов SetPriorityForRequestNotification и SetPriorityForGlobalNotification .

Параметр dwServerVersion содержит номер основной версии для версии IIS, загружающей модуль. Например, для IIS 7.0 dwServerVersion параметр будет содержать значение 7.

Когда СЛУЖБА IIS вызывает функцию RegisterModule , она предоставляет IHttpServer интерфейс, который модуль может использовать для получения сведений на уровне сервера.

Примечание

События трассировки не должны вызываться (с помощью метода IHttpTraceContext::QuickTrace или любых других средств через метод IHttpServer::GetTraceContext) в RegisterModule реализации функции. Вызов событий трассировки внутри RegisterModule может привести к нарушению доступа, так как это слишком рано в конвейере запросов.

Пример

В следующем примере кода показано, как создать простой http-модуль "Hello World". Модуль определяет экспортированную RegisterModule функцию, которая передает экземпляр интерфейса IHttpModuleFactory методу IHttpModuleRegistrationInfo::SetRequestNotifications и регистрирует для уведомления RQ_BEGIN_REQUEST . Iis использует метод IHttpModuleFactory::GetHttpModule для создания экземпляра класса CHttpModule и возвращает состояние успешного выполнения. Службы IIS также используют метод IHttpModuleFactory::Terminate для удаления фабрики из памяти.

При появлении RQ_BEGIN_REQUEST уведомления IIS вызывает метод CHttpModule::OnBeginRequest модуля для обработки текущего запроса. OnBeginRequest очищает буфер ответа и изменяет тип MIME для ответа. Затем метод создает блок данных, содержащий строку "Hello World", и возвращает ее веб-клиенту. Наконец, модуль возвращает индикатор состояния, который уведомляет IIS о завершении всех уведомлений, а затем завершает работу.

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

// Create the module class.
class CHelloWorld : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Retrieve a pointer to the response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();

        // Test for an error.
        if (pHttpResponse != NULL)
        {
            // Clear the existing response.
            pHttpResponse->Clear();
            // Set the MIME type to plain text.
            pHttpResponse->SetHeader(
                HttpHeaderContentType,"text/plain",
                (USHORT)strlen("text/plain"),TRUE);

            // Create a string with the response.
            PCSTR pszBuffer = "Hello World!";
            // Create a data chunk.
            HTTP_DATA_CHUNK dataChunk;
            // Set the chunk to a chunk in memory.
            dataChunk.DataChunkType = HttpDataChunkFromMemory;
            // Buffer for bytes written of data chunk.
            DWORD cbSent;
            
            // Set the chunk to the buffer.
            dataChunk.FromMemory.pBuffer =
                (PVOID) pszBuffer;
            // Set the chunk size to the buffer size.
            dataChunk.FromMemory.BufferLength =
                (USHORT) strlen(pszBuffer);
            // Insert the data chunk into the response.
            hr = pHttpResponse->WriteEntityChunks(
                &dataChunk,1,FALSE,TRUE,&cbSent);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the HTTP status.
                pHttpResponse->SetStatus(500,"Server Error",0,hr);
            }

            // End additional processing.
            return RQ_NOTIFICATION_FINISH_REQUEST;
        }

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
};

// Create the module's class factory.
class CHelloWorldFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

        // Create a new instance.
        CHelloWorld * pModule = new CHelloWorld;

        // Test for an error.
        if (!pModule)
        {
            // Return an error if the factory cannot create the instance.
            return HRESULT_FROM_WIN32( ERROR_NOT_ENOUGH_MEMORY );
        }
        else
        {
            // Return a pointer to the module.
            *ppModule = pModule;
            pModule = NULL;
            // Return a success status.
            return S_OK;
        }            
    }

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

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

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        new CHelloWorldFactory,
        RQ_BEGIN_REQUEST,
        0
    );
}

Модуль должен экспортировать функцию RegisterModule . Эту функцию можно экспортировать, создав файл определения модуля (DEF) для проекта, или скомпилировать модуль с помощью /EXPORT:RegisterModule параметра . Дополнительные сведения см. в разделе Пошаговое руководство. Создание модуля HTTP Request-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

См. также:

Интерфейс IHttpModuleRegistrationInfo
Метод IHttpModuleRegistrationInfo::SetGlobalNotifications
Метод IHttpModuleRegistrationInfo::SetPriorityForGlobalNotification
Метод IHttpModuleRegistrationInfo::SetPriorityForRequestNotification
Метод IHttpModuleRegistrationInfo::SetRequestNotifications
Интерфейс IHttpServer

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