/*

* ==============================================================================

*  Name        : OOMHandler.h

*  Part of     : Webcore / Platform

*  Interface   :

*  Description :

*  Version     : %Version%

*

*    Copyright (c) 2006, Nokia Corporation

*    All rights reserved.

*

*   Redistribution and use in source and binary forms, with or without

*   modification, are permitted provided that the following conditions

*   are met:

*

*      * Redistributions of source code must retain the above copyright

*        notice, this list of conditions and the following disclaimer.

*      * Redistributions in binary form must reproduce the above copyright

*        notice, this list of conditions and the following disclaimer in

*        the documentation and/or other materials provided with the

*        distribution.

*      * Neither the name of the Nokia Corporation nor the names of its

*        contributors may be used to endorse or promote products derived

*        from this software without specific prior written permission.

*

*   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

*   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

*   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

*   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

*   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

*   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

*   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

*   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

*   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

*   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE

*   USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH

*   DAMAGE.

*

*

* ==============================================================================

*/

#ifndef __OOMHANDLER_H__

#define __OOMHANDLER_H__

#include <e32def.h>

#include <MemoryManager.h>

namespace WebCore {

/*

 * This handles collecting memory when OOM occurs, by clearing the cache.

 * The StopScheduler has two collection modes, low and middle priority.

 * When memory is at a certain threshold, all collectors low and above are called.

 * When memory is at a critical threshold, all collectors middle and above are called.

 * We want the cache to always clear whenever OOM happens so this collector's

 * priority is high.

 */

class OOMHandler : public MMemoryCollector

{

public:

    OOMHandler();

    virtual ~OOMHandler();

    // from collector

    TUint Collect(TUint aRequired);

    void Restore();

    TOOMPriority Priority()     { return EOOM_PriorityHigh; }

};

}

#endif // END OF FILE