IHttpResponse::WriteEntityChunks, méthode

Article
07/19/2023

Ajoute une ou plusieurs structures HTTP_DATA_CHUNK au corps de la réponse.

Syntaxe

virtual HRESULT WriteEntityChunks(  
   IN HTTP_DATA_CHUNK* pDataChunks,  
   IN DWORD nChunks,  
   IN BOOL fAsync,  
   IN BOOL fMoreData,  
   OUT DWORD* pcbSent,  
   OUT BOOL* pfCompletionExpected = NULL  
) = 0;

Paramètres

pDataChunks
[IN] Pointeur vers une ou plusieurs HTTP_DATA_CHUNK structures.

nChunks
[IN] DWORD qui contient le nombre de blocs pointés par pDataChunks.

fAsync
[IN] true si la méthode doit se terminer de manière asynchrone ; sinon, false.

fMoreData
[IN] true si davantage de données doivent être envoyées dans la réponse ; false s’il s’agit des dernières données.

pcbSent
[OUT] Nombre d’octets qui ont été envoyés au client si l’appel se termine de manière synchrone.

pfCompletionExpected
[OUT] true si une complétion asynchrone est en attente pour cet appel ; sinon, false.

Valeur renvoyée

Élément HRESULT. Les valeurs possibles sont notamment celles figurant dans le tableau suivant.

Valeur	Description
S_OK	Indique que l’opération a réussi.
ERROR_INVALID_PARAMETER	Indique que le paramètre n’est pas valide (par exemple, le pointeur a la `pDataChunks` valeur NULL).
ERROR_NOT_ENOUGH_MEMORY	Indique que la mémoire est insuffisante pour effectuer l’opération.
ERROR_ARITHMETIC_OVERFLOW	Plus de 65535 blocs ont été ajoutés à la réponse.

Remarques

Les développeurs peuvent utiliser la WriteEntityChunks méthode pour insérer une structure unique HTTP_DATA_CHUNK ou un tableau de structures dans le corps de HTTP_DATA_CHUNK la réponse. Si l’opération s’est terminée de manière synchrone, le pcbSent paramètre reçoit le nombre d’octets qui ont été insérés dans la réponse.

Si la mise en mémoire tampon est activée, la WriteEntityChunks méthode crée une copie de toutes les HTTP_DATA_CHUNK structures, dupliquant ainsi les données sous-jacentes de sorte qu’elles n’ont pas besoin d’être conservées. Si la mise en mémoire tampon est désactivée ou si la limite de mémoire tampon de réponse est atteinte, la WriteEntityChunks méthode vide également la réponse. Si la mise en mémoire tampon est désactivée et que le fAsync paramètre est true, la mémoire doit être conservée jusqu’à la fin de la requête.

Vous pouvez configurer une WriteEntityChunks opération pour qu’elle se termine de manière asynchrone en définissant le fAsync paramètre sur true. Dans ce cas, la WriteEntityChunks méthode retourne immédiatement à l’appelant et le pcbSent paramètre ne reçoit pas le nombre d’octets qui ont été insérés dans la réponse. Si la mise en mémoire tampon est désactivée et que le fAsync paramètre est true, la mémoire du pDataChunks paramètre doit être conservée jusqu’à la fin de l’appel asynchrone.

Un maximum de 6 5535 blocs (64 Ko moins 1) peut être écrit dans une requête.

Exemple

L’exemple suivant montre comment utiliser la WriteEntityChunks méthode pour créer un module HTTP qui insère un tableau de deux blocs de données dans la réponse. L’exemple retourne ensuite la réponse à un client Web.

#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 an array of data chunks.
        HTTP_DATA_CHUNK dataChunk[2];

        // Buffer for bytes written of data chunk.
        DWORD cbSent;
        
        // Create string buffers.
        PCSTR pszOne = "First chunk data\n";
        PCSTR pszTwo = "Second chunk data\n";

        // 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);
            
            // Set the chunk to a chunk in memory.
            dataChunk[0].DataChunkType = HttpDataChunkFromMemory;
            // Set the chunk to the first buffer.
            dataChunk[0].FromMemory.pBuffer =
                (PVOID) pszOne;
            // Set the chunk size to the first buffer size.
            dataChunk[0].FromMemory.BufferLength =
                (USHORT) strlen(pszOne);

            // Set the chunk to a chunk in memory.
            dataChunk[1].DataChunkType = HttpDataChunkFromMemory;
            // Set the chunk to the second buffer.
            dataChunk[1].FromMemory.pBuffer =
                (PVOID) pszTwo;
            // Set the chunk size to the second buffer size.
            dataChunk[1].FromMemory.BufferLength =
                (USHORT) strlen(pszTwo);

            // Insert the data chunks into the response.
            hr = pHttpResponse->WriteEntityChunks(
                dataChunk,2,FALSE,TRUE,&cbSent);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( 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 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
    );
}

Votre module doit exporter la fonction RegisterModule . Vous pouvez exporter cette fonction en créant un fichier de définition de module (.def) pour votre projet, ou vous pouvez compiler le module à l’aide du /EXPORT:RegisterModule commutateur . Pour plus d’informations, consultez Procédure pas à pas : création d’un module HTTP Request-Level à l’aide de code natif.

Vous pouvez éventuellement compiler le code à l’aide de la __stdcall (/Gz) convention d’appel au lieu de déclarer explicitement la convention d’appel pour chaque fonction.

Spécifications

Type	Description
Client	- IIS 7.0 sur Windows Vista - IIS 7.5 sur Windows 7 - IIS 8.0 sur Windows 8 - IIS 10.0 sur Windows 10
Serveur	- IIS 7.0 sur Windows Server 2008 - IIS 7.5 sur Windows Server 2008 R2 - IIS 8.0 sur Windows Server 2012 - IIS 8.5 sur Windows Server 2012 R2 - IIS 10.0 sur Windows Server 2016
Produit	- 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
En-tête	Httpserv.h

Voir aussi

IHttpResponse, interface
IHttpResponse::WriteEntityChunkByReference, méthode

Partager via