IHttpContext::GetCurrentExecutionStats-Methode

Artikel
07/19/2023

Ruft die Ausführungsstatistiken für den aktuellen Kontext ab.

Syntax

virtual HRESULT GetCurrentExecutionStats(  
   DWORD* pdwNotification,  
   DWORD* pdwNotificationStartTickCount = NULL,  
   PCWSTR* ppszModule = NULL,  
   DWORD* pdwModuleStartTickCount = NULL,  
   DWORD* pdwAsyncNotification = NULL,  
   DWORD* pdwAsyncNotificationStartTickCount = NULL  
) const = 0;

Parameter

pdwNotification
Ein Zeiger auf eine DWORD , die die aktuelle Benachrichtigung enthält.

pdwNotificationStartTickCount
Ein Zeiger auf einen DWORD , der die Anzahl der Teilstriche für den Anfang der aktuellen Benachrichtigung enthält.

ppszModule
Ein Zeiger auf eine Zeichenfolge, die den Namen des aktuellen Moduls enthält.

pdwModuleStartTickCount
Ein Zeiger auf einen DWORD , der die Anzahl der Teilstriche für den Anfang des aktuellen Moduls enthält.

pdwAsyncNotification
Ein Zeiger auf eine DWORD , die die aktuelle asynchrone Benachrichtigung enthält.

pdwAsyncNotificationStartTickCount
Ein Zeiger auf einen DWORD , der die Anzahl der Teilstriche für den Anfang einer asynchronen Benachrichtigung enthält.

Rückgabewert

HRESULT. Mögliches Werte (aber nicht die Einzigen) sind die in der folgenden Tabelle.

Wert	BESCHREIBUNG
NO_ERROR	Gibt an, dass der Vorgang erfolgreich war.
E_INVALIDARG	Gibt an, dass ein angegebener Parameter ungültig ist.

Bemerkungen

Entwickler können die GetCurrentExecutionStats -Methode verwenden, um bestimmte Ausführungsinformationen für den aktuellen Kontext abzurufen. Die Parameter und pdwAsyncNotification enthalten beispielsweise pdwNotification die Werte für die aktuelle synchrone oder asynchrone Benachrichtigung, und der ppszModule Parameter enthält den Namen des Moduls für den aktuellen Kontext.

Drei der Rückgabeparameter , pdwModuleStartTickCountpdwNotificationStartTickCountund pdwAsyncNotificationStartTickCountenthalten die Tick-Anzahl für den Modulstart und den Start der aktuellen synchronen und asynchronen Benachrichtigungen.

Hinweis

Die Anzahl der Teilstriche ist die Anzahl der Millisekunden, die seit dem Start des Systems verstrichen sind. Weitere Informationen zum Abrufen der Anzahl von Teilstrichen finden Sie in der GetTickCount-Methode .

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie ein HTTP-Modul erstellt wird, das die folgenden Aufgaben ausführt:

Das Modul registriert sich für die Benachrichtigungen RQ_BEGIN_REQUEST, RQ_MAP_REQUEST_HANDLER und RQ_SEND_RESPONSE .
Das Modul erstellt eine CHttpModule-Klasse , die die Methoden OnBeginRequest, OnMapRequestHandler und OnSendResponse enthält.
Wenn ein Webclient eine URL anfordert, ruft IIS die Methoden , OnMapRequestHandlerund OnSendResponse des Moduls OnBeginRequestauf. Jede dieser Methoden ruft eine private Methode namens auf RetrieveExecutionStats , die die folgenden Aufgaben ausführt:
1. Ruft die Ausführungsstatistiken mithilfe der GetCurrentExecutionStats -Methode ab und testet auf einen Fehler.
2. Erstellt eine Zeichenfolge, die die Anzahl der Teilstriche für den Anfang der aktuellen Benachrichtigung enthält.
3. Hält für eine Sekunde an.
4. Erstellt eine Zeichenfolge, die die Anzahl verstrichener Teilstriche vom Anfang der aktuellen Benachrichtigung enthält.
5. Schreibt die Ausführungsstatistiken als Ereignis in das Anwendungsprotokoll des Ereignisanzeige.
Das Modul entfernt die CHttpModule -Klasse aus dem Arbeitsspeicher und beendet dann.

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

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

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

    // Define a method the retrieves the current execution statistics.
    void RetrieveExecutionStats(
        IHttpContext * pHttpContext, LPCSTR szNotification )
    {
        HRESULT hr = S_OK;
        DWORD  dwNotification = 0;
        DWORD  dwNotificationStart = 0;
        PCWSTR pszModule = NULL;

        // Retrieve the current execution statistics.
        hr = pHttpContext->GetCurrentExecutionStats(
            &dwNotification,&dwNotificationStart,
            &pszModule,NULL,NULL,NULL);

        // Test for an error.
        if (SUCCEEDED(hr))
        {
            // Create strings for the statistics.
            char szNotificationStart[256];
            char szTimeElapsed[256];
            
            // Retrieve and format the statistics.
            sprintf_s(szNotificationStart,255,
                "Tick count at start of notification: %u",
                dwNotificationStart);
            // Pause for one second.
            Sleep(1000);
            // Retrieve and format the statistics.
            sprintf_s(szTimeElapsed,255,
                "Ticks elapsed since start of notification: %u",
                GetTickCount() - dwNotificationStart);
            
            // Allocate space for the module name.
            char * pszBuffer = (char*) pHttpContext->AllocateRequestMemory(
                (DWORD) wcslen(pszModule)+1 );
            
            // Test for an error.
            if (pszBuffer!=NULL)
            {
                // Return the module information to the web client.
                wcstombs(pszBuffer,pszModule,wcslen(pszModule));
                // Create an array of strings.
                LPCSTR szBuffer[4] = {szNotification,pszBuffer,
                    szNotificationStart,szTimeElapsed};
                // Write the strings to the Event Viewer.
                WriteEventViewerLog(szBuffer,4);
            }
        }
    }

public:

    REQUEST_NOTIFICATION_STATUS
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        // Retrieve and return the execution statistics.
        RetrieveExecutionStats(pHttpContext,"OnBeginRequest");
        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }

    REQUEST_NOTIFICATION_STATUS
    OnMapRequestHandler(
        IN IHttpContext * pHttpContext,
        IN IMapHandlerProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        // Retrieve and return the execution statistics.
        RetrieveExecutionStats(pHttpContext,"OnMapRequestHandler");
        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }

    REQUEST_NOTIFICATION_STATUS
    OnSendResponse(
        IN IHttpContext * pHttpContext,
        IN ISendResponseProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        // Retrieve and return the execution statistics.
        RetrieveExecutionStats(pHttpContext,"OnSendResponse");
        // Return processing to the pipeline.
        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:

    // 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 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 we 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 );

    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_BEGIN_REQUEST | RQ_MAP_REQUEST_HANDLER | RQ_SEND_RESPONSE,
        0
    );
}

Ihr Modul muss die RegisterModule-Funktion 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 Schalters /EXPORT:RegisterModule kompilieren. Weitere Informationen finden Sie unter Exemplarische Vorgehensweise: Erstellen eines Request-Level HTTP-Moduls mithilfe von nativem Code.

Sie können den Code optional kompilieren, indem Sie die __stdcall (/Gz) Aufrufkonvention verwenden, anstatt die Aufrufkonvention 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 unter 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 unter 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

IHttpContext-Schnittstelle

Freigeben über