epoc32/include/savenotf.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#if !defined(SAVENOTF_H)
williamr@2
    17
#define SAVENOTF_H
williamr@2
    18
williamr@2
    19
#include <e32std.h>
williamr@2
    20
#include <e32base.h>
williamr@2
    21
williamr@2
    22
/**
williamr@2
    23
This interface has to be implemented by all clients, which want to be notified about events
williamr@2
    24
like shutdown/low memory. When this happens the implementation of MSaveObserver::SaveL() will
williamr@2
    25
be called.
williamr@2
    26
@see CSaveNotifier
williamr@2
    27
@publishedPartner
williamr@2
    28
@released
williamr@2
    29
*/
williamr@2
    30
class MSaveObserver
williamr@2
    31
	{
williamr@2
    32
public:
williamr@2
    33
	enum TSaveType
williamr@2
    34
		{
williamr@2
    35
		ESaveNone,
williamr@2
    36
		ESaveData,
williamr@2
    37
		ESaveAll,
williamr@2
    38
		ESaveQuick,
williamr@2
    39
		EReleaseRAM,
williamr@2
    40
		EReleaseDisk,
williamr@2
    41
		};
williamr@2
    42
public:
williamr@2
    43
	virtual void SaveL(TSaveType aSaveType)=0;
williamr@2
    44
	};
williamr@2
    45
williamr@2
    46
/**
williamr@2
    47
This class describes a client side session object, handling requests
williamr@2
    48
to the shutdown server.
williamr@2
    49
@internalComponent
williamr@2
    50
*/
williamr@2
    51
class RSaveSession : public RSessionBase
williamr@2
    52
	{
williamr@2
    53
public:
williamr@2
    54
	TInt ConnectL();
williamr@2
    55
	void NotifySave(TRequestStatus& aStatus);
williamr@2
    56
	void NotifySaveCancel();
williamr@2
    57
    TInt SwitchOff(MSaveObserver::TSaveType aAction, TBool aPowerOff);
williamr@2
    58
    TInt ServerPowerState(TBool& aPowerOff);
williamr@2
    59
private:
williamr@2
    60
	TInt StartServerL();
williamr@2
    61
	};
williamr@2
    62
williamr@2
    63
/**
williamr@2
    64
This class describes an object, which can be used by the clients, which want to be notified
williamr@2
    65
about events like powerdown/low memory. The clients have to implement MSaveObserver interface.
williamr@2
    66
When a particular event happens, the client's implementation of MSaveObserver::SaveL() will
williamr@2
    67
be called.
williamr@2
    68
@see MSaveObserver
williamr@2
    69
@publishedPartner
williamr@2
    70
@released 
williamr@2
    71
*/
williamr@2
    72
class CSaveNotifier : public CActive
williamr@2
    73
	{
williamr@2
    74
    friend class CPowerdownClient;//test class
williamr@2
    75
    friend class CPowerdownClient2;//test class
williamr@2
    76
public:
williamr@2
    77
	IMPORT_C static CSaveNotifier* NewL(MSaveObserver& aObserver);
williamr@2
    78
	IMPORT_C ~CSaveNotifier();
williamr@2
    79
	IMPORT_C void DelayRequeue();
williamr@2
    80
	IMPORT_C void Queue();
williamr@2
    81
	IMPORT_C void HandleError(TInt /*aError*/);
williamr@2
    82
private:
williamr@2
    83
	IMPORT_C TInt SwitchOff(MSaveObserver::TSaveType aAction, TBool aPowerOff);
williamr@2
    84
	IMPORT_C TInt ServerPowerState(TBool& aPowerOff);
williamr@2
    85
	inline CSaveNotifier(MSaveObserver& aObserver);
williamr@2
    86
	void ConstructL();
williamr@2
    87
	void Start();
williamr@2
    88
private: // from CActive
williamr@2
    89
	void DoCancel();
williamr@2
    90
	void RunL();
williamr@2
    91
private:
williamr@2
    92
	RSaveSession iSaveSession;
williamr@2
    93
	MSaveObserver& iSaveObserver;
williamr@2
    94
	TUint iFlags;
williamr@2
    95
	};
williamr@2
    96
williamr@2
    97
#endif