Метод IHttpResponse::Flush

Статья
07/19/2023

Отправляет клиенту существующее содержимое в буфере ответов.

Синтаксис

virtual HRESULT Flush(  
   IN BOOL fAsync,  
   IN BOOL fMoreData,  
   OUT DWORD* pcbSent,  
   OUT BOOL* pfCompletionExpected = NULL  
) = 0;

Параметры

fAsync
[IN] true для асинхронного завершения операции; в противном случае — false.

fMoreData
[IN] true для отправки дополнительных данных в этом ответе; в противном случае — false.

pcbSent
[OUT] Указатель на объект , DWORD который получает количество байтов, отправленных клиенту.

pfCompletionExpected
[OUT] Указатель на логическое значение, которое получает, ожидается ли асинхронное завершение для этого вызова.

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

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

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

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

fMoreData Задайте для параметра значение , true если после вызова Flush метода будут возвращены дополнительные данные, или задайте значение fMoreData , false если данные не остаются.

Метод Flush поддерживает синхронные и асинхронные операции. Укажите режим работы, задав fAsync для параметра значение true , если операция является асинхронной, или задайте значение fAsync , false если операция является синхронной.

Примечание

Если этот метод вызывается асинхронно, необходимо вернуться сразу после вызова .

Пример

В следующем примере кода показано, как использовать Flush метод для отправки текущего ответа клиенту. Flush Так как метод отправил клиенту заголовки ответов, последующий вызов метода Clear не будет иметь никакого эффекта.

#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 );

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        // Buffer to store the byte count.
        DWORD cbSent = 0;
        // Buffer to store if asyncronous completion is pending.
        BOOL fCompletionExpected = false;

        // Retrieve a pointer to the response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();
        
        // Test for an error.
        if (pHttpResponse != NULL)
        {
            // Flush the response to the client.
            hr = pHttpResponse->Flush(false,true,&cbSent,&fCompletionExpected);
            // Test for an error.
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }
            // Clear the response.
            pHttpResponse->Clear();
        }

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

// 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 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 MyHttpModuleFactory,
        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

См. также:

Интерфейс IHttpResponse

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