userlibandfileserver/domainmgr/inc/domaindefs.h
changeset 279 957c583b417b
parent 0 a41df078684a
equal deleted inserted replaced
275:2b433474f2ba 279:957c583b417b
     1 // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 2002-2010 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Eclipse Public License v1.0"
     4 // under the terms of the License "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    12 //
    12 //
    13 // Description:
    13 // Description:
       
    14 // Contains the common definitions for the Domain Manager interface for clients.
    14 //
    15 //
    15 // WARNING: This file contains some APIs which are internal and are subject
    16 // WARNING: This file contains some APIs which are internal and are subject
    16 //          to change without notice. Such APIs should therefore not be used
    17 //          to change without notice. Such APIs should therefore not be used
    17 //          outside the Kernel and Hardware Services package.
    18 //          outside the Kernel and Hardware Services package.
    18 //
    19 //
    20 #ifndef __DOMAIN_DEFS_H__
    21 #ifndef __DOMAIN_DEFS_H__
    21 #define __DOMAIN_DEFS_H__
    22 #define __DOMAIN_DEFS_H__
    22 
    23 
    23 #include <e32cmn.h>
    24 #include <e32cmn.h>
    24 #include <e32power.h>
    25 #include <e32power.h>
       
    26 
    25 
    27 
    26 /**
    28 /**
    27 @internalTechnology
    29 @internalTechnology
    28 */
    30 */
    29 // Property category UID value reserved for Domain Management services.
    31 // Property category UID value reserved for Domain Management services.
   157 
   159 
   158 
   160 
   159 /**
   161 /**
   160 @internalTechnology
   162 @internalTechnology
   161 
   163 
   162 The power domain hierarchy Id.
   164 The power domain hierarchy Id. This hierarchy is used in development 
       
   165 platforms.
   163 */
   166 */
   164 static const TDmHierarchyId	KDmHierarchyIdPower		= 1;
   167 static const TDmHierarchyId	KDmHierarchyIdPower		= 1;
   165 
   168 
   166 
   169 
   167 
   170 
   168 
   171 
   169 /**
   172 /**
   170 @internalAll
   173 @internalAll
   171 
   174 
   172 The start-up domain hierarchy Id.
   175 The system state start-up and shutdown domain hierarchy Id. This hierarchy is
       
   176 used in production devices.
   173 */
   177 */
   174 static const TDmHierarchyId	KDmHierarchyIdStartup	= 2;
   178 static const TDmHierarchyId	KDmHierarchyIdStartup	= 2;
   175 
   179 
   176 
   180 
   177 
   181 
   246 	TInt iError;
   250 	TInt iError;
   247 	};
   251 	};
   248 
   252 
   249 
   253 
   250 
   254 
       
   255 /**
       
   256 The possible ways in which the domain manager can behave when a transition 
       
   257 fails. 
       
   258 
       
   259 @see TDmHierarchyPolicy
       
   260 @see TDmStateSpecV1
       
   261 @see DmPolicyGetPolicy
       
   262 */
       
   263 enum TDmTransitionFailurePolicy
       
   264 	{
       
   265 	// Failure policies
       
   266 	
       
   267 	/**	The domain manager stops at the first transition failure */
       
   268 	ETransitionFailureStop,
       
   269 
       
   270 	/** The domain manager continues at any transition failure */
       
   271 	ETransitionFailureContinue,
       
   272 
       
   273 
       
   274 	// Special failure policies
       
   275 
       
   276 	/** Used in SDmStateSpecV1 when the default failure policy for the 
       
   277 	hierarchy should be used. The default failure policy is
       
   278 	returned by the DmPolicyGetPolicy() function, ordinal 3 in
       
   279 	the policy library. */
       
   280 	ETransitionFailureUsePolicyFromOrdinal3 = 256
       
   281 	};
       
   282 
       
   283 
   251 
   284 
   252 /**
   285 /**
   253 @publishedPartner
   286 @publishedPartner
   254 @released
   287 @released
   255 
   288 
   383 
   416 
   384 Domain manager specific error code - indicates that the domain hierarchy does not exist.
   417 Domain manager specific error code - indicates that the domain hierarchy does not exist.
   385 */
   418 */
   386 static const TInt KErrBadHierarchyId	= -263;
   419 static const TInt KErrBadHierarchyId	= -263;
   387 
   420 
       
   421 
       
   422 
       
   423 
   388 #endif
   424 #endif
   389 
   425