Interfaccia IHttpEventProvider

Articolo
07/19/2023

Fornisce un'interfaccia generica per la creazione di report eventi.

Sintassi

class IHttpEventProvider

Metodi

Nella tabella seguente sono elencati i metodi esposti dalla IHttpEventProvider classe .

Nome	Descrizione
SetErrorStatus	Specifica un errore da restituire.

Classi derivate

Nella tabella seguente sono elencate le classi derivate esposte dall'interfaccia IHttpEventProvider .

Nome	Descrizione
IAuthenticationProvider	Fornisce un'interfaccia per le notifiche degli eventi di RQ_REQUEST_AUTHENTICATE .
ICacheProvider	Fornisce un'interfaccia per le notifiche degli eventi GL_CACHE_OPERATION .
ICustomNotificationProvider	Fornisce un'interfaccia per le notifiche degli eventi di GL_CUSTOM_NOTIFCATION e RQ_CUSTOM_NOTIFCATION .
IGlobalConfigurationChangeProvider	Fornisce un'interfaccia per le notifiche degli eventi GL_CONFIGURATION_CHANGE .
IGlobalFileChangeProvider	Fornisce un'interfaccia per le notifiche degli eventi GL_FILE_CHANGE .
IGlobalRSCAQueryProvider	Fornisce un'interfaccia per le notifiche degli eventi di GL_RSCA_QUERY .
IGlobalStopListeningProvider	Fornisce un'interfaccia per le notifiche degli eventi GL_STOP_LISTENING .
IGlobalThreadCleanupProvider	Fornisce un'interfaccia per le notifiche degli eventi GL_THREAD_CLEANUP .
IGlobalTraceEventProvider	Fornisce un'interfaccia per le notifiche degli eventi di GL_TRACE_EVENT .
IHttpApplicationProvider	Fornisce un'interfaccia per le notifiche degli eventi GL_APPLICATION_START .
IMapHandlerProvider	Fornisce un'interfaccia per le notifiche degli eventi di RQ_DETERMINE_HANDLER .
IMapPathProvider	Fornisce un'interfaccia per le notifiche degli eventi di RQ_MAP_PATH .
IPreBeginRequestProvider	Fornisce un'interfaccia per le notifiche degli eventi GL_PRE_BEGIN_REQUEST .
IReadEntityProvider	Fornisce un'interfaccia per le notifiche degli eventi RQ_READ_ENTITY .
ISendResponseProvider	Fornisce un'interfaccia per le notifiche degli eventi RQ_SEND_RESPONSE .

Commenti

L'interfaccia IHttpEventProvider fornisce l'interfaccia generica per la creazione di report eventi per la maggior parte dei metodi di notifica e funge da classe padre per le interfacce di creazione di report eventi usate con le notifiche rimanenti.

L'interfaccia IHttpEventProvider espone solo il metodo SetErrorStatus , che imposta lo stato di errore per il contesto corrente. Diverse classi derivate ereditate da IHttpEventProvider espongono metodi aggiuntivi specifici dei rispettivi eventi.

Esempio

Nell'esempio di codice seguente viene illustrato come creare un modulo HTTP che invia una stringa di esempio al client Web e acquisisce il valore restituito da questa operazione. Il modulo usa il metodo per specificare il SetErrorStatus valore restituito come stato di errore per la richiesta corrente e quindi termina.

#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
    );
}

Il modulo deve esportare la funzione RegisterModule . È possibile esportare questa funzione creando un file di definizione del modulo (con estensione def) per il progetto oppure è possibile compilare il modulo usando l'opzione /EXPORT:RegisterModule . Per altre informazioni, vedere Procedura dettagliata: Creazione di un modulo HTTP Request-Level tramite codice nativo.

Facoltativamente, è possibile compilare il codice usando la __stdcall (/Gz) convenzione chiamante anziché dichiarare esplicitamente la convenzione chiamante per ogni funzione.

Requisiti

Tipo	Descrizione
Client	- IIS 7.0 in Windows Vista - IIS 7.5 in Windows 7 - IIS 8.0 in Windows 8 - IIS 10.0 in Windows 10
Server	- IIS 7.0 in Windows Server 2008 - IIS 7.5 in Windows Server 2008 R2 - IIS 8.0 in Windows Server 2012 - IIS 8.5 in Windows Server 2012 R2 - IIS 10.0 in Windows Server 2016
Prodotto	- 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
Intestazione	Httpserv.h

Vedere anche

Condividi tramite