IHttpServer::RecycleApplication Method

Recycles an application.

Syntax

virtual VOID RecycleApplication(  
   PCWSTR pszAppConfigPath  
) = 0;  

Parameters

pszAppConfigPath
A pointer to a string that contains the configuration path to recycle.

Return Value

VOID.

Remarks

The RecycleApplication method will request a recycle of the application that is specified by the configuration path in the pszAppConfigPath parameter. For example, the configuration path for the default Web site on a server running IIS 7 will usually resemble MACHINE/WEBROOT/APPHOST/Default Web Site.

Example

The following code example demonstrates how to create an HTTP module that uses the IHttpApplication::GetAppConfigPath and RecycleApplication methods to retrieve and recycle the managed application that is processing the current request.

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

// Create a pointer for the global server interface.
IHttpServer * g_pHttpServer = NULL;

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Test for an error.
        if (NULL != g_pHttpServer)
        {
            // Retrieve a pointer to the IHttpApplication class.
            IHttpApplication * pHttpApplication = pHttpContext->GetApplication();
            // Test for an error.
            if (NULL != pHttpApplication)
            {
                // Restart the application based on the configuration path.
                g_pHttpServer->RecycleApplication(pHttpApplication->GetAppConfigPath());
            }
        }

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
};

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

    // Store the pointer for the global server interface.
    g_pHttpServer = pGlobalInfo;

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_BEGIN_REQUEST,
        0
    );
}

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

See Also

IHttpApplication::GetAppConfigPath Method
IHttpServer Interface
IHttpServer::RecycleProcess Method