IHttpRequest::GetRemoteAddress-Methode

Artikel
07/19/2023

Gibt die Remoteadresse der Clientschnittstelle für die aktuelle Anforderung zurück.

Syntax

virtual PSOCKADDR GetRemoteAddress(  
   VOID  
) const = 0;

Parameter

Diese Methode nimmt zwei Parameter entgegen.

Rückgabewert

Ein Zeiger auf eine SOCKADDR-Struktur.

Bemerkungen

Die GetRemoteAddress -Methode ruft die Remoteschnittstellenadresse des Clients ab, der die Anforderung ausgestellt hat, und gibt einen Zeiger auf eine SOCKADDR Struktur zurück.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie Sie mithilfe der GetRemoteAddress -Methode ein HTTP-Modul erstellen, das die Remoteadresse eines Clients abruft. Das Beispiel gibt diese Informationen dann 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
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Create a pointer to a SOCKADDR structure.
        PSOCKADDR pSockAddr;

        // Retrieve a pointer to the request.
        IHttpRequest * pHttpRequest = pHttpContext->GetRequest();

        // Test for an error.
        if (pHttpRequest != NULL)
        {
            // Retrieve the remote address.
            pSockAddr = pHttpRequest->GetRemoteAddress();
            // Test for errors.
            if (NULL != pSockAddr)
            {
                // 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 to hold the hex for the IP address.
                char szBuffer[] = "??.??.??.??";

                // Create a pointer to a SOCKADDR_IN structure.
                PSOCKADDR_IN pSockAddr_in = (PSOCKADDR_IN) pSockAddr;

                // Convert the IP address to a hex string.
                byteToHexChar(szBuffer+0,pSockAddr_in->sin_addr.S_un.S_un_b.s_b1);
                byteToHexChar(szBuffer+3,pSockAddr_in->sin_addr.S_un.S_un_b.s_b2);
                byteToHexChar(szBuffer+6,pSockAddr_in->sin_addr.S_un.S_un_b.s_b3);
                byteToHexChar(szBuffer+9,pSockAddr_in->sin_addr.S_un.S_un_b.s_b4);

                // Return the IP address to the Web client.
                WriteResponseMessage(pHttpContext,
                    "IP Address: ",szBuffer);

                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }
        }

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

private:

    // Utility method that converts a byte to hex characters.
    void byteToHexChar(PSTR pszBuffer, BYTE bValue)
    {
        pszBuffer[0]=48+(bValue>>4)+((bValue>>4)>9?7:0);
        pszBuffer[1]=48+(bValue&0xF)+((bValue&0xF)>9?7:0);
        return;
    }

    // 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_BEGIN_REQUEST,
        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

IHttpRequest-Schnittstelle
IHttpRequest::GetLocalAddress-Methode

Freigeben über