IHttpContext::IndicateCompletion-Methode

Gibt den Abschluss der asynchronen Arbeit an und fordert an, dass IIS die Ausführung im aufrufenden Thread fortsetzen soll.

Syntax

virtual VOID IndicateCompletion(  
   IN REQUEST_NOTIFICATION_STATUS notificationStatus  
) = 0;  

Parameter

notificationStatus
[IN] Die Benachrichtigung status des asynchronen Vorgangs.

Rückgabewert

VOID.

Bemerkungen

Ein HTTP-Modul kann die IndicateCompletion -Methode verwenden, um anzugeben, dass ein asynchroner Vorgang abgeschlossen wurde, und anfordern, dass IIS die Verarbeitung im aufrufenden Thread fortsetzen soll. Dieses Verhalten unterscheidet sich vom Verhalten der PostCompletion-Methode , die die Ausführung in die Warteschlange des Threadpools stellt.

Wenn die durch den notificationStatus Parameter angegebene status nicht REQUEST_NOTIFICATION_PENDING ist, wird der Anforderungszustandscomputer fortgesetzt, ohne den ursprünglichen Benachrichtigungseinstiegspunkt erneut einzuweisen.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie Sie ein HTTP-Modul erstellen, das die IndicateCompletion -Methode verwendet, um anzugeben, dass ein asynchroner Vorgang abgeschlossen wurde.

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

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

IHttpContext-Schnittstelle
IHttpContext::P ostCompletion-Methode