IHttpServer::D oCacheOperation 方法
执行特定的缓存操作。
语法
virtual HRESULT DoCacheOperation(
IN CACHE_OPERATION cacheOperation,
IN IHttpCacheKey* pCacheKey,
OUT IHttpCacheSpecificData** ppCacheSpecificData,
IN IHttpTraceContext* pHttpTraceContext = NULL
) = 0;
parameters
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 将在 参数中ppCacheSpecificData
返回接口IHttpCacheSpecificData
。 可以选择在 参数中指定接口 IHttpTraceContext
, pHttpTraceContext
以标识触发调用的请求。 (这仅用于跟踪目的。)
注意
实现者不应在 IHttpApplicationResolveModulesProvider::RegisterModule 方法内调用 DoCacheOperation,因为请求管道中为时过早。
示例
下面的代码示例演示如何使用 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
。 有关详细信息,请参阅 演练:使用本机代码创建Request-Level HTTP 模块。
可以选择使用调用约定编译代码, __stdcall (/Gz)
而不是为每个函数显式声明调用约定。
要求
类型 | 说明 |
---|---|
客户端 | - 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 |
Header | Httpserv.h |
另请参阅
IHttpServer 接口
CACHE_OPERATION 枚举
IHttpCacheKey 接口
IHttpCacheSpecificData 接口
IHttpTraceContext 接口