Freigeben über


IHttpConnection::IsConnected-Methode

Bestimmt, ob ein Webclient noch mit der aktuellen Anforderung verbunden ist.

Syntax

virtual BOOL IsConnected(  
   VOID  
) const = 0;  

Parameter

Diese Methode nimmt zwei Parameter entgegen.

Rückgabewert

true , wenn der Webclient noch verbunden ist; falseandernfalls .

Bemerkungen

Die IsConnected -Methode bestimmt, ob ein Webclient mit der aktuellen Anforderung verbunden oder von der aktuellen Anforderung getrennt wurde. Wenn die Verarbeitung einer Anforderung beispielsweise lange dauert, kann ein Webclient die Verbindung beenden. Wenn ein HTTP-Modul die IsConnected -Methode aufruft und feststellt, dass die Verbindung vom Client beendet wurde, kann das Modul die verbleibenden Benachrichtigungen umgehen und die verarbeitung zusätzlicher Anforderungen beenden, indem es RQ_NOTIFICATION_FINISH_REQUEST zurückgibt. Dadurch wird IIS von der weiteren Verarbeitung einer Anforderung für einen getrennten Webclient befreit.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie Sie mithilfe der IHttpContext::GetConnection-Methode ein HTTP-Modul erstellen, das einen Zeiger auf eine IHttpConnection-Schnittstelle abruft. Im Beispiel wird dann die IHttpConnection::IsConnected -Methode aufgerufen, um zu ermitteln, ob der Webclient, der die aktuelle Anforderung initiiert hat, noch verbunden ist. Wenn der Client weiterhin verbunden ist, gibt das HTTP-Modul eine status Nachricht an den Webclient zurück. Wenn der Client nicht verbunden ist, kehrt das Modul zurück RQ_NOTIFICATION_FINISH_REQUEST , um die zusätzliche Verarbeitung zu beenden.

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

        // Retrieve a connection pointer.
        IHttpConnection * pHttpConnection = pHttpContext->GetConnection();

        // Test for an error.
        if (NULL != pHttpConnection)
        {
            if (FALSE == pHttpConnection->IsConnected())
            {
                // When the Web client is no longer
                // connected, end additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }
            {
                // 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);

                // Return the status information.
                WriteResponseMessage(pHttpContext,"Client connected: ","Yes");
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }
        }

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

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

IHttpConnection-Schnittstelle