userlibandfileserver/domainmgr/inc/domaincfg.h
author hgs
Mon, 04 Oct 2010 12:03:52 +0100
changeset 279 957c583b417b
permissions -rw-r--r--
201039_07
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
279
957c583b417b 201039_07
hgs
parents:
diff changeset
     1
// Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
957c583b417b 201039_07
hgs
parents:
diff changeset
     2
// All rights reserved.
957c583b417b 201039_07
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
957c583b417b 201039_07
hgs
parents:
diff changeset
     4
// under the terms of the License "Eclipse Public License v1.0"
957c583b417b 201039_07
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
957c583b417b 201039_07
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
957c583b417b 201039_07
hgs
parents:
diff changeset
     7
//
957c583b417b 201039_07
hgs
parents:
diff changeset
     8
// Initial Contributors:
957c583b417b 201039_07
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
957c583b417b 201039_07
hgs
parents:
diff changeset
    10
//
957c583b417b 201039_07
hgs
parents:
diff changeset
    11
// Contributors:
957c583b417b 201039_07
hgs
parents:
diff changeset
    12
//
957c583b417b 201039_07
hgs
parents:
diff changeset
    13
// Description:
957c583b417b 201039_07
hgs
parents:
diff changeset
    14
// Provides classes for holding domain policy data.
957c583b417b 201039_07
hgs
parents:
diff changeset
    15
//
957c583b417b 201039_07
hgs
parents:
diff changeset
    16
//
957c583b417b 201039_07
hgs
parents:
diff changeset
    17
957c583b417b 201039_07
hgs
parents:
diff changeset
    18
#ifndef __DOMAIN_CFG_H__
957c583b417b 201039_07
hgs
parents:
diff changeset
    19
#define __DOMAIN_CFG_H__
957c583b417b 201039_07
hgs
parents:
diff changeset
    20
957c583b417b 201039_07
hgs
parents:
diff changeset
    21
#include <e32base.h>
957c583b417b 201039_07
hgs
parents:
diff changeset
    22
957c583b417b 201039_07
hgs
parents:
diff changeset
    23
#include <domainpolicy.h>
957c583b417b 201039_07
hgs
parents:
diff changeset
    24
957c583b417b 201039_07
hgs
parents:
diff changeset
    25
957c583b417b 201039_07
hgs
parents:
diff changeset
    26
/**
957c583b417b 201039_07
hgs
parents:
diff changeset
    27
The server's representation of per-transition config settings
957c583b417b 201039_07
hgs
parents:
diff changeset
    28
957c583b417b 201039_07
hgs
parents:
diff changeset
    29
It is intended to act as a buffer between the server and any
957c583b417b 201039_07
hgs
parents:
diff changeset
    30
future SDmStateSpecV* structs.
957c583b417b 201039_07
hgs
parents:
diff changeset
    31
957c583b417b 201039_07
hgs
parents:
diff changeset
    32
*/
957c583b417b 201039_07
hgs
parents:
diff changeset
    33
struct TTransitionConfig : public SDmStateSpecV1
957c583b417b 201039_07
hgs
parents:
diff changeset
    34
	{
957c583b417b 201039_07
hgs
parents:
diff changeset
    35
	TTransitionConfig(const SDmStateSpecV1& aSpec);
957c583b417b 201039_07
hgs
parents:
diff changeset
    36
	// This version of the constructor is used as a key when looking up a
957c583b417b 201039_07
hgs
parents:
diff changeset
    37
	// specific actual config.
957c583b417b 201039_07
hgs
parents:
diff changeset
    38
	TTransitionConfig(TDmDomainState);
957c583b417b 201039_07
hgs
parents:
diff changeset
    39
	TInt CheckValues() const;
957c583b417b 201039_07
hgs
parents:
diff changeset
    40
	};
957c583b417b 201039_07
hgs
parents:
diff changeset
    41
957c583b417b 201039_07
hgs
parents:
diff changeset
    42
/**
957c583b417b 201039_07
hgs
parents:
diff changeset
    43
Repository for a hierachy's settings
957c583b417b 201039_07
hgs
parents:
diff changeset
    44
*/
957c583b417b 201039_07
hgs
parents:
diff changeset
    45
class CHierarchySettings : public CBase
957c583b417b 201039_07
hgs
parents:
diff changeset
    46
	{
957c583b417b 201039_07
hgs
parents:
diff changeset
    47
public:
957c583b417b 201039_07
hgs
parents:
diff changeset
    48
	CHierarchySettings();
957c583b417b 201039_07
hgs
parents:
diff changeset
    49
	~CHierarchySettings();
957c583b417b 201039_07
hgs
parents:
diff changeset
    50
957c583b417b 201039_07
hgs
parents:
diff changeset
    51
	void StoreConfigL(const TTransitionConfig& aConfig);
957c583b417b 201039_07
hgs
parents:
diff changeset
    52
957c583b417b 201039_07
hgs
parents:
diff changeset
    53
	// Called by CDmHierarchy
957c583b417b 201039_07
hgs
parents:
diff changeset
    54
	void SetCurrentTargetTransition(TDmDomainState);
957c583b417b 201039_07
hgs
parents:
diff changeset
    55
957c583b417b 201039_07
hgs
parents:
diff changeset
    56
	// Called by various objects to retrieve settings
957c583b417b 201039_07
hgs
parents:
diff changeset
    57
	TBool GetDomainTimeout(TTimeIntervalMicroSeconds32&) const;
957c583b417b 201039_07
hgs
parents:
diff changeset
    58
	TBool GetDeferralBudget(TInt&) const;
957c583b417b 201039_07
hgs
parents:
diff changeset
    59
	TBool GetFailurePolicy(TDmTransitionFailurePolicy&) const;
957c583b417b 201039_07
hgs
parents:
diff changeset
    60
957c583b417b 201039_07
hgs
parents:
diff changeset
    61
private:
957c583b417b 201039_07
hgs
parents:
diff changeset
    62
	const TTransitionConfig* LookupConfig(TDmDomainState) const;
957c583b417b 201039_07
hgs
parents:
diff changeset
    63
957c583b417b 201039_07
hgs
parents:
diff changeset
    64
	TDmDomainState iCurrentState;
957c583b417b 201039_07
hgs
parents:
diff changeset
    65
957c583b417b 201039_07
hgs
parents:
diff changeset
    66
	RArray<const TTransitionConfig> iConfigs;
957c583b417b 201039_07
hgs
parents:
diff changeset
    67
	};
957c583b417b 201039_07
hgs
parents:
diff changeset
    68
957c583b417b 201039_07
hgs
parents:
diff changeset
    69
/**
957c583b417b 201039_07
hgs
parents:
diff changeset
    70
This class wraps up the fetching of a data type for which
957c583b417b 201039_07
hgs
parents:
diff changeset
    71
an overridden value may be available from CHierarchySettings
957c583b417b 201039_07
hgs
parents:
diff changeset
    72
957c583b417b 201039_07
hgs
parents:
diff changeset
    73
Template parameters:
957c583b417b 201039_07
hgs
parents:
diff changeset
    74
T - Type of the value which may be over-ridden.
957c583b417b 201039_07
hgs
parents:
diff changeset
    75
F - Pointer to member function of CHierarchySettings.
957c583b417b 201039_07
hgs
parents:
diff changeset
    76
	This will be used to query and fetch an over-ride value.
957c583b417b 201039_07
hgs
parents:
diff changeset
    77
*/
957c583b417b 201039_07
hgs
parents:
diff changeset
    78
template< typename T, TBool (CHierarchySettings::*F)(T&) const>
957c583b417b 201039_07
hgs
parents:
diff changeset
    79
class TOverrideableSetting
957c583b417b 201039_07
hgs
parents:
diff changeset
    80
	{
957c583b417b 201039_07
hgs
parents:
diff changeset
    81
public:
957c583b417b 201039_07
hgs
parents:
diff changeset
    82
	/**
957c583b417b 201039_07
hgs
parents:
diff changeset
    83
	@param aDefault Default value
957c583b417b 201039_07
hgs
parents:
diff changeset
    84
	@param aSettings The object from which overrides are fetched
957c583b417b 201039_07
hgs
parents:
diff changeset
    85
	*/
957c583b417b 201039_07
hgs
parents:
diff changeset
    86
	TOverrideableSetting(T aDefault, const CHierarchySettings* aSettings = NULL)
957c583b417b 201039_07
hgs
parents:
diff changeset
    87
		: iSettings(aSettings), iDefault(aDefault)
957c583b417b 201039_07
hgs
parents:
diff changeset
    88
		{}
957c583b417b 201039_07
hgs
parents:
diff changeset
    89
957c583b417b 201039_07
hgs
parents:
diff changeset
    90
	void SetSettings(const CHierarchySettings* aSettings)
957c583b417b 201039_07
hgs
parents:
diff changeset
    91
		{
957c583b417b 201039_07
hgs
parents:
diff changeset
    92
		iSettings = aSettings;
957c583b417b 201039_07
hgs
parents:
diff changeset
    93
		}
957c583b417b 201039_07
hgs
parents:
diff changeset
    94
957c583b417b 201039_07
hgs
parents:
diff changeset
    95
	/**
957c583b417b 201039_07
hgs
parents:
diff changeset
    96
	Used to access the wrapped value. It will supply an
957c583b417b 201039_07
hgs
parents:
diff changeset
    97
	over-ridden value if available, otherwise, the internal
957c583b417b 201039_07
hgs
parents:
diff changeset
    98
	default vaule.
957c583b417b 201039_07
hgs
parents:
diff changeset
    99
	*/
957c583b417b 201039_07
hgs
parents:
diff changeset
   100
	T operator ()() const
957c583b417b 201039_07
hgs
parents:
diff changeset
   101
		{
957c583b417b 201039_07
hgs
parents:
diff changeset
   102
		T value;
957c583b417b 201039_07
hgs
parents:
diff changeset
   103
		const TBool overridden = (iSettings->*F)(value);
957c583b417b 201039_07
hgs
parents:
diff changeset
   104
957c583b417b 201039_07
hgs
parents:
diff changeset
   105
		if(!overridden)
957c583b417b 201039_07
hgs
parents:
diff changeset
   106
			{
957c583b417b 201039_07
hgs
parents:
diff changeset
   107
			value = iDefault;
957c583b417b 201039_07
hgs
parents:
diff changeset
   108
			}
957c583b417b 201039_07
hgs
parents:
diff changeset
   109
		return value;
957c583b417b 201039_07
hgs
parents:
diff changeset
   110
		}
957c583b417b 201039_07
hgs
parents:
diff changeset
   111
957c583b417b 201039_07
hgs
parents:
diff changeset
   112
private:
957c583b417b 201039_07
hgs
parents:
diff changeset
   113
	const CHierarchySettings* iSettings;
957c583b417b 201039_07
hgs
parents:
diff changeset
   114
	const T iDefault;
957c583b417b 201039_07
hgs
parents:
diff changeset
   115
	};
957c583b417b 201039_07
hgs
parents:
diff changeset
   116
#endif