ISendResponseProvider::SetFlags-Methode

Konfiguriert die Flags für die aktuelle HTTP-Antwort.

Syntax

virtual VOID SetFlags(  
   DWORD dwFlags  
) = 0;  

Parameter

dwFlags
Eine DWORD , die die festzulegenden Antwortflags enthält.

Rückgabewert

VOID.

Bemerkungen

Sie können die SetFlags -Methode verwenden, um anzugeben, welche Antwortflags mit der aktuellen Antwort verwendet werden sollen. Diese Flags bieten zusätzliche Kontrolle über das HTTP-Verhalten für IIS 7. Die folgenden Flags sind in der Http.h-Headerdatei definiert.

Name	Wert	BESCHREIBUNG
HTTP_SEND_RESPONSE_FLAG_DISCONNECT	0x00000001	Trennt die Netzwerkverbindung unmittelbar nach dem Senden der Antwort.
HTTP_SEND_RESPONSE_FLAG_MORE_DATA	0x00000002	Sendet zusätzliche Daten in der Antwort.
HTTP_SEND_RESPONSE_FLAG_BUFFER_DATA	0x00000004	Puffert die Antwort, bevor sie gesendet wird.
HTTP_SEND_RESPONSE_FLAG_ENABLE_NAGLING	0x00000008	Ermöglicht dem Nagle-Algorithmus die Optimierung von TCP-Antwortpaketen.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie sie mit den SetFlags Methoden und GetFlags ein HTTP-Modul erstellen, das die Flags für die aktuelle Antwort festlegt. Das Beispiel ruft dann die geänderten Flags ab und gibt die Antwort an einen Webclient zurück.

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

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnSendResponse(
        IN IHttpContext * pHttpContext,
        IN ISendResponseProvider * pProvider
    )
    {
        // Set the flags.
        pProvider->SetFlags( pProvider->GetFlags() | 
            HTTP_SEND_RESPONSE_FLAG_DISCONNECT |
            HTTP_SEND_RESPONSE_FLAG_BUFFER_DATA );

        // Retrieve the flags.
        DWORD dwFlags = pProvider->GetFlags();

        // 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 string buffer for the return message.
        char szBuffer[256];
        sprintf_s(szBuffer,255,"0x%x\n",dwFlags);

        // Test for the disconnect flag.
        if (dwFlags & HTTP_SEND_RESPONSE_FLAG_DISCONNECT)
            strcat_s(szBuffer,255,
            "\nHTTP_SEND_RESPONSE_FLAG_DISCONNECT");

        // Test for the more data flag.
        if (dwFlags & HTTP_SEND_RESPONSE_FLAG_MORE_DATA)
            strcat_s(szBuffer,255,
            "\nHTTP_SEND_RESPONSE_FLAG_MORE_DATA");

        // Test for the buffer data flag.
        if (dwFlags & HTTP_SEND_RESPONSE_FLAG_BUFFER_DATA)
            strcat_s(szBuffer,255,
            "\nHTTP_SEND_RESPONSE_FLAG_BUFFER_DATA");

        // Return the message to the Web client.
        WriteResponseMessage(pHttpContext,"\nFlags: ",szBuffer);

        // End additional processing.
        return RQ_NOTIFICATION_FINISH_REQUEST;
    }

private:

    // Create a utility method that inserts a name/value pair into the response.
    HRESULT WriteResponseMessage(
        IHttpContext * pHttpContext,
        PCSTR pszName,
        PCSTR pszValue
    )
    {
        // 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 first buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszName;
        // Set the chunk size to the first buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszName);
        // 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;
        }

        // Set the chunk to the second buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszValue;
        // Set the chunk size to the second buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszValue);
        // 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_SEND_RESPONSE,
        0
    );
}

Ihr Modul muss die Funktion RegisterModule 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 /EXPORT:RegisterModule Switches 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) aufrufende Konvention verwenden, anstatt die aufrufende Konvention 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 auf 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 auf 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

ISendResponseProvider-Schnittstelle
ISendResponseProvider::GetFlags-Methode