CGlobalModule::OnGlobalCacheCleanup-Methode

Artikel
07/19/2023

Stellt die Methode zur Behandlung eines GlobalCacheCleanup-Ereignisses dar.

Syntax

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalCacheCleanup(  
   VOID  
);

Parameter

Diese Methode nimmt zwei Parameter entgegen.

Rückgabewert

Ein GLOBAL_NOTIFICATION_STATUS Wert.

Bemerkungen

Wenn ein globales Modul für die GL_CACHE_CLEANUP Ereignisbenachrichtigung registriert wurde, ruft IIS die Methode des Moduls OnGlobalCacheCleanup auf, wenn der Cache vor der Beendigung gelöscht wird.

Hinweis

Globale Module können sich für die GlobalCacheCleanup Ereignisbenachrichtigung registrieren, indem sie sich in der RegisterModule-Funktion des Moduls registrierenGL_CACHE_CLEANUP.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie ein HTTP-Modul auf globaler Ebene erstellt wird, das sich für die GL_CACHE_CLEANUP Benachrichtigung registriert. Wenn ein Cachebereinigungsvorgang ausgeführt wird, ruft IIS die Methode des Beispielmoduls OnGlobalCacheCleanup auf. Diese Methode schreibt einen Eintrag in das Anwendungsprotokoll der Windows-Ereignisanzeige und beendet dann.

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

// Create the module's global class.
class MyGlobalModule : public CGlobalModule
{
public:

    // Process a GL_CACHE_CLEANUP notification.
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalCacheCleanup(
        VOID
    )
    {
        WriteEventViewerLog("OnGlobalCacheCleanup");
        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" );
    }

    ~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;

    // 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 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_CACHE_CLEANUP );
}

Ihr Modul muss die Funktion RegisterModule exportieren. Sie können diese Funktion exportieren, indem Sie eine Moduldefinitionsdatei (.def) für Ihr Projekt erstellen, oder Sie können das Modul mithilfe des /EXPORT:RegisterModule Switches kompilieren. Weitere Informationen finden Sie unter Exemplarische Vorgehensweise: Erstellen eines Global-Level HTTP-Moduls mithilfe von nativem Code.

Sie können den Code optional kompilieren, indem Sie die __stdcall (/Gz) aufrufende Konvention verwenden, anstatt die aufrufende Konvention für jede Funktion explizit zu deklarieren.

Anforderungen

type	BESCHREIBUNG
Client	– IIS 7.0 unter Windows Vista – IIS 7.5 unter Windows 7 – IIS 8.0 unter Windows 8 – IIS 10.0 auf Windows 10
Server	– IIS 7.0 unter Windows Server 2008 – IIS 7.5 unter Windows Server 2008 R2 – IIS 8.0 unter Windows Server 2012 – IIS 8.5 unter Windows Server 2012 R2 – IIS 10.0 auf Windows Server 2016
Produkt	– 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
Header	Httpserv.h

Weitere Informationen

CGlobalModule-Klasse
CGlobalModule::OnGlobalCacheOperation-Methode

Freigeben über