CGlobalModule::OnGlobalThreadCleanup, méthode

Représente la méthode qui gère un GlobalThreadCleanup événement, qui se produit quand IIS retourne un thread au pool de threads.

Syntaxe

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalThreadCleanup(  
   IN IGlobalThreadCleanupProvider* pProvider  
);  

Paramètres

pProvider
[IN] Pointeur vers une interface IGlobalThreadCleanupProvider .

Valeur renvoyée

Valeur GLOBAL_NOTIFICATION_STATUS .

Remarques

Lorsqu’un module global s’est inscrit pour la notification GL_THREAD_CLEANUP , IIS appelle la méthode du OnGlobalThreadCleanup module lorsqu’un thread est retourné au pool de threads une fois l’opération terminée.

Exemple

L’exemple de code suivant montre comment créer un module HTTP qui effectue les tâches suivantes :

1. Le module s’inscrit pour la GL_THREAD_CLEANUP notification.

2. Le module crée une classe CGlobalModule qui contient une OnGlobalThreadCleanup méthode. Cette méthode effectue les tâches suivantes :

   1. Récupère une interface IHttpApplication à l’aide de la méthode IGlobalThreadCleanupProvider::GetApplication .

   2. Récupère l’identificateur d’application de l’application du contexte actuel à l’aide de la méthode IHttpApplication::GetApplicationId .

   3. Écrit les informations d’identificateur d’application en tant qu’événement dans le journal de l’application du observateur d'événements.

3. Le module supprime la classe de la CGlobalModule mémoire, puis se ferme.

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

// Create the module's global class.
class MyGlobalModule : public CGlobalModule
{
public:
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalThreadCleanup(
        IN IGlobalThreadCleanupProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        
        // Retrieve a pointer to the IHttpApplication class.
        IHttpApplication * pHttpApplication =
            pProvider->GetApplication();

        // Retrieve a pointer to the application configuration path.
        PCWSTR pwszApplicationId = pHttpApplication->GetApplicationId();

        // Test for an error.
        if (m_pHttpContext!=NULL)
        {
            // Allocate space for the user name.
            char * pszBuffer = (char*) m_pHttpContext->AllocateRequestMemory(
                (DWORD) wcslen(pwszApplicationId)+1 );
        
            // Test for an error.
            if (pszBuffer!=NULL)
            {
                // Return the user information to the Web client.
                wcstombs(pszBuffer,pwszApplicationId,wcslen(pwszApplicationId));
                // Create an array of strings.
                LPCSTR szBuffer[3] = {"OnGlobalThreadCleanup",
                    "Application ID:",pszBuffer};
                // Write the strings to the Event Viewer.
                WriteEventViewerLog(szBuffer,3);
            }
        }

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

    GLOBAL_NOTIFICATION_STATUS
    OnGlobalPreBeginRequest(
        IN IPreBeginRequestProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        // Retrieve a pointer to the context.
        m_pHttpContext = pProvider->GetHttpContext();
        // Return processing to the pipeline.
        return GL_NOTIFICATION_CONTINUE;
    }

    VOID Terminate()
    {
        // Remove the class from memory.
        delete this;
    }

    MyGlobalModule()
    {
        // Open a handle to the Event Viewer.
        m_hEventLog = RegisterEventSource( NULL,"IISADMIN" );
        // Initialize the context pointer to NULL.
        m_pHttpContext = NULL;
    }

    ~MyGlobalModule()
    {
        // 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;
    // Create a pointer for the module context.
    IHttpContext * m_pHttpContext;

    // 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 exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( pGlobalInfo );

    // Create an instance of the global module class.
    MyGlobalModule * pGlobalModule = new MyGlobalModule;
    // Test for an error.
    if (NULL == pGlobalModule)
    {
        return HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
    }
    // Set the global notifications and exit.
    return pModuleInfo->SetGlobalNotifications(
        pGlobalModule, GL_THREAD_CLEANUP | GL_PRE_BEGIN_REQUEST );
}

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 Global-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

Voir aussi

CGlobalModule, classe