CHttpModule::OnBeginRequest, méthode

Article
07/19/2023

Représente la méthode qui gère un BeginRequest événement, qui se produit en tant que premier événement dans le pipeline de traitement des requêtes intégré HTTP pour la requête actuelle.

Syntaxe

virtual REQUEST_NOTIFICATION_STATUS OnBeginRequest(  
   IN IHttpContext* pHttpContext,  
   IN IHttpEventProvider* pProvider  
);

Paramètres

pHttpContext
[IN] Pointeur vers une interface IHttpContext .

pProvider
[IN] Pointeur vers une interface IHttpEventProvider .

Valeur renvoyée

Valeur REQUEST_NOTIFICATION_STATUS .

Remarques

Lorsqu’un module au niveau de la demande est inscrit pour la notification d’événement RQ_BEGIN_REQUEST , IIS appelle la méthode du OnBeginRequest module lorsqu’une demande entre dans le pipeline de traitement des demandes intégré.

Notes

Les modules au niveau de la demande peuvent s’inscrire à la BeginRequest notification d’événement en s’inscrivant à RQ_BEGIN_REQUEST dans la fonction RegisterModule du module.

IIS appelle la méthode d’un OnBeginRequest module avant l’authentification et l’autorisation ; cela permet aux développeurs d’utiliser la OnBeginRequest méthode pour traiter les demandes pour lesquelles l’identité du client n’est pas un problème.

Notes

Toutes les requêtes n’entrent pas dans le pipeline intégré de traitement des demandes. Une demande pour un fichier image qui peut être satisfait à partir du cache n’entre pas dans le pipeline de traitement des demandes intégré ; par conséquent, la OnBeginRequest méthode n’est pas appelée.

Exemple

L’exemple suivant montre comment créer un module HTTP au niveau de la demande qui s’inscrit pour les RQ_BEGIN_REQUEST notifications d’événement et post-événement. Lorsqu’une requête entre dans le pipeline, IIS appelle les méthodes de l’exemple de OnBeginRequest module et OnPostBeginRequest . Chaque méthode écrit une entrée dans le journal des applications du observateur d'événements Windows. Une fois le traitement terminé, le module se ferme.

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

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:

    // Process an RQ_BEGIN_REQUEST event.
    REQUEST_NOTIFICATION_STATUS
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pHttpContext );
        UNREFERENCED_PARAMETER( pProvider );
        WriteEventViewerLog("OnBeginRequest");
        return RQ_NOTIFICATION_CONTINUE;
    }

    // Process an RQ_BEGIN_REQUEST post-event.
    REQUEST_NOTIFICATION_STATUS
    OnPostBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pHttpContext );
        UNREFERENCED_PARAMETER( pProvider );
        WriteEventViewerLog("OnPostBeginRequest");
        return RQ_NOTIFICATION_CONTINUE;
    }

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

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

    // Create a handle for the event viewer.
    HANDLE m_hEventLog;

    // Define a method that writes to the Event Viewer.
    BOOL WriteEventViewerLog(LPCSTR szNotification)
    {
        // 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, 1, 0, &szNotification, 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 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(
        // Specify the class factory.
        new MyHttpModuleFactory,
        // Specify the event notifications.
        RQ_BEGIN_REQUEST,
        // Specify the post-event notifications.
        RQ_BEGIN_REQUEST
    );
}

Votre module doit exporter la RegisterModule fonction. 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

CHttpModule, classe
CHttpModule::OnPostBeginRequest, méthode

Partager via