IGlobalStopListeningProvider::D rainRequestsGracefully-Methode

Artikel
07/19/2023

Gibt an, ob IIS alle derzeit ausstehenden Anforderungen ordnungsgemäß schließt.

Syntax

virtual BOOL DrainRequestsGracefully(  
   VOID  
) const = 0;

Parameter

Diese Methode nimmt zwei Parameter entgegen.

Rückgabewert

true , wenn IIS aktuelle Anforderungen ordnungsgemäß schließt; falseandernfalls .

Bemerkungen

Die DrainRequestsGracefully -Methode ruft Informationen darüber ab, wie IIS ausstehende Anforderungen schließen wird, wenn ein Arbeitsprozess heruntergefahren wird. Wenn IIS beispielsweise neu gestartet wird, gibt die DrainRequestsGracefully -Methode zurück false , da alle ausstehenden Anforderungen beendet werden. Wenn jedoch ein Anwendungspool wiederverwendet wird, gibt die DrainRequestsGracefully Methode zurück true , da alle ausstehenden Anforderungen für den heruntergefahrenen Arbeitsprozess ordnungsgemäß geschlossen werden.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie ein HTTP-Modul erstellt wird, das die folgenden Aufgaben ausführt:

Registriert sich für die GL_STOP_LISTENING-Benachrichtigung .
Erstellt eine CGlobalModule-Klasse , die eine OnGlobalStopListening-Methode enthält. Diese Methode führt die folgenden Tasks aus:
1. Ruft die status ab, die IIS verwendet, um aktuelle Anforderungen mithilfe der DrainRequestsGracefully -Methode zu schließen.
2. Formatiert eine Zeichenfolge, die die status Informationen enthält.
3. Schreibt die Zeichenfolge als Ereignis in das Anwendungsprotokoll des Ereignisanzeige.
Entfernt die CGlobalModule -Klasse aus dem Arbeitsspeicher und wird dann beendet.

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

// Create the module's global class.
class MyGlobalModule : public CGlobalModule
{
public:

    // Process a GL_STOP_LISTENING notification.
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalStopListening(
        IN IGlobalStopListeningProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        // Create a string buffer.
        char szBuffer[256] = "";
        // Retrieve the Boolean value and format the string.
        sprintf_s(szBuffer,255,"Drain Requests Gracefully: %s",
            (TRUE==pProvider->DrainRequestsGracefully())?"Yes":"No");
        // Write the string to the event viewer.
        WriteEventViewerLog(szBuffer);
        // Continue processing.
        return GL_NOTIFICATION_CONTINUE;
    }

    VOID Terminate()
    {
        // Remove the class from memory.
        delete this;
    }

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

    ~MyGlobalModule()
    {
        // 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 exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( 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_STOP_LISTENING );
}

Ihr Modul muss die RegisterModule-Funktion exportieren. Sie können diese Funktion exportieren, indem Sie eine Moduldefinitionsdatei (.def) für Ihr Projekt erstellen, oder Sie können das Modul mithilfe des Schalters /EXPORT:RegisterModule kompilieren. Weitere Informationen finden Sie unter Exemplarische Vorgehensweise: Erstellen eines Request-Level HTTP-Moduls mithilfe von nativem Code.

Sie können den Code optional kompilieren, indem Sie die __stdcall (/Gz) Aufrufkonvention verwenden, anstatt die Aufrufkonvention für jede Funktion explizit zu deklarieren.

Anforderungen

type	BESCHREIBUNG
Client	– IIS 7.0 unter Windows Vista – IIS 7.5 unter Windows 7 – IIS 8.0 unter Windows 8 – IIS 10.0 unter Windows 10
Server	– IIS 7.0 unter Windows Server 2008 – IIS 7.5 unter Windows Server 2008 R2 – IIS 8.0 unter Windows Server 2012 – IIS 8.5 unter Windows Server 2012 R2 – IIS 10.0 unter Windows Server 2016
Produkt	– 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

Weitere Informationen

IGlobalStopListeningProvider-Schnittstelle

Freigeben über