CGlobalModule-Klasse

Definiert die Basisklasse für HTTP-Module auf globaler Ebene.

Syntax

class CGlobalModule  

Methodik

In der folgenden Tabelle sind die Methoden aufgeführt, die von der CGlobalModule Klasse verfügbar gemacht werden.

Abgeleitete Klassen

Diese Klasse enthält keine abgeleiteten Klassen.

Bemerkungen

Die CGlobalModule Klasse ist die Basisklasse für HTTP-Module auf globaler Ebene. HTTP-Module auf globaler Ebene müssen eine Klasse enthalten, von CGlobalModuleder geerbt wird. CGlobalModule definiert die Methoden, die IIS 7 aufruft, um Benachrichtigungen auf globaler Ebene zu behandeln, wenn Ereignisse auf globaler Ebene auftreten. Ein HTTP-Modul kann sich für bestimmte Ereignisse registrieren, indem eine Liste von Benachrichtigungen in der exportierten RegisterModule-Funktion eines Moduls definiert wird. Wenn ein Modul auf globaler Ebene die Verarbeitung abgeschlossen hat, sollte das Modul die CGlobalModule::Terminate-Methode verwenden, um Instanzen aus dem Arbeitsspeicher zu entfernen CGlobalModule .

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie sie ein einfaches HTTP-Modul auf globaler Ebene "Hallo Welt" erstellen. Das Modul definiert eine exportierte RegisterModule-Funktion , die eine Instanz einer Klasse erstellt, von der abgeleitet CGlobalModulewird. Wenn die Klasse nicht erstellt werden kann, wird die Funktion mit einem Fehlercode beendet. andernfalls ruft die Funktion die IHttpModuleRegistrationInfo::SetRequestNotifications-Methode auf, um sich für die GL_PRE_BEGIN_REQUEST-Benachrichtigung zu registrieren.

Wenn eine GL_PRE_BEGIN_REQUEST Benachrichtigung auftritt, ruft IIS die CGlobalModule::OnGlobalPreBeginRequest-Methode des Moduls auf, um die Benachrichtigung zu verarbeiten. Die Methode ruft eine private Methode auf, um ein Ereignis in das Anwendungsprotokoll der Ereignisanzeige zu schreiben, und gibt dann GL_NOTIFICATION_CONTINUE zurück, um IIS zu benachrichtigen, um die Verarbeitung anderer Benachrichtigungen fortzusetzen. Wenn die Verarbeitung abgeschlossen ist, ruft IIS die CGlobalModule::Terminate-Methode des Moduls auf, um die Klasse aus dem Arbeitsspeicher zu entfernen.

#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_APPLICATION_START notification.
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalPreBeginRequest(
        IN IPreBeginRequestProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        WriteEventViewerLog( "Hello World!" );
        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_PRE_BEGIN_REQUEST );
}

Ihr Modul muss die RegisterModule-Funktion exportieren. Sie können diese Funktion exportieren, indem Sie eine Moduldefinitionsdatei (.def) für Ihr Projekt erstellen oder das Modul mithilfe der /EXPORT:RegisterModule Option kompilieren. Weitere Informationen finden Sie unter Walkthrough: Creating a Global-Level HTTP Module By Using Native Code.

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

Anforderungen

Siehe auch

Web Server Core-Klassen
Erstellen von Native-Code-HTTP-Modulen
CHttpModule-Klasse