Método IHttpCompletionInfo::GetCompletionBytes

Artigo
07/19/2023

Retorna o número de bytes concluídos para uma operação assíncrona.

Sintaxe

virtual DWORD GetCompletionBytes(  
   VOID  
) const = 0;

Parâmetros

Este método não aceita parâmetros.

Valor Retornado

Um DWORD que contém o número de bytes.

Comentários

O GetCompletionBytes método permite que você recupere o número de bytes que foram concluídos durante uma operação assíncrona. Quando uma operação é concluída de forma assíncrona, o IIS cria uma interface IHttpCompletionInfo e passa essa interface para o método CHttpModule::OnAsyncCompletion do módulo para processar os resultados da operação assíncrona. Em seguida, você pode usar GetCompletionBytes para recuperar os bytes concluídos para a operação assíncrona.

Por exemplo, se o módulo solicitasse que o método IHttpRequest::ReadEntityBody fosse concluído de forma assíncrona, GetCompletionBytes retornaria o número de bytes lidos. Da mesma forma, se o módulo solicitasse a conclusão assíncrona do método IIHttpResponse::Flush , GetCompletionBytes retornaria o número de bytes liberados para o cliente. Além disso, GetCompletionBytes retorna o número de bytes que você especifica ao chamar o método IHttpContext::P ostCompletion .

Exemplo

O exemplo de código a seguir demonstra como criar um módulo HTTP que executa as seguintes tarefas:

O módulo se registra para as notificações de RQ_BEGIN_REQUEST e RQ_MAP_REQUEST_HANDLER .
O módulo cria uma classe CHttpModule que contém métodos OnBeginRequest, OnMapRequestHandler e OnAsyncCompletion .
Quando um cliente Web solicita uma URL, o IIS chama o método do OnBeginRequest módulo. Esse método executa as seguintes tarefas:
1. Limpa o buffer de resposta existente e define o tipo MIME para a resposta.
2. Cria uma cadeia de caracteres de exemplo e retorna isso para o cliente Web de forma assíncrona.
3. Testa um erro ou uma conclusão assíncrona. Se a conclusão assíncrona estiver pendente, o módulo retornará uma notificação pendente status para o pipeline de processamento de solicitações integrado.
Em seguida, o IIS chama o método do OnMapRequestHandler módulo. Esse método executa as seguintes tarefas:
1. Libera o buffer de resposta atual para o cliente Web.
2. Testa um erro ou uma conclusão assíncrona. Se a conclusão assíncrona estiver pendente, o módulo retornará uma notificação pendente status para o pipeline.
Se a conclusão assíncrona for necessária, o IIS chamará o método do OnAsyncCompletion módulo. Esse método executa as seguintes tarefas:
1. Testa uma interface válida IHttpCompletionInfo . Se uma interface válida IHttpCompletionInfo tiver sido passada, o método chamará os GetCompletionBytes métodos e GetCompletionStatus, respectivamente, para recuperar os bytes concluídos e retornar o status para a operação assíncrona.
2. Cria cadeias de caracteres que contêm as informações de conclusão e grava as informações como um evento no log do aplicativo do Visualizador de Eventos.
O módulo remove a CHttpModule classe da memória e, em seguida, é encerrado.

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>
#include <wchar.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;
        // Create an example string to return to the Web client.
        char szBuffer[] = "Hello World!";
        
        // 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);
        
        // Create a data chunk.
        HTTP_DATA_CHUNK dataChunk;
        // Set the chunk to a chunk in memory.
        dataChunk.DataChunkType = HttpDataChunkFromMemory;
        // Set the chunk to the buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) szBuffer;
        // Set the chunk size to the buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(szBuffer);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,TRUE,TRUE,&cbSent,&fCompletionExpected);

        // Test for a failure.
        if (FAILED(hr))
        {
            // Set the HTTP status.
            pHttpContext->GetResponse()->SetStatus(
                500,"Server Error",0,hr);
            // End additional processing.
            return RQ_NOTIFICATION_FINISH_REQUEST;
        }
        
        // Test for pending asynchronous operations.
        if (fCompletionExpected)
        {
            return RQ_NOTIFICATION_PENDING;
        }

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
    
    REQUEST_NOTIFICATION_STATUS
    OnMapRequestHandler(
        IN IHttpContext * pHttpContext,
        IN IMapHandlerProvider * 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;

        // Flush the response to the client.
        hr = pHttpContext->GetResponse()->Flush(
            TRUE,FALSE,&cbSent,&fCompletionExpected);

        // Test for a failure.
        if (FAILED(hr))
        {
            // Set the HTTP status.
            pHttpContext->GetResponse()->SetStatus(
                500,"Server Error",0,hr);
        }

        // Test for pending asynchronous operations.
        if (fCompletionExpected)
        {
            return RQ_NOTIFICATION_PENDING;
        }

        // End additional processing.
        return RQ_NOTIFICATION_CONTINUE;
    }

    REQUEST_NOTIFICATION_STATUS
        OnAsyncCompletion(
        IN IHttpContext * pHttpContext,
        IN DWORD dwNotification,
        IN BOOL fPostNotification,
        IN IHttpEventProvider * pProvider,
        IN IHttpCompletionInfo * pCompletionInfo
        )
    {        
        if ( NULL != pCompletionInfo )
        {
            // Create strings for completion information.
            char szNotification[256] = "";
            char szBytes[256] = "";
            char szStatus[256] = "";

            // Retrieve and format the completion information.
            sprintf_s(szNotification,255,"Notification: %u",
                dwNotification);
            sprintf_s(szBytes,255,"Completion Bytes: %u",
                pCompletionInfo->GetCompletionBytes());
            sprintf_s(szStatus,255,"Completion Status: 0x%08x",
                pCompletionInfo->GetCompletionStatus());

            // Create an array of strings.
            LPCSTR szBuffer[3] = {szNotification,szBytes,szStatus};
            // Write the strings to the Event Viewer.
            WriteEventViewerLog(szBuffer,3);
        }
        
        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }

    MyHttpModule(void)
    {
        // Open a handle to the Event Viewer.
        m_hEventLog = RegisterEventSource( NULL,"IISADMIN" );
    }

    ~MyHttpModule(void)
    {
        // Test if 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:

    // Handle for the Event Viewer.
    HANDLE m_hEventLog;

    // Define a method that writes to the Event Viewer.
    BOOL WriteEventViewerLog(LPCSTR * lpStrings, WORD wNumStrings)
    {
        // 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, wNumStrings, 0, lpStrings, NULL );
        }
        return FALSE;
    }
};

// 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 | RQ_MAP_REQUEST_HANDLER,
        0
    );
}

Seu módulo deve exportar a função RegisterModule . Você pode exportar essa função criando um arquivo de definição de módulo (.def) para seu projeto ou pode compilar o módulo usando a opção /EXPORT:RegisterModule . Para obter mais informações, consulte Passo a passo: criando um módulo HTTP Request-Level usando código nativo.

Opcionalmente, você pode compilar o código usando a __stdcall (/Gz) convenção de chamada em vez de declarar explicitamente a convenção de chamada para cada função.

Requisitos

Type	Descrição
Cliente	– IIS 7.0 no Windows Vista – IIS 7.5 no Windows 7 – IIS 8.0 no Windows 8 – IIS 10.0 no Windows 10
Servidor	– IIS 7.0 no Windows Server 2008 – IIS 7.5 no Windows Server 2008 R2 – IIS 8.0 no Windows Server 2012 – IIS 8.5 no Windows Server 2012 R2 – IIS 10.0 no Windows Server 2016
Produto	- 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
parâmetro	Httpserv.h

Consulte Também

IHttpCompletionInfo Interface
Método IHttpCompletionInfo::GetCompletionStatus

Compartilhar via

Método IHttpCompletionInfo::GetCompletionBytes

Sintaxe

Parâmetros

Valor Retornado

Comentários

Exemplo

Requisitos

Consulte Também

Comentários

Recursos adicionais