Método IHttpModuleRegistrationInfo::SetPriorityForRequestNotification
Define a prioridade no nível da solicitação para um módulo.
Sintaxe
virtual HRESULT SetPriorityForRequestNotification(
IN DWORD dwRequestNotification,
IN PCWSTR pszPriority
) = 0;
Parâmetros
dwRequestNotification
[IN] Um valor de máscara de bits que contém as notificações de solicitação a serem definidas para o nível de prioridade. (Definido em Httpserv.h.)
pszPriority
[IN] Um ponteiro para uma cadeia de caracteres que contém o alias de prioridade. (Definido em Httpserv.h.)
Valor Retornado
Um HRESULT
. Os possíveis valores incluem, mas sem limitação, aqueles na tabela a seguir.
Valor | Descrição |
---|---|
S_OK | Indica que a operação foi bem-sucedida. |
Comentários
O SetPriorityForRequestNotification
método define o nível de prioridade para uma lista de notificações no nível da solicitação para as quais um módulo HTTP foi registrado. O IIS usa o nível de prioridade para determinar a ordem dentro de uma notificação de que os módulos devem ser organizados. Os níveis de prioridade são invertidos para notificações CHttpModule::OnSendResponse . Por exemplo, um módulo HTTP registrado para a notificação CHttpModule::OnBeginRequest usando o alias PRIORITY_ALIAS_HIGH
seria priorizado antes de um módulo que se registrou para a OnBeginRequest
notificação usando o alias PRIORITY_ALIAS_LOW
. Um módulo HTTP registrado para a OnSendResponse
notificação usando o alias PRIORITY_ALIAS_HIGH
seria executado após um módulo registrado para a OnSendResponse
notificação usando o alias PRIORITY_ALIAS_LOW
.
Observação
Os valores de bitmask para notificações no nível da solicitação e aliases de prioridade são definidos no arquivo Httpserv.h.
Observação
Os níveis de prioridade são invertidos para RQ_SEND_RESPONSE
notificações.
Exemplo
O exemplo a seguir demonstra como criar um módulo HTTP que usa a função RegisterModule e os métodos a seguir para registrar um módulo para notificações de nível global e de solicitação.
O método SetRequestNotifications registra uma classe CHttpModule para uma notificação OnBeginRequest no nível da solicitação.
O
SetPriorityForRequestNotification
método define a prioridade do módulo para notificações no nível da solicitação.O método SetGlobalNotifications registra uma classe CGlobalModule para uma notificação OnGlobalPreBeginRequest de nível global.
O método SetPriorityForGlobalNotification define a prioridade do módulo para notificação de nível global.
O módulo responde às notificações registradas e grava entradas no log do aplicativo no Visualizador de Eventos.
Observação
As entradas no Visualizador de Eventos exibirão "IISADMIN" como a origem do evento.
#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>
// Create a global handle for the Event Viewer.
HANDLE g_hEventLog;
// Define the method that writes to the Event Viewer.
BOOL WriteEventViewerLog(LPCSTR szBuffer[], WORD wNumStrings);
// Create the HTTP module class.
class MyHttpModule : public CHttpModule
{
public:
REQUEST_NOTIFICATION_STATUS
OnBeginRequest(
IN IHttpContext * pHttpContext,
IN IHttpEventProvider * pProvider
)
{
UNREFERENCED_PARAMETER( pHttpContext );
UNREFERENCED_PARAMETER( pProvider );
// Create an array of strings.
LPCSTR szBuffer[2] = {"MyHttpModule","OnBeginRequest"};
// Write the strings to the Event Viewer.
WriteEventViewerLog(szBuffer,2);
// Return processing to the pipeline.
return RQ_NOTIFICATION_CONTINUE;
}
};
// Create the module's global class.
class MyGlobalModule : public CGlobalModule
{
public:
GLOBAL_NOTIFICATION_STATUS
OnGlobalPreBeginRequest(
IN IPreBeginRequestProvider * pProvider
)
{
UNREFERENCED_PARAMETER( pProvider );
// Create an array of strings.
LPCSTR szBuffer[2] = {"MyGlobalModule","OnGlobalPreBeginRequest"};
// Write the strings to the Event Viewer.
WriteEventViewerLog(szBuffer,2);
// 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.
g_hEventLog = RegisterEventSource( NULL,"IISADMIN" );
}
~MyGlobalModule()
{
// Test whether the handle for the Event Viewer is open.
if (NULL != g_hEventLog)
{
DeregisterEventSource( g_hEventLog );
g_hEventLog = NULL;
}
}
};
// 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;
}
};
// Define a method that writes to the Event Viewer.
BOOL WriteEventViewerLog(LPCSTR szBuffer[], WORD wNumStrings)
{
// Test whether the handle for the Event Viewer is open.
if (NULL != g_hEventLog)
{
// Write any strings to the Event Viewer and return.
return ReportEvent(
g_hEventLog,
EVENTLOG_INFORMATION_TYPE,
0, 0, NULL, wNumStrings,
0, szBuffer, 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 HRESULT to receive return values from methods.
HRESULT hr;
// Set the request notifications.
hr = pModuleInfo->SetRequestNotifications(
new MyHttpModuleFactory,
RQ_BEGIN_REQUEST, 0 );
// Test for an error and exit if necessary.
if (FAILED(hr))
{
return hr;
}
// Set the request priority.
hr = pModuleInfo->SetPriorityForRequestNotification(
RQ_BEGIN_REQUEST,PRIORITY_ALIAS_MEDIUM);
// Test for an error and exit if necessary.
if (FAILED(hr))
{
return hr;
}
// 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.
hr = pModuleInfo->SetGlobalNotifications(
pGlobalModule, GL_PRE_BEGIN_REQUEST );
// Test for an error and exit if necessary.
if (FAILED(hr))
{
return hr;
}
// Set the global priority.
hr = pModuleInfo->SetPriorityForGlobalNotification(
GL_PRE_BEGIN_REQUEST,PRIORITY_ALIAS_LOW);
// Test for an error and exit if necessary.
if (FAILED(hr))
{
return hr;
}
// Return a success status;
return S_OK;
}
Seu módulo deve exportar a RegisterModule
função. Você pode exportar essa função criando um arquivo de definição de módulo (.def) para seu projeto ou pode compilar o módulo usando a opção /EXPORT:RegisterModule
. Para obter mais informações, consulte Passo a passo: criando um módulo HTTP Request-Level usando código nativo.
Opcionalmente, você pode compilar o código usando a __stdcall (/Gz)
convenção de chamada em vez de declarar explicitamente a convenção de chamada para cada função.
Requisitos
Type | Descrição |
---|---|
Cliente | – IIS 7.0 no Windows Vista – IIS 7.5 no Windows 7 – IIS 8.0 no Windows 8 – IIS 10.0 no Windows 10 |
Servidor | – IIS 7.0 no Windows Server 2008 – IIS 7.5 no Windows Server 2008 R2 – IIS 8.0 no Windows Server 2012 – IIS 8.5 no Windows Server 2012 R2 – IIS 10.0 no Windows Server 2016 |
Produto | - 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 |
parâmetro | Httpserv.h |
Consulte Também
IHttpModuleRegistrationInfo Interface
Método IHttpModuleRegistrationInfo::SetGlobalNotifications
Método IHttpModuleRegistrationInfo::SetPriorityForGlobalNotification
Método IHttpModuleRegistrationInfo::SetRequestNotifications
Função PFN_REGISTERMODULE