IHttpModuleFactory::GetHttpModule, méthode

Article
07/19/2023

Crée un instance d’une classe CHttpModule.

Syntaxe

virtual HRESULT GetHttpModule(  
   OUT CHttpModule** ppModule,  
   IN IModuleAllocator* pAllocator  
) = 0;

Paramètres

ppModule
[OUT] Pointeur déréférencé vers une classe CHttpModule .

pAllocator
[IN] Pointeur vers une interface IModuleAllocator .

Valeur renvoyée

Élément HRESULT. Les valeurs possibles sont notamment celles figurant dans le tableau suivant.

Valeur	Description
S_OK	Indique que l’opération a réussi.

Notes

Étant donné que votre fabrique de module est requise pour fournir une GetHttpModule méthode, vous pouvez fournir n’importe quel code status pour la valeur de retour en fonction de votre application. Au minimum, votre GetHttpModule méthode doit retourner S_OK pour indiquer une réussite.

Remarques

Une interface IHttpModuleFactory doit fournir une GetHttpModule méthode qui crée un instance de votre CHttpModule classe. Quand IIS appelle la fonction RegisterModule exportée de votre module, IIS utilise la méthode de la fabrique de GetHttpModule module pour créer une instance de votre CHttpModule classe.

Exemple

L’exemple de code suivant montre comment créer un module HTTP simple « Hello World ». Le module définit une fonction exportée RegisterModule qui transmet une instance d’une IHttpModuleFactory interface à la méthode IHttpModuleRegistrationInfo::SetRequestNotifications et s’inscrit pour la notification RQ_BEGIN_REQUEST. IIS utilise la GetHttpModule méthode pour créer un instance d’une CHttpModule classe et retourne une status de réussite. IIS utilise également la méthode Terminate de l’interface IHttpModuleFactory pour supprimer la fabrique de la mémoire.

Lorsqu’une RQ_BEGIN_REQUEST notification est déclenchée, IIS appelle la méthode CHttpModule::OnBeginRequest du module pour traiter la requête actuelle. OnBeginRequest efface la mémoire tampon de réponse et modifie le type MIME de la réponse. La méthode crée ensuite un bloc de données qui contient une chaîne « Hello World » et retourne la chaîne à un client Web. Enfin, le module retourne un indicateur de status qui avertit IIS que toutes les notifications sont terminées, puis se ferme.

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

// Create the module class.
class CHelloWorld : 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;
        
        // Retrieve a pointer to the response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();

        // Test for an error.
        if (pHttpResponse != NULL)
        {
            // Clear the existing response.
            pHttpResponse->Clear();
            // Set the MIME type to plain text.
            pHttpResponse->SetHeader(
                HttpHeaderContentType,"text/plain",
                (USHORT)strlen("text/plain"),TRUE);

            // Create a string with the response.
            PCSTR pszBuffer = "Hello World!";
            // 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 = pHttpResponse->WriteEntityChunks(
                &dataChunk,1,FALSE,TRUE,&cbSent);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the HTTP status.
                pHttpResponse->SetStatus(500,"Server Error",0,hr);
            }

            // End additional processing.
            return RQ_NOTIFICATION_FINISH_REQUEST;
        }

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

// Create the module's class factory.
class CHelloWorldFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

        // Create a new instance.
        CHelloWorld * pModule = new CHelloWorld;

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

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
IHttpModuleFactory, interface
Conception de modules HTTP Native-Code
Procédure pas à pas : création d’un module HTTP Request-Level à l’aide de code natif

Partager via