IHttpEventProvider Interface

Fornece uma interface genérica de relatório de eventos.

Syntax

class IHttpEventProvider  

Métodos

A tabela a seguir lista os métodos expostos pela IHttpEventProvider classe .

Nome	Descrição
SetErrorStatus	Especifica um erro a ser retornado.

Classes derivadas

A tabela a seguir lista as classes derivadas expostas pela IHttpEventProvider interface .

Nome	Descrição
IAuthenticationProvider	Fornece uma interface para RQ_REQUEST_AUTHENTICATE notificações de eventos.
ICacheProvider	Fornece uma interface para GL_CACHE_OPERATION notificações de eventos.
ICustomNotificationProvider	Fornece uma interface para notificações de eventos GL_CUSTOM_NOTIFCATION e RQ_CUSTOM_NOTIFCATION .
IGlobalConfigurationChangeProvider	Fornece uma interface para GL_CONFIGURATION_CHANGE notificações de eventos.
IGlobalFileChangeProvider	Fornece uma interface para GL_FILE_CHANGE notificações de eventos.
IGlobalRSCAQueryProvider	Fornece uma interface para GL_RSCA_QUERY notificações de evento.
IGlobalStopListeningProvider	Fornece uma interface para GL_STOP_LISTENING notificações de eventos.
IGlobalThreadCleanupProvider	Fornece uma interface para GL_THREAD_CLEANUP notificações de eventos.
IGlobalTraceEventProvider	Fornece uma interface para GL_TRACE_EVENT notificações de evento.
IHttpApplicationProvider	Fornece uma interface para GL_APPLICATION_START notificações de eventos.
IMapHandlerProvider	Fornece uma interface para RQ_DETERMINE_HANDLER notificações de evento.
IMapPathProvider	Fornece uma interface para RQ_MAP_PATH notificações de evento.
IPreBeginRequestProvider	Fornece uma interface para GL_PRE_BEGIN_REQUEST notificações de evento.
IReadEntityProvider	Fornece uma interface para RQ_READ_ENTITY notificações de evento.
ISendResponseProvider	Fornece uma interface para RQ_SEND_RESPONSE notificações de eventos.

Comentários

A IHttpEventProvider interface fornece a interface genérica de relatório de eventos para a maioria dos métodos de notificação e serve como a classe pai para as interfaces de relatório de eventos que são usadas com as notificações restantes.

A IHttpEventProvider interface expõe apenas o método SetErrorStatus, que define o erro status para o contexto atual. Várias das classes derivadas herdadas de IHttpEventProvider expõem métodos adicionais específicos para seus respectivos eventos.

Exemplo

O exemplo de código a seguir demonstra como criar um módulo HTTP que envia uma cadeia de caracteres de exemplo para o cliente Web e captura o valor retornado dessa operação. O módulo usa o SetErrorStatus método para especificar o valor retornado como o erro status para a solicitação atual e, em seguida, é encerrado.

#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
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;

        // 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 simple message to the Web client.
        hr = WriteResponseMessage(pHttpContext,"Hello World!");

        // Set the error status for the module.
        pProvider->SetErrorStatus( hr );

        // End additional processing.
        return RQ_NOTIFICATION_FINISH_REQUEST;
    }

private:

    // Create a utility method that inserts a string value into the response.
    HRESULT WriteResponseMessage(
        IHttpContext * pHttpContext,
        PCSTR pszBuffer
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // 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 = 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 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
    );
}

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

Interfaces Principais do Servidor Web
IAuthenticationProvider Interface
ICacheProvider Interface
ICustomNotificationProvider Interface
IGlobalConfigurationChangeProvider Interface
IGlobalFileChangeProvider Interface
IGlobalRSCAQueryProvider Interface
IGlobalStopListeningProvider Interface
IGlobalThreadCleanupProvider Interface
IGlobalTraceEventProvider Interface
IHttpApplicationProvider Interface
IMapHandlerProvider Interface
IMapPathProvider Interface
IPreBeginRequestProvider Interface
IReadEntityProvider Interface
ISendResponseProvider Interface