CHttpModule::OnBeginRequest (Método)

Representa el método que controlará un BeginRequest evento, que se produce como el primer evento de la canalización de procesamiento de solicitudes integrada HTTP para la solicitud actual.

Sintaxis

virtual REQUEST_NOTIFICATION_STATUS OnBeginRequest(  
   IN IHttpContext* pHttpContext,  
   IN IHttpEventProvider* pProvider  
);  

Parámetros

pHttpContext
[IN] Puntero a una interfaz IHttpContext .

pProvider
[IN] Puntero a una interfaz IHttpEventProvider .

Valor devuelto

Valor de REQUEST_NOTIFICATION_STATUS .

Comentarios

Cuando se registra un módulo de nivel de solicitud para la notificación de eventos de RQ_BEGIN_REQUEST , IIS llamará al método del OnBeginRequest módulo cuando una solicitud entre en la canalización integrada de procesamiento de solicitudes.

Nota

Los módulos de nivel de solicitud pueden registrarse para la BeginRequest notificación de eventos registrando para RQ_BEGIN_REQUEST en la función RegisterModule del módulo.

IIS llama al método de un módulo antes de OnBeginRequest la autenticación y autorización; esto permite a los desarrolladores usar el OnBeginRequest método para procesar las solicitudes en las que la identidad del cliente no es un problema.

Nota

No todas las solicitudes escriben la canalización integrada de procesamiento de solicitudes. Una solicitud de un archivo de imagen que se pueda satisfacer desde la memoria caché no entrará en la canalización integrada de procesamiento de solicitudes; por lo tanto, no se llamará al OnBeginRequest método .

Ejemplo

En el ejemplo siguiente se muestra cómo crear un módulo HTTP de nivel de solicitud que se registra para las notificaciones de RQ_BEGIN_REQUEST eventos y posteriores. Cuando una solicitud entra en la canalización, IIS llamará a los métodos OnPostBeginRequest y del OnBeginRequest módulo de ejemplo. Cada método escribirá una entrada en el registro de la aplicación del Visor de eventos de Windows. Una vez completado el procesamiento, el módulo se cerrará.

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

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:

    // Process an RQ_BEGIN_REQUEST event.
    REQUEST_NOTIFICATION_STATUS
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pHttpContext );
        UNREFERENCED_PARAMETER( pProvider );
        WriteEventViewerLog("OnBeginRequest");
        return RQ_NOTIFICATION_CONTINUE;
    }

    // Process an RQ_BEGIN_REQUEST post-event.
    REQUEST_NOTIFICATION_STATUS
    OnPostBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pHttpContext );
        UNREFERENCED_PARAMETER( pProvider );
        WriteEventViewerLog("OnPostBeginRequest");
        return RQ_NOTIFICATION_CONTINUE;
    }

    MyHttpModule()
    {
        // Open a handle to the Event Viewer.
        m_hEventLog = RegisterEventSource( NULL,"IISADMIN" );
    }

    ~MyHttpModule()
    {
        // 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;

    // Define a method that writes to the Event Viewer.
    BOOL WriteEventViewerLog(LPCSTR szNotification)
    {
        // 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, 1, 0, &szNotification, NULL );
        }
        return FALSE;
    }
};

// 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;
    }
};

// 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(
        // Specify the class factory.
        new MyHttpModuleFactory,
        // Specify the event notifications.
        RQ_BEGIN_REQUEST,
        // Specify the post-event notifications.
        RQ_BEGIN_REQUEST
    );
}

El módulo debe exportar la RegisterModule función. Puede exportar esta función mediante la creación de un archivo de definición de módulo (.def) para el proyecto, o bien puede compilar el módulo mediante el /EXPORT:RegisterModule modificador . Para obtener más información, vea Tutorial: Creación de un módulo HTTP de Request-Level mediante código nativo.

Opcionalmente, puede compilar el código mediante la __stdcall (/Gz) convención de llamada en lugar de declarar explícitamente la convención de llamada para cada función.

Requisitos

Tipo	Descripción
Remoto	- IIS 7.0 en Windows Vista - IIS 7.5 en Windows 7 - IIS 8.0 en Windows 8 - IIS 10.0 en Windows 10
Servidor	- IIS 7.0 en Windows Server 2008 - IIS 7.5 en Windows Server 2008 R2 - IIS 8.0 en Windows Server 2012 - IIS 8.5 en Windows Server 2012 R2 - IIS 10.0 en Windows Server 2016
Producto	- 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
Encabezado	Httpserv.h

Consulte también

CHttpModule (clase)
CHttpModule::OnPostBeginRequest (Método)