|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
|
3 <title>TB10.1 Example Applications: examples/AppFramework/ssmanager/policies/sysstates/gsastatepolicynormal.cpp Source File</title> |
|
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> |
|
5 <link href="tabs.css" rel="stylesheet" type="text/css"> |
|
6 </head><body> |
|
7 <!-- Generated by Doxygen 1.5.3 --> |
|
8 <h1>examples/AppFramework/ssmanager/policies/sysstates/gsastatepolicynormal.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// gsastatepolicynormal.cpp</span> |
|
9 <a name="l00002"></a>00002 <span class="comment">//</span> |
|
10 <a name="l00003"></a>00003 <span class="comment">// Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).</span> |
|
11 <a name="l00004"></a>00004 <span class="comment">// All rights reserved.</span> |
|
12 <a name="l00005"></a>00005 <span class="comment">// This component and the accompanying materials are made available</span> |
|
13 <a name="l00006"></a>00006 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span> |
|
14 <a name="l00007"></a>00007 <span class="comment">// which accompanies this distribution, and is available</span> |
|
15 <a name="l00008"></a>00008 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span> |
|
16 <a name="l00009"></a>00009 <span class="comment">//</span> |
|
17 <a name="l00010"></a>00010 <span class="comment">// Initial Contributors:</span> |
|
18 <a name="l00011"></a>00011 <span class="comment">// Nokia Corporation - initial contribution.</span> |
|
19 <a name="l00012"></a>00012 <span class="comment">//</span> |
|
20 <a name="l00013"></a>00013 <span class="comment">// Contributors:</span> |
|
21 <a name="l00014"></a>00014 <span class="comment">//</span> |
|
22 <a name="l00015"></a>00015 <span class="comment">// Extends the GSA (Generic Startup Architecture) normal policy to </span> |
|
23 <a name="l00016"></a>00016 <span class="comment">// to support the dummy backup and restore states added as part of this example. </span> |
|
24 <a name="l00017"></a>00017 <span class="comment">// The default Normal state policy supports only the states start up, shut down, and fail.</span> |
|
25 <a name="l00018"></a>00018 <span class="comment">// The example uses this extended normal state, which replaces the existing normal policy.</span> |
|
26 <a name="l00019"></a>00019 <span class="comment">// </span> |
|
27 <a name="l00020"></a>00020 <span class="comment">// This example Normal State policy creates and registers a SwP (ssm.swp.policy.dummy.diskstatus.dll)</span> |
|
28 <a name="l00021"></a>00021 <span class="comment">// with key KExampleSwPKey and KExampleSwPValue.</span> |
|
29 <a name="l00022"></a>00022 |
|
30 <a name="l00023"></a>00023 <span class="preprocessor">#include <barsread2.h></span> |
|
31 <a name="l00024"></a>00024 <span class="preprocessor">#include <e32debug.h></span> |
|
32 <a name="l00025"></a>00025 <span class="preprocessor">#include <ssm/ssmcmd.hrh></span> |
|
33 <a name="l00026"></a>00026 <span class="preprocessor">#include <ssm/ssmsubstates.hrh></span> |
|
34 <a name="l00027"></a>00027 |
|
35 <a name="l00028"></a>00028 <span class="preprocessor">#include <ssm/ssmstatetransition.h></span> |
|
36 <a name="l00029"></a>00029 <span class="preprocessor">#include <ssm/ssmcommandlistresourcereader.h></span> |
|
37 <a name="l00030"></a>00030 |
|
38 <a name="l00031"></a>00031 <span class="preprocessor">#include "gsastatepolicynormal.h"</span> |
|
39 <a name="l00032"></a>00032 |
|
40 <a name="l00036"></a>00036 _LIT(KPanicGsaNormalState, <span class="stringliteral">"NormalStatePolicy"</span>); |
|
41 <a name="l00037"></a>00037 |
|
42 <a name="l00043"></a>00043 EXPORT_C MSsmStatePolicy* CEgGsaStatePolicyNormal::NewL() |
|
43 <a name="l00044"></a>00044 { |
|
44 <a name="l00045"></a>00045 CEgGsaStatePolicyNormal* <span class="keyword">self</span> = <span class="keyword">new</span> (ELeave) CEgGsaStatePolicyNormal; |
|
45 <a name="l00046"></a>00046 CleanupStack::PushL(<span class="keyword">self</span>); |
|
46 <a name="l00047"></a>00047 <span class="keyword">self</span>->ConstructL(); |
|
47 <a name="l00048"></a>00048 CleanupStack::Pop(<span class="keyword">self</span>); |
|
48 <a name="l00049"></a>00049 <span class="keywordflow">return</span> <span class="keyword">self</span>; |
|
49 <a name="l00050"></a>00050 } |
|
50 <a name="l00051"></a>00051 |
|
51 <a name="l00055"></a>00055 CEgGsaStatePolicyNormal::CEgGsaStatePolicyNormal() |
|
52 <a name="l00056"></a>00056 { |
|
53 <a name="l00057"></a>00057 } |
|
54 <a name="l00058"></a>00058 |
|
55 <a name="l00062"></a>00062 CEgGsaStatePolicyNormal::~CEgGsaStatePolicyNormal() |
|
56 <a name="l00063"></a>00063 { |
|
57 <a name="l00064"></a>00064 <span class="keyword">delete</span> iCommandListResourceReader; |
|
58 <a name="l00065"></a>00065 iCurrentlySupportedTransitions.Close(); |
|
59 <a name="l00066"></a>00066 iFs.Close(); |
|
60 <a name="l00067"></a>00067 } |
|
61 <a name="l00068"></a>00068 |
|
62 <a name="l00074"></a>00074 <span class="keywordtype">void</span> CEgGsaStatePolicyNormal::ConstructL() |
|
63 <a name="l00075"></a>00075 { |
|
64 <a name="l00076"></a>00076 User::LeaveIfError(iFs.Connect()); |
|
65 <a name="l00077"></a>00077 |
|
66 <a name="l00078"></a>00078 <span class="comment">// Add supported transitions from Normal 'ESsmNormal'</span> |
|
67 <a name="l00079"></a>00079 iCurrentlySupportedTransitions.AppendL(TSsmState(ESsmShutdown, KSsmAnySubState)); |
|
68 <a name="l00080"></a>00080 iCurrentlySupportedTransitions.AppendL(TSsmState(ESsmFail, KSsmAnySubState)); |
|
69 <a name="l00081"></a>00081 iCurrentlySupportedTransitions.AppendL(TSsmState(ESsmShutdown, ESsmShutdownSubStateCritical)); |
|
70 <a name="l00082"></a>00082 iCurrentlySupportedTransitions.AppendL(TSsmState(ESsmBackup, ESsmBackupSubState)); |
|
71 <a name="l00083"></a>00083 iCurrentlySupportedTransitions.AppendL(TSsmState(ESsmRestore, ESsmRestoreSubState)); |
|
72 <a name="l00084"></a>00084 |
|
73 <a name="l00085"></a>00085 <span class="comment">/*</span> |
|
74 <a name="l00086"></a>00086 <span class="comment"> Normal state policy resource file path ("z:\private<SID of SSM>\normal\").</span> |
|
75 <a name="l00087"></a>00087 <span class="comment"> This resource file is already being generated by the production code, hence its not re-generated.</span> |
|
76 <a name="l00088"></a>00088 <span class="comment"> */</span> |
|
77 <a name="l00089"></a>00089 _LIT(KCommandListPath, <span class="stringliteral">"z:\\private\\2000D75B\\normal\\"</span>); |
|
78 <a name="l00090"></a>00090 |
|
79 <a name="l00091"></a>00091 <span class="comment">// Create a resource reader</span> |
|
80 <a name="l00092"></a>00092 iCommandListResourceReader = CSsmCommandListResourceReader::NewL(iFs, KCommandListPath(), *<span class="keyword">this</span>); |
|
81 <a name="l00093"></a>00093 } |
|
82 <a name="l00094"></a>00094 |
|
83 <a name="l00103"></a>00103 <span class="keywordtype">void</span> CEgGsaStatePolicyNormal::Initialize(TRequestStatus& aStatus) |
|
84 <a name="l00104"></a>00104 { |
|
85 <a name="l00105"></a>00105 __ASSERT_DEBUG(iCommandListResourceReader, User::Panic(KPanicGsaNormalState, EInvalidResourceReader)); |
|
86 <a name="l00106"></a>00106 |
|
87 <a name="l00107"></a>00107 <span class="comment">// initialise command list resource reader.</span> |
|
88 <a name="l00108"></a>00108 iCommandListResourceReader->Initialise(aStatus); |
|
89 <a name="l00109"></a>00109 } |
|
90 <a name="l00110"></a>00110 |
|
91 <a name="l00116"></a>00116 <span class="keywordtype">void</span> CEgGsaStatePolicyNormal::InitializeCancel() |
|
92 <a name="l00117"></a>00117 { |
|
93 <a name="l00118"></a>00118 __ASSERT_DEBUG(iCommandListResourceReader, User::Panic(KPanicGsaNormalState, EInvalidResourceReader)); |
|
94 <a name="l00119"></a>00119 iCommandListResourceReader->InitialiseCancel(); |
|
95 <a name="l00120"></a>00120 } |
|
96 <a name="l00121"></a>00121 |
|
97 <a name="l00127"></a>00127 <span class="keywordtype">void</span> CEgGsaStatePolicyNormal::Release() |
|
98 <a name="l00128"></a>00128 { |
|
99 <a name="l00129"></a>00129 <span class="keyword">delete</span> <span class="keyword">this</span>; |
|
100 <a name="l00130"></a>00130 } |
|
101 <a name="l00131"></a>00131 |
|
102 <a name="l00149"></a>00149 MSsmStatePolicy::TResponse CEgGsaStatePolicyNormal::TransitionAllowed(<span class="keyword">const</span> TSsmStateTransition& aRequest, TSsmStateTransition <span class="keyword">const</span>* aCurrent, |
|
103 <a name="l00150"></a>00150 TSsmStateTransition <span class="keyword">const</span>* aQueued, <span class="keyword">const</span> RMessagePtr2& aMessage) |
|
104 <a name="l00151"></a>00151 { |
|
105 <a name="l00152"></a>00152 TResponse response = ENotAllowed; |
|
106 <a name="l00153"></a>00153 <span class="keywordflow">if</span> (!aMessage.HasCapability(ECapabilityPowerMgmt)) |
|
107 <a name="l00154"></a>00154 { |
|
108 <a name="l00155"></a>00155 <span class="keywordflow">return</span> response; |
|
109 <a name="l00156"></a>00156 } |
|
110 <a name="l00157"></a>00157 |
|
111 <a name="l00158"></a>00158 <span class="comment">// Check if the requested transition is supported from the current state</span> |
|
112 <a name="l00159"></a>00159 <span class="keywordflow">if</span> (TransitionSupported(aRequest.State())) |
|
113 <a name="l00160"></a>00160 { |
|
114 <a name="l00161"></a>00161 <span class="keywordflow">if</span>((NULL == aCurrent) && (NULL == aQueued)) |
|
115 <a name="l00162"></a>00162 { |
|
116 <a name="l00163"></a>00163 <span class="comment">// SsmServer is idle</span> |
|
117 <a name="l00164"></a>00164 response = EDefinitelyAllowed; |
|
118 <a name="l00165"></a>00165 } |
|
119 <a name="l00166"></a>00166 <span class="keywordflow">else</span> <span class="keywordflow">if</span>(aRequest.State().MainState() == ESsmFail) |
|
120 <a name="l00167"></a>00167 { |
|
121 <a name="l00168"></a>00168 <span class="comment">// Going into failed state will override anything currently ongoing or queued</span> |
|
122 <a name="l00169"></a>00169 response = EReplaceCurrentClearQueue; |
|
123 <a name="l00170"></a>00170 } |
|
124 <a name="l00171"></a>00171 } |
|
125 <a name="l00172"></a>00172 TSsmStateName name = aRequest.State().Name(); |
|
126 <a name="l00173"></a>00173 <span class="keywordflow">return</span> response; |
|
127 <a name="l00174"></a>00174 } |
|
128 <a name="l00175"></a>00175 |
|
129 <a name="l00187"></a>00187 <span class="keywordtype">void</span> CEgGsaStatePolicyNormal::PrepareCommandList(TSsmState aState, TInt <span class="comment">/*aReason*/</span>, TRequestStatus& aStatus) |
|
130 <a name="l00188"></a>00188 { |
|
131 <a name="l00189"></a>00189 __ASSERT_DEBUG( iCommandListResourceReader , User::Panic(KPanicGsaNormalState, EInvalidResourceReader)); |
|
132 <a name="l00190"></a>00190 |
|
133 <a name="l00191"></a>00191 <span class="comment">// Start from the beginning if no specific substate is selected</span> |
|
134 <a name="l00192"></a>00192 <span class="keyword">const</span> TUint16 substate = aState.SubState(); |
|
135 <a name="l00193"></a>00193 <span class="keyword">const</span> TSsmState state(aState.MainState(), (substate==KSsmAnySubState) ? ESsmNormalSubState : substate); |
|
136 <a name="l00194"></a>00194 <span class="keyword">const</span> TInt commandListId = state.SubState(); |
|
137 <a name="l00195"></a>00195 |
|
138 <a name="l00196"></a>00196 <span class="comment">// Build the command list from the resource</span> |
|
139 <a name="l00197"></a>00197 iCommandListResourceReader->PrepareCommandList(commandListId, state, aStatus); |
|
140 <a name="l00198"></a>00198 } |
|
141 <a name="l00199"></a>00199 |
|
142 <a name="l00205"></a>00205 <span class="keywordtype">void</span> CEgGsaStatePolicyNormal::PrepareCommandListCancel() |
|
143 <a name="l00206"></a>00206 { |
|
144 <a name="l00207"></a>00207 iCommandListResourceReader->PrepareCommandListCancel(); |
|
145 <a name="l00208"></a>00208 } |
|
146 <a name="l00209"></a>00209 |
|
147 <a name="l00216"></a>00216 CSsmCommandList* CEgGsaStatePolicyNormal::CommandList() |
|
148 <a name="l00217"></a>00217 { |
|
149 <a name="l00218"></a>00218 __ASSERT_DEBUG( iCommandListResourceReader , User::Panic(KPanicGsaNormalState, EInvalidResourceReader)); |
|
150 <a name="l00219"></a>00219 |
|
151 <a name="l00220"></a>00220 <span class="keywordflow">return</span> iCommandListResourceReader->GetCommandList(); |
|
152 <a name="l00221"></a>00221 } |
|
153 <a name="l00222"></a>00222 |
|
154 <a name="l00235"></a>00235 TBool CEgGsaStatePolicyNormal::GetNextState(TSsmState aCurrentTransition, TInt <span class="comment">/*aReason*/</span>, TInt aError, TInt <span class="comment">/*aSeverity*/</span>, TSsmState& aNextState) |
|
155 <a name="l00236"></a>00236 { |
|
156 <a name="l00237"></a>00237 __ASSERT_ALWAYS(aCurrentTransition.MainState() == ESsmNormal, User::Panic(KPanicGsaNormalState, EInvalidNormalState)); |
|
157 <a name="l00238"></a>00238 <span class="keywordflow">if</span> (KErrNone != aError) |
|
158 <a name="l00239"></a>00239 { |
|
159 <a name="l00240"></a>00240 aNextState = TSsmState(ESsmFail, KSsmAnySubState); |
|
160 <a name="l00241"></a>00241 TSsmStateName name = aNextState.Name(); |
|
161 <a name="l00242"></a>00242 <span class="keywordflow">return</span> ETrue; |
|
162 <a name="l00243"></a>00243 } |
|
163 <a name="l00244"></a>00244 |
|
164 <a name="l00245"></a>00245 <span class="keywordflow">return</span> EFalse; <span class="comment">// no more substates to execute</span> |
|
165 <a name="l00246"></a>00246 } |
|
166 <a name="l00247"></a>00247 |
|
167 <a name="l00258"></a>00258 TBool CEgGsaStatePolicyNormal::ConditionalCommandAllowedL(CResourceFile& <span class="comment">/*aResourceFile*/</span>, TInt <span class="comment">/*aResourceId*/</span>) |
|
168 <a name="l00259"></a>00259 { |
|
169 <a name="l00260"></a>00260 <span class="comment">// no commands use 'conditional_information' in Normal state command list.</span> |
|
170 <a name="l00261"></a>00261 User::Panic(KPanicGsaNormalState, EConditionalInfoNotImplemented); |
|
171 <a name="l00262"></a>00262 <span class="keywordflow">return</span> EFalse; <span class="comment">// avoid a compiler warning.</span> |
|
172 <a name="l00263"></a>00263 } |
|
173 <a name="l00264"></a>00264 |
|
174 <a name="l00265"></a>00265 <span class="comment">/*</span> |
|
175 <a name="l00266"></a>00266 <span class="comment">Helper function to check whether requested transition is supported or not.</span> |
|
176 <a name="l00267"></a>00267 <span class="comment">@param aRequestedState Requested transition</span> |
|
177 <a name="l00268"></a>00268 <span class="comment">@return ETrue if transition is supported</span> |
|
178 <a name="l00269"></a>00269 <span class="comment"> EFalse if transition is not supported</span> |
|
179 <a name="l00270"></a>00270 <span class="comment">*/</span> |
|
180 <a name="l00271"></a>00271 TBool CEgGsaStatePolicyNormal::TransitionSupported(<span class="keyword">const</span> TSsmState& aRequestedState)<span class="keyword"> const</span> |
|
181 <a name="l00272"></a>00272 <span class="keyword"> </span>{ |
|
182 <a name="l00273"></a>00273 <span class="keywordflow">return</span> (iCurrentlySupportedTransitions.Find(aRequestedState) > KErrNotFound); |
|
183 <a name="l00274"></a>00274 } |
|
184 </pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:32:54 2010 for TB10.1 Example Applications by |
|
185 <a href="http://www.doxygen.org/index.html"> |
|
186 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
|
187 </body> |
|
188 </html> |