Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 4.11 KB

iglobalstoplisteningprovider-drainrequestsgracefully-method.md

File metadata and controls

58 lines (40 loc) · 4.11 KB
Raw
title description ms.date ms.assetid
IGlobalStopListeningProvider::DrainRequestsGracefully Method
Learn how the IGlobalStopListeningProvider::DrainRequestsGracefully method indicates whether IIS will gracefully close any currently pending requests.
10/07/2016
047b08d2-bc6e-f885-038c-0bf55226a2a9

IGlobalStopListeningProvider::DrainRequestsGracefully Method

Indicates whether IIS will gracefully close any currently pending requests.

Syntax

virtual BOOL DrainRequestsGracefully(  
   VOID  
) const = 0;

Parameters

This method takes no parameters.

Return Value

true if IIS will close current requests gracefully; otherwise, false.

Remarks

The DrainRequestsGracefully method retrieves information about how IIS is going to close any pending requests when a worker process is shutting down. For example, if IIS is restarted, the DrainRequestsGracefully method will return false because all pending requests will be terminated. However, if an application pool is recycled, the DrainRequestsGracefully method will return true because all pending requests on the worker process that is shutting down will be closed gracefully.

Example

The following code example demonstrates how to create an HTTP module that performs the following tasks:

  1. Registers for the GL_STOP_LISTENING notification.

  2. Creates a CGlobalModule class that contains an OnGlobalStopListening method. This method performs the following tasks:

    1. Retrieves the status that IIS will use to close current requests by using the DrainRequestsGracefully method.

    2. Formats a string that contains the status information.

    3. Writes the string as an event to the application log of the Event Viewer.

  3. Removes the CGlobalModule class from memory and then exits.

[!code-cppIGlobalStopListeningProviderDrainRequestsGracefully#1]

Your module must export the RegisterModule function. You can export this function by creating a module definition (.def) file for your project, or you can compile the module by using the /EXPORT:RegisterModule switch. For more information, see Walkthrough: Creating a Request-Level HTTP Module By Using Native Code.

You can optionally compile the code by using the __stdcall (/Gz) calling convention instead of explicitly declaring the calling convention for each function.

Requirements

Type Description
Client - IIS 7.0 on [!INCLUDEwinvista]
- IIS 7.5 on Windows 7
- IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server - IIS 7.0 on [!INCLUDEwinsrv2008]
- IIS 7.5 on Windows Server 2008 R2
- IIS 8.0 on Windows Server 2012
- IIS 8.5 on Windows Server 2012 R2
- IIS 10.0 on Windows Server 2016
Product - IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0
- [!INCLUDEiisexp75], [!INCLUDEiisexp80], [!INCLUDEiisexp100]
Header Httpserv.h

See Also

IGlobalStopListeningProvider Interface