Метод IHttpServer::D oCacheOperation

Статья
07/19/2023

Выполняет определенную операцию кэша.

Синтаксис

virtual HRESULT DoCacheOperation(  
   IN CACHE_OPERATION cacheOperation,  
   IN IHttpCacheKey* pCacheKey,  
   OUT IHttpCacheSpecificData** ppCacheSpecificData,  
   IN IHttpTraceContext* pHttpTraceContext = NULL  
) = 0;

Параметры

cacheOperation
[IN] Значение перечисления CACHE_OPERATION .

pCacheKey
[IN] Указатель на интерфейс IHttpCacheKey .

ppCacheSpecificData
[OUT] Указатель на адрес интерфейса IHttpCacheSpecificData .

pHttpTraceContext
[IN] Указатель на интерфейс IHttpTraceContext . (Необязательно.)

Возвращаемое значение

Объект HRESULT. Допустимые значения включают, но не ограничиваются, значения, приведенные в следующей таблице.

Значение	Описание:
S_OK	Указывает, что операция прошла успешно.

Метод DoCacheOperation используется в модулях HTTP для выполнения операции кэширования, указанной параметром cacheOperation . Например, значения перечисления CACHE_OPERATION_ADD и CACHE_OPERATION_DELETE хранят или удаляют объекты соответственно из кэша. Когда модуль вызывает DoCacheOperation метод , он должен передать IHttpCacheKey интерфейс в pCacheKey параметре , а IIS вернет IHttpCacheSpecificData интерфейс в параметре ppCacheSpecificData . При необходимости можно указать IHttpTraceContext интерфейс в параметре pHttpTraceContext , чтобы определить запрос, который активировал вызов. (Это необходимо только для трассировки.)

Примечание

Разработчики не должны вызывать Метод DoCacheOperation внутри метода IHttpApplicationResolveModulesProvider::RegisterModule , так как он находится слишком рано в конвейере запросов.

Пример

В следующем примере кода показано, как использовать DoCacheOperation метод для создания модуля HTTP, который проверяет CACHE_OPERATION_RETRIEVE операцию и запускает операцию CACHE_OPERATION_ENUM .

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

IHttpServer * g_pGlobalInfo;

// Create the module's global class.
class MyGlobalModule : public CGlobalModule
{
public:
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalCacheOperation(
        IN ICacheProvider * pProvider
    )
    {
        if (CACHE_OPERATION_RETRIEVE == pProvider->GetCacheOperation())
        {
            // Retrieve an IHttpCacheKey interface.
            IHttpCacheKey * pCacheKey = pProvider->GetCacheKey();
            // Test for an error.
            if (NULL == pCacheKey) return GL_NOTIFICATION_CONTINUE;
            
            // Initialize an IHttpCacheSpecificData interface pointer.
            IHttpCacheSpecificData * pCacheSpecificData = NULL;
            
            // Peform a cache enumeration operation.
            HRESULT hr = g_pGlobalInfo->DoCacheOperation(
                CACHE_OPERATION_ENUM,pCacheKey,&pCacheSpecificData,NULL);
            
            // Test for an error.
            if (FAILED(hr)) return GL_NOTIFICATION_HANDLED;
        }

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

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

    g_pGlobalInfo = 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_CACHE_OPERATION );
}

Модуль должен экспортировать функцию RegisterModule . Эту функцию можно экспортировать, создав файл определения модуля (DEF- файл) для проекта, или скомпилировать модуль с помощью /EXPORT:RegisterModule параметра . Дополнительные сведения см. в разделе Пошаговое руководство. Создание модуля HTTP Request-Level с помощью машинного кода.

При необходимости можно скомпилировать код с помощью __stdcall (/Gz) соглашения о вызовах вместо явного объявления соглашения о вызовах для каждой функции.

Требования

Тип	Описание
клиент	— IIS 7.0 в Windows Vista — IIS 7.5 в Windows 7 — IIS 8.0 в Windows 8 — IIS 10.0 в Windows 10
Сервер	— IIS 7.0 в Windows Server 2008 — IIS 7.5 в Windows Server 2008 R2 — IIS 8.0 в Windows Server 2012 — IIS 8.5 в Windows Server 2012 R2 — IIS 10.0 в Windows Server 2016
Продукт	— 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

См. также:

Интерфейс IHttpServer
Перечисление CACHE_OPERATION
Интерфейс IHttpCacheKey
Интерфейс IHttpCacheSpecificData
Интерфейс IHttpTraceContext

Поделиться через