IHttpEventProvider-Schnittstelle

Artikel
07/19/2023

Stellt eine generische Ereignisberichtsschnittstelle bereit.

Syntax

class IHttpEventProvider

Methoden

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

Name	BESCHREIBUNG
SetErrorStatus	Gibt einen zurückzugebenden Fehler an.

Abgeleitete Klassen

In der folgenden Tabelle sind die abgeleiteten Klassen aufgeführt, die von der IHttpEventProvider -Schnittstelle verfügbar gemacht werden.

Name	BESCHREIBUNG
IAuthenticationProvider	Stellt eine Schnittstelle für RQ_REQUEST_AUTHENTICATE Ereignisbenachrichtigungen bereit.
ICacheProvider	Stellt eine Schnittstelle für GL_CACHE_OPERATION Ereignisbenachrichtigungen bereit.
ICustomNotificationProvider	Stellt eine Schnittstelle für GL_CUSTOM_NOTIFCATION- und RQ_CUSTOM_NOTIFCATION-Ereignisbenachrichtigungen bereit.
IGlobalConfigurationChangeProvider	Stellt eine Schnittstelle für GL_CONFIGURATION_CHANGE Ereignisbenachrichtigungen bereit.
IGlobalFileChangeProvider	Stellt eine Schnittstelle für GL_FILE_CHANGE Ereignisbenachrichtigungen bereit.
IGlobalRSCAQueryProvider	Stellt eine Schnittstelle für GL_RSCA_QUERY Ereignisbenachrichtigungen bereit.
IGlobalStopListeningProvider	Stellt eine Schnittstelle für GL_STOP_LISTENING Ereignisbenachrichtigungen bereit.
IGlobalThreadCleanupProvider	Stellt eine Schnittstelle für GL_THREAD_CLEANUP Ereignisbenachrichtigungen bereit.
IGlobalTraceEventProvider	Stellt eine Schnittstelle für GL_TRACE_EVENT Ereignisbenachrichtigungen bereit.
IHttpApplicationProvider	Stellt eine Schnittstelle für GL_APPLICATION_START Ereignisbenachrichtigungen bereit.
IMapHandlerProvider	Stellt eine Schnittstelle für RQ_DETERMINE_HANDLER Ereignisbenachrichtigungen bereit.
IMapPathProvider	Stellt eine Schnittstelle für RQ_MAP_PATH Ereignisbenachrichtigungen bereit.
IPreBeginRequestProvider	Stellt eine Schnittstelle für GL_PRE_BEGIN_REQUEST Ereignisbenachrichtigungen bereit.
IReadEntityProvider	Stellt eine Schnittstelle für RQ_READ_ENTITY Ereignisbenachrichtigungen bereit.
ISendResponseProvider	Stellt eine Schnittstelle für RQ_SEND_RESPONSE Ereignisbenachrichtigungen bereit.

Bemerkungen

Die IHttpEventProvider -Schnittstelle stellt die generische Ereignisberichtsschnittstelle für die meisten Benachrichtigungsmethoden bereit und dient als übergeordnete Klasse für die Ereignisberichterstattungsschnittstellen, die mit den verbleibenden Benachrichtigungen verwendet werden.

Die IHttpEventProvider Schnittstelle macht nur die SetErrorStatus-Methode verfügbar, die den Fehler status für den aktuellen Kontext festlegt. Mehrere der abgeleiteten Klassen, die von IHttpEventProvider geerbt werden, machen zusätzliche Methoden verfügbar, die für ihre jeweiligen Ereignisse spezifisch sind.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie ein HTTP-Modul erstellt wird, das eine Beispielzeichenfolge an den Webclient sendet und den Rückgabewert aus diesem Vorgang erfasst. Das Modul verwendet die SetErrorStatus -Methode, um den Rückgabewert als Fehler status für die aktuelle Anforderung anzugeben und wird dann beendet.

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

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;

        // Clear the existing response.
        pHttpContext->GetResponse()->Clear();
        // Set the MIME type to plain text.
        pHttpContext->GetResponse()->SetHeader(
            HttpHeaderContentType,"text/plain",
            (USHORT)strlen("text/plain"),TRUE);

        // Return a simple message to the Web client.
        hr = WriteResponseMessage(pHttpContext,"Hello World!");

        // Set the error status for the module.
        pProvider->SetErrorStatus( hr );

        // End additional processing.
        return RQ_NOTIFICATION_FINISH_REQUEST;
    }

private:

    // Create a utility method that inserts a string value into the response.
    HRESULT WriteResponseMessage(
        IHttpContext * pHttpContext,
        PCSTR pszBuffer
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // 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 = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Return a success status.
        return S_OK;
    }
};

// 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 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 MyHttpModuleFactory,
        RQ_BEGIN_REQUEST,
        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

Freigeben über