Partager via


IHttpEventProvider, interface

Fournit une interface générique de création de rapports d’événements.

Syntaxe

class IHttpEventProvider  

Méthodes

Le tableau suivant répertorie les méthodes exposées par la IHttpEventProvider classe .

Nom Description
SetErrorStatus Spécifie une erreur à retourner.

Classes dérivées

Le tableau suivant répertorie les classes dérivées exposées par l’interface IHttpEventProvider .

Nom Description
IAuthenticationProvider Fournit une interface pour les notifications d’événements RQ_REQUEST_AUTHENTICATE .
ICacheProvider Fournit une interface pour les notifications d’événements GL_CACHE_OPERATION .
ICustomNotificationProvider Fournit une interface pour les notifications d’événements GL_CUSTOM_NOTIFCATION et RQ_CUSTOM_NOTIFCATION .
IGlobalConfigurationChangeProvider Fournit une interface pour les notifications d’événements GL_CONFIGURATION_CHANGE .
IGlobalFileChangeProvider Fournit une interface pour les notifications d’événements GL_FILE_CHANGE .
IGlobalRSCAQueryProvider Fournit une interface pour les notifications d’événements GL_RSCA_QUERY .
IGlobalStopListeningProvider Fournit une interface pour les notifications d’événements GL_STOP_LISTENING .
IGlobalThreadCleanupProvider Fournit une interface pour les notifications d’événements GL_THREAD_CLEANUP .
IGlobalTraceEventProvider Fournit une interface pour les notifications d’événements GL_TRACE_EVENT.
IHttpApplicationProvider Fournit une interface pour les notifications d’événements GL_APPLICATION_START .
IMapHandlerProvider Fournit une interface pour les notifications d’événements RQ_DETERMINE_HANDLER .
IMapPathProvider Fournit une interface pour les notifications d’événements RQ_MAP_PATH.
IPreBeginRequestProvider Fournit une interface pour les notifications d’événements GL_PRE_BEGIN_REQUEST .
IReadEntityProvider Fournit une interface pour les notifications d’événements RQ_READ_ENTITY .
ISendResponseProvider Fournit une interface pour les notifications d’événements RQ_SEND_RESPONSE .

Remarques

L’interface IHttpEventProvider fournit l’interface de création de rapports d’événements générique pour la plupart des méthodes de notification, et elle sert de classe parente pour les interfaces de rapport d’événements utilisées avec les notifications restantes.

L’interface IHttpEventProvider expose uniquement la méthode SetErrorStatus, qui définit le status d’erreur pour le contexte actuel. Plusieurs des classes dérivées héritées d’exposent IHttpEventProvider des méthodes supplémentaires spécifiques à leurs événements respectifs.

Exemple

L’exemple de code suivant montre comment créer un module HTTP qui envoie un exemple de chaîne au client Web et capture la valeur de retour de cette opération. Le module utilise la SetErrorStatus méthode pour spécifier la valeur de retour comme status d’erreur pour la requête actuelle, puis se ferme.

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

Votre module doit exporter la fonction RegisterModule . Vous pouvez exporter cette fonction en créant un fichier de définition de module (.def) pour votre projet, ou vous pouvez compiler le module à l’aide du /EXPORT:RegisterModule commutateur. Pour plus d’informations, consultez Procédure pas à pas : création d’un module HTTP Request-Level à l’aide de code natif.

Vous pouvez éventuellement compiler le code à l’aide de la __stdcall (/Gz) convention d’appel au lieu de déclarer explicitement la convention d’appel pour chaque fonction.

Spécifications

Type Description
Client - IIS 7.0 sur Windows Vista
- IIS 7.5 sur Windows 7
- IIS 8.0 sur Windows 8
- IIS 10.0 sur Windows 10
Serveur - IIS 7.0 sur Windows Server 2008
- IIS 7.5 sur Windows Server 2008 R2
- IIS 8.0 sur Windows Server 2012
- IIS 8.5 sur Windows Server 2012 R2
- IIS 10.0 sur Windows Server 2016
Produit - 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
En-tête Httpserv.h

Voir aussi

Interfaces principales du serveur 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