ISendResponseProvider::GetReadyToLogData 메서드

아티클
07/19/2023

IIS가 로그에 정보를 쓸 준비가 되었는지 여부를 나타내는 값을 검색합니다.

구문

virtual BOOL GetReadyToLogData(  
   VOID  
) const = 0;

매개 변수

이 메서드는 매개 변수를 사용하지 않습니다.

반환 값

true IIS가 정보를 기록할 준비가 되면 이고, 그렇지 않으면 입니다 false.

설명

IIS 로그 값을 검색하거나 수정하는 HTTP 모듈을 작성할 때 먼저 메서드를 GetReadyToLogData 호출하여 IIS가 정보를 기록할 준비가 되었는지 여부를 확인해야 합니다. 메서드가 GetReadyToLogData 를 반환 false하는 경우 모듈 은 ISendResponseProvider::GetLogData 메서드를 호출하지 않아야 합니다. 그렇지 않으면 NULL이 반환됩니다.

예제

다음 코드 예제에서는 사용 하는 GetReadyToLogData HTTP 모듈을 만드는 방법을 보여 줍니다.는 IIS 준비 로그 정보인지 여부를 확인 하는 메서드입니다. 모듈은 다음 단계를 완료합니다.

메서드를 GetLogData 사용하여 HTTP_LOG_FIELDS_DATA 구조를 검색합니다.
이 구조를 사용하여 로그 정보에서 서버 이름을 검색합니다.
로그 항목에서 서버 포트를 수정합니다.
ISendResponseProvider::SetLogData 메서드를 사용하여 수정된 로그 정보를 IIS에 제출합니다.
서버 이름을 웹 클라이언트에 반환한 다음 종료합니다.

#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
    )
    {
        
        // Retrieve log status.
        if (TRUE == pProvider->GetReadyToLogData())
        {
            // Retrieve log information.
            PHTTP_LOG_FIELDS_DATA pLogData =
                (PHTTP_LOG_FIELDS_DATA) pProvider->GetLogData();
            // Test for an error.
            if (NULL != pLogData)
            {
                // 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 server name.
                WriteResponseMessage(pHttpContext,
                    "Server name: ",pLogData->ServerName);
                // Modify the port number.
                pLogData->ServerPort = 8080;
                // Set the log data.
                HRESULT hr = pProvider->SetLogData(pLogData);
                // 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;
    }

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

    // Create an HRESULT to receive return values from methods.
    HRESULT hr;

    // Set the request priority.
    hr = pModuleInfo->SetPriorityForRequestNotification(
        RQ_SEND_RESPONSE,PRIORITY_ALIAS_HIGH);

    // Test for an error and exit if necessary.
    if (FAILED(hr))
    {
        return hr;
    }

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_SEND_RESPONSE,
        0
    );
}

모듈은 RegisterModule 함수를 내보내야 합니다. 프로젝트에 대한 모듈 정의(.def) 파일을 만들어 이 함수를 내보내거나 스위치를 사용하여 모듈을 /EXPORT:RegisterModule 컴파일할 수 있습니다. 자세한 내용은 연습: 네이티브 코드를 사용하여 Request-Level HTTP 모듈 만들기를 참조하세요.

필요에 따라 각 함수에 대한 호출 규칙을 명시적으로 선언하는 대신 호출 규칙을 사용하여 __stdcall (/Gz) 코드를 컴파일할 수 있습니다.

요구 사항

형식	Description
클라이언트	- Windows Vista의 IIS 7.0 - Windows 7의 IIS 7.5 - Windows 8의 IIS 8.0 - WINDOWS 10 IIS 10.0
서버	- Windows Server 2008의 IIS 7.0 - Windows Server 2008 R2의 IIS 7.5 - Windows Server 2012의 IIS 8.0 - Windows Server 2012 R2의 IIS 8.5 - WINDOWS SERVER 2016 IIS 10.0
제품	- 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
헤더	Httpserv.h

참고 항목

ISendResponseProvider 인터페이스
ISendResponseProvider::GetLogData 메서드

다음을 통해 공유

ISendResponseProvider::GetReadyToLogData 메서드

구문

매개 변수

반환 값

설명

예제

요구 사항

참고 항목

피드백

추가 리소스