IHttpRequest::GetRemoteAddress Method

Returns the remote address of the client's interface for the current request.

Syntax

virtual PSOCKADDR GetRemoteAddress(  
   VOID  
) const = 0;  

Parameters

This method takes no parameters.

Return Value

A pointer to a SOCKADDRstructure.

Remarks

The GetRemoteAddress method retrieves the remote interface address of the client that issued the request and returns a pointer to a SOCKADDR structure.

Example

The following code example demonstrates how to use the GetRemoteAddress method to create an HTTP module that retrieves the remote address of a client. The example then returns this information to a Web client.

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

Your module must export the RegisterModule function. You can export this function by creating a module definition (.def) file for your project, or you can compile the module by using the /EXPORT:RegisterModule switch. For more information, see Walkthrough: Creating a Request-Level HTTP Module By Using Native Code.

You can optionally compile the code by using the __stdcall (/Gz) calling convention instead of explicitly declaring the calling convention for each function.

Requirements

See Also

IHttpRequest Interface
IHttpRequest::GetLocalAddress Method