IHttpContext::IndicateCompletion メソッド

非同期作業の完了を示し、IIS が呼び出し元スレッドで実行を再開するよう要求します。

構文

virtual VOID IndicateCompletion(  
   IN REQUEST_NOTIFICATION_STATUS notificationStatus  
) = 0;  

パラメーター

notificationStatus
[IN]非同期操作の通知状態。

戻り値

VOID.

注釈

HTTP モジュールでは、 メソッドを IndicateCompletion 使用して非同期操作が完了したことを示し、IIS が呼び出し元スレッドで処理を再開するように要求できます。 この動作は、実行をスレッド プールにキューに入れる PostCompletion メソッドの動作とは異なります。

パラメーターで notificationStatus 指定された状態が REQUEST_NOTIFICATION_PENDINGされていない場合、要求状態コンピューターは元の通知エントリ ポイントに再入力せずに続行されます。

例

次のコード例では、 メソッドを使用 IndicateCompletion して非同期操作が完了したことを示す HTTP モジュールを作成する方法を示します。

#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
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;

        // Create a string to return to a Web client.
        PCSTR pszBuffer = "Hello World!";
        
        // 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);
        
        // Create a data chunk. (Defined in the Http.h file.)
        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 completion expected flag to false.
        BOOL pfCompletionExpected = FALSE;

        // 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,TRUE,TRUE,&cbSent,&pfCompletionExpected);

        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status and exit.
            pProvider->SetErrorStatus(hr);
            return RQ_NOTIFICATION_FINISH_REQUEST;
        }

        if (TRUE == pfCompletionExpected)
        {
            // Notify IIS that an asynchronous completion is expected.
            return RQ_NOTIFICATION_PENDING;
        }

        // Flush the response to the client.
        hr = pHttpContext->GetResponse()->Flush(TRUE,FALSE,&cbSent,&pfCompletionExpected);
        
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status and exit.
            pProvider->SetErrorStatus(hr);
            return RQ_NOTIFICATION_FINISH_REQUEST;
        }

        if (TRUE == pfCompletionExpected)
        {
            // Notify IIS that an asynchronous completion is expected.
            return RQ_NOTIFICATION_PENDING;
        }

        // End additional processing.
        return RQ_NOTIFICATION_FINISH_REQUEST;
    }
    
    REQUEST_NOTIFICATION_STATUS OnAsyncCompletion(
        IN IHttpContext* pHttpContext,
        IN DWORD dwNotification,
        IN BOOL fPostNotification,
        IN OUT IHttpEventProvider* pProvider,
        IN IHttpCompletionInfo* pCompletionInfo
    )
    {
        // Indicate completion for the operation.
        pHttpContext->IndicateCompletion(RQ_NOTIFICATION_CONTINUE);
        // Return processing to the pipeline.
        return RQ_NOTIFICATION_PENDING;
    }
};

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

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_BEGIN_REQUEST,
        0
    );
}

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

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

要件

参照

IHttpContext インターフェイス
IHttpContext::P ostCompletion メソッド