CGlobalModule::OnGlobalThreadCleanup メソッド

IIS がスレッド プールにスレッドを GlobalThreadCleanup 返したときに発生するイベントを処理するメソッドを表します。

構文

virtual GLOBAL_NOTIFICATION_STATUS OnGlobalThreadCleanup(  
   IN IGlobalThreadCleanupProvider* pProvider  
);  

パラメーター

pProvider
[IN] IGlobalThreadCleanupProvider インターフェイスへのポインター。

戻り値

GLOBAL_NOTIFICATION_STATUS値。

解説

グローバル モジュールが GL_THREAD_CLEANUP 通知に登録されている場合、操作の完了後にスレッドがスレッド プールに返されるときに、IIS によってモジュールの OnGlobalThreadCleanup メソッドが呼び出されます。

例

次のコード例は、次のタスクを実行する HTTP モジュールを作成する方法を示しています。

1. モジュールは通知に登録します GL_THREAD_CLEANUP 。

2. モジュールは、 メソッドを含む CGlobalModule クラスを OnGlobalThreadCleanup 作成します。 このメソッドは、次のタスクを実行します。

   1. IGlobalThreadCleanupProvider::GetApplication メソッドを使用して、IHttpApplication インターフェイスを取得します。

   2. IHttpApplication::GetApplicationId メソッドを使用して、現在のコンテキストのアプリケーションのアプリケーション識別子を取得します。

   3. アプリケーション識別子情報をイベントとして、イベント ビューアーのアプリケーション ログに書き込みます。

3. モジュールは、 クラスを CGlobalModule メモリから削除してから終了します。

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>

// Create the module's global class.
class MyGlobalModule : public CGlobalModule
{
public:
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalThreadCleanup(
        IN IGlobalThreadCleanupProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        
        // Retrieve a pointer to the IHttpApplication class.
        IHttpApplication * pHttpApplication =
            pProvider->GetApplication();

        // Retrieve a pointer to the application configuration path.
        PCWSTR pwszApplicationId = pHttpApplication->GetApplicationId();

        // Test for an error.
        if (m_pHttpContext!=NULL)
        {
            // Allocate space for the user name.
            char * pszBuffer = (char*) m_pHttpContext->AllocateRequestMemory(
                (DWORD) wcslen(pwszApplicationId)+1 );
        
            // Test for an error.
            if (pszBuffer!=NULL)
            {
                // Return the user information to the Web client.
                wcstombs(pszBuffer,pwszApplicationId,wcslen(pwszApplicationId));
                // Create an array of strings.
                LPCSTR szBuffer[3] = {"OnGlobalThreadCleanup",
                    "Application ID:",pszBuffer};
                // Write the strings to the Event Viewer.
                WriteEventViewerLog(szBuffer,3);
            }
        }

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

    GLOBAL_NOTIFICATION_STATUS
    OnGlobalPreBeginRequest(
        IN IPreBeginRequestProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        // Retrieve a pointer to the context.
        m_pHttpContext = pProvider->GetHttpContext();
        // Return processing to the pipeline.
        return GL_NOTIFICATION_CONTINUE;
    }

    VOID Terminate()
    {
        // Remove the class from memory.
        delete this;
    }

    MyGlobalModule()
    {
        // Open a handle to the Event Viewer.
        m_hEventLog = RegisterEventSource( NULL,"IISADMIN" );
        // Initialize the context pointer to NULL.
        m_pHttpContext = NULL;
    }

    ~MyGlobalModule()
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != m_hEventLog)
        {
            // Close the handle to the Event Viewer.
            DeregisterEventSource( m_hEventLog );
            m_hEventLog = NULL;
        }
    }

private:

    // Create a handle for the event viewer.
    HANDLE m_hEventLog;
    // Create a pointer for the module context.
    IHttpContext * m_pHttpContext;

    // Define a method that writes to the Event Viewer.
    BOOL WriteEventViewerLog(LPCSTR * lpStrings, WORD wNumStrings)
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != m_hEventLog)
        {
            // Write any strings to the Event Viewer and return.
            return ReportEvent(
                m_hEventLog, EVENTLOG_INFORMATION_TYPE,
                0, 0, NULL, wNumStrings, 0, lpStrings, NULL );
        }
        return FALSE;
    }
};

// Create the module's exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( pGlobalInfo );

    // Create an instance of the global module class.
    MyGlobalModule * pGlobalModule = new MyGlobalModule;
    // Test for an error.
    if (NULL == pGlobalModule)
    {
        return HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
    }
    // Set the global notifications and exit.
    return pModuleInfo->SetGlobalNotifications(
        pGlobalModule, GL_THREAD_CLEANUP | GL_PRE_BEGIN_REQUEST );
}

モジュールは RegisterModule 関数をエクスポートする必要があります。 この関数をエクスポートするには、プロジェクトのモジュール定義 (.def) ファイルを作成するか、スイッチを使用してモジュールを /EXPORT:RegisterModule コンパイルします。 詳細については、「 チュートリアル: ネイティブ コードを使用したGlobal-Level HTTP モジュールの作成」を参照してください。

必要に応じて、各関数の呼び出し規約を __stdcall (/Gz) 明示的に宣言するのではなく、呼び出し規約を使用してコードをコンパイルできます。

要件

参照

CGlobalModule クラス