IHttpCoNtext::IndicateCompletion 方法
指出非同步工作完成,並要求 IIS 繼續在呼叫執行緒上執行。
語法
virtual VOID IndicateCompletion(
IN REQUEST_NOTIFICATION_STATUS notificationStatus
) = 0;
參數
notificationStatus
[IN]非同步作業的通知狀態。
傳回值
VOID
.
備註
HTTP 模組可以使用 IndicateCompletion
方法來指出非同步作業已完成,並要求 IIS 繼續在呼叫執行緒上進行處理。 此行為與 PostCompletion 方法的行為不同,此方法會將執行排入執行緒集區。
如果 參數所 notificationStatus
指定的狀態未 REQUEST_NOTIFICATION_PENDING,要求狀態電腦將會繼續,而不會重新進入原始通知進入點。
範例
下列程式碼範例示範如何建立使用 IndicateCompletion
方法表示非同步作業已完成的 HTTP 模組。
#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 an HRESULT to receive return values from methods.
HRESULT hr;
// Create a string to return to a Web client.
PCSTR pszBuffer = "Hello World!";
// 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 data chunk. (Defined in the Http.h file.)
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 completion expected flag to false.
BOOL pfCompletionExpected = FALSE;
// Set the chunk to the buffer.
dataChunk.FromMemory.pBuffer = (PVOID) pszBuffer;
// Set the chunk size to the buffer size.
dataChunk.FromMemory.BufferLength = (USHORT) strlen(pszBuffer);
// Insert the data chunk into the response.
hr = pHttpContext->GetResponse()->WriteEntityChunks(
&dataChunk,1,TRUE,TRUE,&cbSent,&pfCompletionExpected);
// Test for an error.
if (FAILED(hr))
{
// Return the error status and exit.
pProvider->SetErrorStatus(hr);
return RQ_NOTIFICATION_FINISH_REQUEST;
}
if (TRUE == pfCompletionExpected)
{
// Notify IIS that an asynchronous completion is expected.
return RQ_NOTIFICATION_PENDING;
}
// Flush the response to the client.
hr = pHttpContext->GetResponse()->Flush(TRUE,FALSE,&cbSent,&pfCompletionExpected);
// Test for an error.
if (FAILED(hr))
{
// Return the error status and exit.
pProvider->SetErrorStatus(hr);
return RQ_NOTIFICATION_FINISH_REQUEST;
}
if (TRUE == pfCompletionExpected)
{
// Notify IIS that an asynchronous completion is expected.
return RQ_NOTIFICATION_PENDING;
}
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
REQUEST_NOTIFICATION_STATUS OnAsyncCompletion(
IN IHttpContext* pHttpContext,
IN DWORD dwNotification,
IN BOOL fPostNotification,
IN OUT IHttpEventProvider* pProvider,
IN IHttpCompletionInfo* pCompletionInfo
)
{
// Indicate completion for the operation.
pHttpContext->IndicateCompletion(RQ_NOTIFICATION_CONTINUE);
// Return processing to the pipeline.
return RQ_NOTIFICATION_PENDING;
}
};
// 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 we 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
);
}
您的模組必須匯出 RegisterModule 函式。 您可以為專案建立模組定義 (.def) 檔案,或使用 參數編譯模組 /EXPORT:RegisterModule
來匯出此函式。 如需詳細資訊,請參閱 逐步解說:使用機器碼建立 Request-Level HTTP 模組。
您可以選擇性地使用呼叫慣例編譯器代碼, __stdcall (/Gz)
而不是明確宣告每個函式的呼叫慣例。
規格需求
類型 | 描述 |
---|---|
Client | - 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 |