Antarmuka IHttpEventProvider

Menyediakan antarmuka pelaporan peristiwa generik.

Sintaks

class IHttpEventProvider  

Metode

Tabel berikut mencantumkan metode yang diekspos oleh IHttpEventProvider kelas .

Nama	Deskripsi
SetErrorStatus	Menentukan kesalahan yang akan dikembalikan.

Kelas Turunan

Tabel berikut mencantumkan kelas turunan yang diekspos oleh IHttpEventProvider antarmuka.

Nama	Deskripsi
IAuthenticationProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa RQ_REQUEST_AUTHENTICATE .
ICacheProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa GL_CACHE_OPERATION .
ICustomNotificationProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa GL_CUSTOM_NOTIFCATION dan RQ_CUSTOM_NOTIFCATION .
IGlobalConfigurationChangeProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa GL_CONFIGURATION_CHANGE .
IGlobalFileChangeProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa GL_FILE_CHANGE .
IGlobalRSCAQueryProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa GL_RSCA_QUERY .
IGlobalStopListeningProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa GL_STOP_LISTENING .
IGlobalThreadCleanupProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa GL_THREAD_CLEANUP .
IglobalTraceEventProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa GL_TRACE_EVENT .
IHttpApplicationProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa GL_APPLICATION_START .
IMapHandlerProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa RQ_DETERMINE_HANDLER .
IMapPathProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa RQ_MAP_PATH .
IPreBeginRequestProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa GL_PRE_BEGIN_REQUEST .
IReadEntityProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa RQ_READ_ENTITY .
ISendResponseProvider	Menyediakan antarmuka untuk pemberitahuan peristiwa RQ_SEND_RESPONSE .

Keterangan

Antarmuka IHttpEventProvider menyediakan antarmuka pelaporan peristiwa generik untuk sebagian besar metode pemberitahuan, dan berfungsi sebagai kelas induk untuk antarmuka pelaporan peristiwa yang digunakan dengan pemberitahuan yang tersisa.

Antarmuka IHttpEventProvider hanya mengekspos metode SetErrorStatus , yang mengatur status kesalahan untuk konteks saat ini. Beberapa kelas turunan yang diwarisi dari IHttpEventProvider mengekspos metode tambahan yang khusus untuk peristiwa masing-masing.

Contoh

Contoh kode berikut menunjukkan cara membuat modul HTTP yang mengirim string contoh ke klien Web dan mengambil nilai pengembalian dari operasi ini. Modul menggunakan SetErrorStatus metode untuk menentukan nilai pengembalian sebagai status kesalahan untuk permintaan saat ini lalu keluar.

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

Modul Anda harus mengekspor fungsi RegisterModule . Anda dapat mengekspor fungsi ini dengan membuat file definisi modul (.def) untuk proyek Anda, atau Anda dapat mengkompilasi modul dengan menggunakan sakelar /EXPORT:RegisterModule . Untuk informasi selengkapnya, lihat Panduan: Membuat Modul HTTP Request-Level Dengan Menggunakan Kode Asli.

Anda dapat secara opsional mengkompilasi kode dengan menggunakan __stdcall (/Gz) konvensi panggilan alih-alih secara eksplisit mendeklarasikan konvensi panggilan untuk setiap fungsi.

Persyaratan

Jenis	Deskripsi
Klien	- IIS 7.0 di Windows Vista - IIS 7.5 di Windows 7 - IIS 8.0 di Windows 8 - IIS 10.0 pada Windows 10
Server	- IIS 7.0 di Windows Server 2008 - IIS 7.5 di Windows Server 2008 R2 - IIS 8.0 di Windows Server 2012 - IIS 8.5 di Windows Server 2012 R2 - IIS 10.0 di Windows Server 2016
Produk	- 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

Lihat juga

Antarmuka Inti Server Web
Antarmuka IAuthenticationProvider
Antarmuka ICacheProvider
Antarmuka ICustomNotificationProvider
Antarmuka IGlobalConfigurationChangeProvider
Antarmuka IGlobalFileChangeProvider
Antarmuka IGlobalRSCAQueryProvider
Antarmuka IGlobalStopListeningProvider
Antarmuka IGlobalThreadCleanupProvider
Antarmuka IglobalTraceEventProvider
Antarmuka IHttpApplicationProvider
Antarmuka IMapHandlerProvider
Antarmuka IMapPathProvider
Antarmuka IPreBeginRequestProvider
Antarmuka IReadEntityProvider
Antarmuka ISendResponseProvider