CHttpModule クラス

要求レベルの HTTP モジュールの基底クラスを定義します。

構文

class CHttpModule  

メソッド

次の表に、 クラスによって公開されるメソッドの一覧を CHttpModule 示します。

派生クラス

このクラスには、派生クラスが含まれています。

解説

クラスは CHttpModule 、要求レベルの HTTP モジュールの基底クラスです。 派生クラスをCHttpModule作成するには、継承元のクラスと IHttpModuleFactory インターフェイスからCHttpModule派生するクラスを含む要求レベルの HTTP モジュールを作成する必要があります。 HTTP モジュールの作成の詳細については、「Native-Code HTTP モジュールの設計」を参照してください。

クラスは CHttpModule 、保護されたコンストラクターとデストラクター メソッドとパブリック Dispose メソッドを提供します。 要求の最後に、 Dispose メソッドが呼び出され、派生クラスのインスタンスが CHttpModule削除されます。

また、 クラスは CHttpModule 、統合された要求処理パイプライン内で要求レベルのイベントを処理するときに IIS 7 が呼び出す通知固有のメソッドも定義します。 HTTP モジュールは、モジュールのエクスポートされた RegisterModule 関数で通知の一覧を定義することで、特定のイベントに登録できます。

決定論的な要求イベント

要求レベルの通知方法の大部分は、統合パイプライン内の要求レベル のイベントの通常のフロー中に時系列的に処理されます。 各決定論的な要求レベルの通知メソッドには、一致するイベント後通知があります。これにより、HTTP モジュールは、イベントが発生したときに、またはイベントが発生した直後に処理できます。

次の表は、時系列の要求レベルのイベントおよびイベント後通知メソッドを、統合パイプライン内で発生した順序で示しています。

たとえば、 OnBeginRequest は の前にOnAuthenticateRequestOnMapRequestHandler発生し、 は の前にOnAcquireRequestState発生します。

非決定的な要求イベント

残りの要求レベルの通知メソッドは、特定の順序で処理されません。代わりに、IIS は特定の非決定的なイベントが発生したときにこれらのイベントを処理します。 次の表に、非決定的な要求レベルのイベントと、イベント後の関連する通知メソッドを示します。

¹ メソッドは OnAsyncCompletion 、HTTP モジュール内で非同期イベントが発生したときに呼び出されます。 そのため、モジュールのエクスポートされた RegisterModule 関数を使用して非同期通知に登録することはできません。 代わりに、非同期的に返されるメソッド (IHttpContext::ExecuteRequest メソッドや IHttpResponse::WriteEntityChunks メソッドなど) を呼び出した後に発生する通知を処理するメソッドがモジュールから提供OnAsyncCompletionされます。 IIS が を呼び出 OnAsyncCompletionすと、 メソッドは、通知の種類と、通知がイベントまたは事後イベントのどちらに対して行われたかを示すパラメーターを渡します。

² メソッドには OnCustomRequestNotification 、対応するイベント後通知メソッドがありません。 HTTP モジュールは、モジュールのエクスポートされた RegisterModule 関数を使用してカスタム通知に登録できますが、カスタム通知が発生した後に発生する通知にモジュールを登録することはできません。

例

次の例では、単純な "Hello World" HTTP モジュールを作成する方法を示します。 モジュールは、インターフェイスのIHttpModuleFactoryインスタンスを IHttpModuleRegistrationInfo::SetRequestNotifications メソッドに渡し、RQ_BEGIN_REQUEST通知に登録するエクスポートされたRegisterModule関数を定義します。 IIS では 、IHttpModuleFactory::GetHttpModule メソッドを使用してクラスのインスタンスを CHttpModule 作成し、成功状態を返します。 IIS では、 IHttpModuleFactory::Terminate メソッドを使用してメモリからファクトリを削除します。

通知が RQ_BEGIN_REQUEST 発生すると、IIS はモジュールの メソッドを呼び出して現在の OnBeginRequest 要求を処理します。 OnBeginRequest は応答バッファーをクリアし、応答の MIME の種類を変更します。 次に、 メソッドは、"Hello World" 文字列を含むデータ チャンクを作成し、その文字列を Web クライアントに返します。 最後に、モジュールは、すべての通知が完了し、終了したことを IIS に通知する状態インジケーターを返します。

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

// Create the module class.
class CHelloWorld : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Retrieve a pointer to the response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();

        // Test for an error.
        if (pHttpResponse != NULL)
        {
            // Clear the existing response.
            pHttpResponse->Clear();
            // Set the MIME type to plain text.
            pHttpResponse->SetHeader(
                HttpHeaderContentType,"text/plain",
                (USHORT)strlen("text/plain"),TRUE);

            // Create a string with the response.
            PCSTR pszBuffer = "Hello World!";
            // 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 = pHttpResponse->WriteEntityChunks(
                &dataChunk,1,FALSE,TRUE,&cbSent);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the HTTP status.
                pHttpResponse->SetStatus(500,"Server Error",0,hr);
            }

            // End additional processing.
            return RQ_NOTIFICATION_FINISH_REQUEST;
        }

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
};

// Create the module's class factory.
class CHelloWorldFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

        // Create a new instance.
        CHelloWorld * pModule = new CHelloWorld;

        // 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 CHelloWorldFactory,
        RQ_BEGIN_REQUEST,
        0
    );
}

モジュールで 関数をエクスポートする RegisterModule 必要があります。 この関数をエクスポートするには、プロジェクトのモジュール定義 (.def) ファイルを作成するか、スイッチを使用してモジュールを /EXPORT:RegisterModule コンパイルします。 詳細については、「 チュートリアル: ネイティブ コードを使用したRequest-Level HTTP モジュールの作成」を参照してください。

必要に応じて、各関数の呼び出し規約を __stdcall (/Gz) 明示的に宣言するのではなく、呼び出し規約を使用してコードをコンパイルできます。

要件

参照

Native-Code HTTP モジュールの作成
CGlobalModule クラス