mmresourcemgmt/mmresctrl/inc/mmrcserverrulemanager.h
author hgs
Wed, 13 Oct 2010 12:08:48 +0100
changeset 3 28bdc4aca325
parent 0 79dd3e2336a0
permissions -rw-r--r--
2010wk42_01
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     1
// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     2
// All rights reserved.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     7
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     8
// Initial Contributors:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    10
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    11
// Contributors:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    12
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    13
// Description:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    14
// mmrcserverpolicaymanager.h
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    15
// 
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    16
//
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    17
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    18
#ifndef MMRCSERVERPOLICYMANAGER_H__
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    19
#define MMRCSERVERPOLICYMANAGER_H__
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    20
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    21
#include <e32std.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    22
#include <e32base.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    23
#include <a3f/a3fbase.h>
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    24
#include "mmrcclientserver.h"
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    25
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    26
class CMMRCServerSession;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    27
class CMMRCServerController;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    28
class MMMRCServerInfoState;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    29
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    30
/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    31
@internalComponent
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    32
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    33
This class implements the MMRC Server Rule Manager.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    34
The main purpose of this class is to
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    35
*/
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    36
NONSHARABLE_CLASS( CMMRCServerRuleManager ): public CBase
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    37
	{
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    38
public:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    39
	/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    40
	 * Constructs, and returns a pointer to, a new CMMRCServerRuleManager object.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    41
	 * Leaves on failure.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    42
	 * @param CMMRCServerController& A reference on the MMRC Server controller
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    43
	 * @return CMMRCServerRuleManager* A pointer to newly created utlitly object.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    44
	 */
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    45
	static CMMRCServerRuleManager* NewL(CMMRCServerController& aServerController);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    46
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    47
	/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    48
	 * Constructs, leaves object on the cleanup stack, and returns a pointer
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    49
	 * to, a new CMMRCServerRuleManager object.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    50
	 * Leaves on failure.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    51
	 * @param CMMRCServerController& A reference on the MMRC Server controller
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    52
	 * @return CMMRCServerRuleManager* A pointer to newly created utlitly object.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    53
	 */
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    54
	static CMMRCServerRuleManager* NewLC(CMMRCServerController& aServerController);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    55
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    56
	/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    57
	 * Destructor.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    58
	 */
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    59
	~CMMRCServerRuleManager();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    60
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    61
public:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    62
	/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    63
	 * Deduce the rule on the message according to the previous and current state
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    64
	 * Return KErrNotFound if no rule has been found.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    65
	 * Leaves on failure.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    66
	 * @param TAudioState aAudioStateAllocatedResource
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    67
	 * @param TAudioState aAudioStateRequiringProcess
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    68
	 * @return TMMRCRule rule
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    69
	 */
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    70
	TMMRCRule DecisionRule( TAudioState aAudioStateAllocatedResource, TAudioState aAudioStateRequiringProcess );
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    71
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    72
	/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    73
	 * Deduce the rule on the message according to the previous and current state
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    74
	 * Return KErrNotFound if no rule has been found.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    75
	 * @param TAudioState aAudioStateAllocatedResource
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    76
	 * @param TAudioState aAudioStateRequiringProcess
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    77
	 * @return TMMRCRule rule
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    78
	 */
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    79
	TReason ActionReason( TAudioState aAudioStateLastCommited, TAudioState aAudioStateRequested );
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    80
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    81
private:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    82
	/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    83
	 * By default Symbian 2nd phase constructor is private.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    84
	 * @param CMMRCServerController& A reference on the MMRC Server controller
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    85
	 */
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    86
	CMMRCServerRuleManager(CMMRCServerController& aServerController);
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    87
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    88
	/**
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    89
	 * By default Symbian 2nd phase constructor is private.
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    90
	 */
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    91
	void ConstructL();
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    92
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    93
private:
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    94
	CMMRCServerController& iMMRCServerController;
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    95
	};
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    96
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    97
#endif //__MMRCSERVERPOLICYMANAGER_H__
79dd3e2336a0 2010wk36_01
hgs
parents:
diff changeset
    98