Метод IHttpContext::GetIsLastNotification

Указывает, ожидаются ли дополнительные уведомления для этого запроса в текущем узле модуля.

Синтаксис

virtual BOOL GetIsLastNotification(  
   IN REQUEST_NOTIFICATION_STATUS status  
) = 0;  

Параметры

status
[IN] Значение перечисления REQUEST_NOTIFICATION_STATUS .

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

true значение , если ожидаются дополнительные уведомления; в противном случае — false.

Комментарии

Метод GetIsLastNotification получает состояние ожидающих уведомлений для текущего запроса в текущем узле модуля. То есть метод не указывает, GetIsLastNotification ожидаются ли дополнительные уведомления для другого запроса или для модуля, который выполняется в другом узле модуля.

Значение status параметра напрямую влияет на возвращаемое значение метода GetIsLastNotification . Например, при указании RQ_NOTIFICATION_CONTINUE может быть возвращено true значение , указывающее на ожидание дополнительных уведомлений, в то время как при указании RQ_NOTIFICATION_FINISH_REQUEST может возвращаться false для того же запроса. Это происходит потому, что значение RQ_NOTIFICATION_CONTINUE состояния будет продолжать обрабатывать дополнительные уведомления, которые значение RQ_NOTIFICATION_FINISH_REQUEST состояния будет обходить.

Пример

В следующем примере кода показано, как использовать GetIsLastNotification метод для создания модуля HTTP, который указывает, ожидаются ли дополнительные уведомления для текущего запроса. Затем модуль возвращает эти сведения веб-клиенту.

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

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

        // Retrieve if this is the last notification.
        BOOL bIsLastNotification;
        bIsLastNotification = pHttpContext->GetIsLastNotification(
            RQ_NOTIFICATION_FINISH_REQUEST);
        
        // Clear the existing response.
        pHttpContext->GetResponse()->Clear();
        // Set the MIME type to plain text.
        pHttpContext->GetResponse()->SetHeader(
            HttpHeaderContentType,"text/plain",
            (USHORT)strlen("text/plain"),TRUE);
        
        // Return a string to the client whether this is the last notification.
        WriteResponseMessage(pHttpContext,"Last Notification: ",
            (TRUE==bIsLastNotification)?"Yes":"No");

        // End additional processing.
        return RQ_NOTIFICATION_FINISH_REQUEST;
    }

private:

    // Create a utility method that inserts a name/value pair into the response.
    HRESULT WriteResponseMessage(
        IHttpContext * pHttpContext,
        PCSTR pszName,
        PCSTR pszValue
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Create a data chunk. (Defined in the Http.h file.)
        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 first buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszName;
        // Set the chunk size to the first buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszName);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Set the chunk to the second buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszValue;
        // Set the chunk size to the second buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszValue);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Return a success status.
        return S_OK;
    }
};

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

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

        // Test for an error.
        if (!pModule)
        {
            // Return an error if we 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 );

    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_BEGIN_REQUEST,
        0
    );
}

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

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

Требования

См. также:

Интерфейс IHttpContext
Метод IHttpContext::D isableNotifications
Метод IHttpContext::GetNextNotification