uiacceltk/hitchcock/goommonitor/inc/goomaction.h
author hgs
Wed, 03 Nov 2010 19:29:22 +0200
changeset 64 9f8c0686fb49
permissions -rw-r--r--
201044
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
64
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Classes for executing GOOM actions (e.g. closing applications and running plugins).
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef GOOMACTION_H_
hgs
parents:
diff changeset
    20
#define GOOMACTION_H_
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <e32base.h>
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
class MGOomActionObserver;
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
/*
hgs
parents:
diff changeset
    27
 * The base class for all GOOM actions (i.e. close application or run GOOM plug-in).
hgs
parents:
diff changeset
    28
 * 
hgs
parents:
diff changeset
    29
 * A base class is used because both types of action have common aspects, specifically:
hgs
parents:
diff changeset
    30
 *  - They are prioritised according to application idle time
hgs
parents:
diff changeset
    31
 *  - They need to be prioritised against each other
hgs
parents:
diff changeset
    32
 *  - For each action it is possible to either continue immediately or to wait for completion
hgs
parents:
diff changeset
    33
 *  
hgs
parents:
diff changeset
    34
 * @lib goommonitor.lib
hgs
parents:
diff changeset
    35
 * @since S60 v5.0
hgs
parents:
diff changeset
    36
 */
hgs
parents:
diff changeset
    37
NONSHARABLE_CLASS(CGOomAction) : public CBase
hgs
parents:
diff changeset
    38
    {
hgs
parents:
diff changeset
    39
public:
hgs
parents:
diff changeset
    40
hgs
parents:
diff changeset
    41
    virtual ~CGOomAction();
hgs
parents:
diff changeset
    42
    
hgs
parents:
diff changeset
    43
    /**
hgs
parents:
diff changeset
    44
     * Activate the OOM action
hgs
parents:
diff changeset
    45
     *
hgs
parents:
diff changeset
    46
     * @since S60 5.0
hgs
parents:
diff changeset
    47
     * @param aBytesRequested ?description
hgs
parents:
diff changeset
    48
     */ 
hgs
parents:
diff changeset
    49
    virtual void FreeMemory(TInt aBytesRequested, TBool aUseSwRendering) = 0;
hgs
parents:
diff changeset
    50
    
hgs
parents:
diff changeset
    51
    /**
hgs
parents:
diff changeset
    52
     * @since S60 5.0
hgs
parents:
diff changeset
    53
     * @return ETrue if the action is currently freeing memory, else EFalse
hgs
parents:
diff changeset
    54
     */ 
hgs
parents:
diff changeset
    55
    virtual TBool IsRunning() = 0;
hgs
parents:
diff changeset
    56
    
hgs
parents:
diff changeset
    57
protected:
hgs
parents:
diff changeset
    58
    // 
hgs
parents:
diff changeset
    59
    /**
hgs
parents:
diff changeset
    60
     * To be called by the derived class after the memory has been freed (or if it fails)
hgs
parents:
diff changeset
    61
     * 
hgs
parents:
diff changeset
    62
     * @since S60 5.0
hgs
parents:
diff changeset
    63
     * @param aError KErrNone if memory has successfully been freed, otherwise any system wide error code
hgs
parents:
diff changeset
    64
     */ 
hgs
parents:
diff changeset
    65
    void MemoryFreed(TInt aError);
hgs
parents:
diff changeset
    66
    
hgs
parents:
diff changeset
    67
    CGOomAction(MGOomActionObserver& aStateChangeObserver);
hgs
parents:
diff changeset
    68
    
hgs
parents:
diff changeset
    69
private: //data
hgs
parents:
diff changeset
    70
    
hgs
parents:
diff changeset
    71
    enum TGOomActionState
hgs
parents:
diff changeset
    72
        {
hgs
parents:
diff changeset
    73
        EGOomIdle,
hgs
parents:
diff changeset
    74
        EGOomFreeingMemory
hgs
parents:
diff changeset
    75
        };  
hgs
parents:
diff changeset
    76
    TGOomActionState iState;
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
protected:    
hgs
parents:
diff changeset
    79
    MGOomActionObserver& iStateChangeObserver;
hgs
parents:
diff changeset
    80
    };
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
#endif /*GOOMACTION_H_*/