|
1 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of "Eclipse Public License v1.0" |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // |
|
15 |
|
16 #ifndef __VWSSESSN_H__ |
|
17 #define __VWSSESSN_H__ |
|
18 |
|
19 #include <e32base.h> |
|
20 |
|
21 #include "VWSDEF.H" |
|
22 #include "VWSAPPST.H" |
|
23 #include "VWSPRIV.H" |
|
24 #include "VWSADDOB.H" |
|
25 |
|
26 |
|
27 // |
|
28 // Forward declarations. |
|
29 // |
|
30 |
|
31 class CVwsServer; |
|
32 class CVwsEventQueue; |
|
33 class TVwsViewEvent; |
|
34 class CVwsClientMessage; |
|
35 class CVwsSessionEvent; |
|
36 |
|
37 |
|
38 /** |
|
39 * The MVwsServerSessionObserver class specifies an interface for getting callbacks on completion of the stages of |
|
40 * a client request. The interface is implemented by the concrete server event classes. |
|
41 */ |
|
42 class MVwsSessionObserver |
|
43 { |
|
44 public: |
|
45 enum TRequestType |
|
46 { |
|
47 EActivation, |
|
48 EDeactivation, |
|
49 EScreenDeviceChangeNotification |
|
50 }; |
|
51 public: |
|
52 virtual void RequestCompleted(TRequestType aType,TInt aError,const RMessage2& aMessage)=0; |
|
53 virtual void NowObserving(CVwsSessionEvent* aObserved)=0; |
|
54 virtual void NullifyObserved()=0; |
|
55 |
|
56 }; |
|
57 |
|
58 |
|
59 /** |
|
60 * The MVwsMessageHandler class specifies the interface through which a custom message request is passed onto a |
|
61 * session activation event. |
|
62 */ |
|
63 class MVwsMessageHandler |
|
64 { |
|
65 public: |
|
66 virtual void WriteClientMessageL(const RMessage2& aMessage)=0; |
|
67 virtual void CheckSourceOfViewSwitchL(const RMessage2& aMessage)=0; |
|
68 }; |
|
69 |
|
70 |
|
71 /** |
|
72 * The TVwsViewSwitchNotification class encapsulates that attributes of a view switch notification request. |
|
73 */ |
|
74 class TVwsViewSwitchNotification |
|
75 { |
|
76 public: |
|
77 TVwsViewSwitchNotification(); |
|
78 void SetRequest(const TVwsViewId& aViewId); |
|
79 void ClearRequest(); |
|
80 TBool IsViewToNotify(const TVwsViewId& aViewId) const; |
|
81 public: |
|
82 TVwsViewId iViewId; |
|
83 TBool iIsOutstanding; |
|
84 }; |
|
85 |
|
86 /** |
|
87 * The CVwsSession class implements a view server session. |
|
88 */ |
|
89 class CVwsSession : public CSession2 |
|
90 { |
|
91 public: |
|
92 enum TState |
|
93 { |
|
94 EWaitingForClientRequest, |
|
95 EClientRequestPending |
|
96 }; |
|
97 public: |
|
98 ~CVwsSession(); |
|
99 static CVwsSession* NewL(const TThreadId& aThreadId,CVwsServer& aServer); |
|
100 void CloseSession(); |
|
101 static void PanicClient(const RMessage2& aMessage,TInt aPanic); |
|
102 void PanicClient(TInt aPanic); |
|
103 void CompleteViewEvent(TInt aNotification); |
|
104 void CompleteViewEventL(TInt aNotification,const TVwsViewEvent& aEvent); |
|
105 TUid AppUid() const; |
|
106 CVwsSession::TState State() const; |
|
107 void RequestClientActivationL(MVwsSessionObserver& aObserver,const TVwsViewId& aViewId,const TVwsViewId& aPreviousViewId,CVwsClientMessage* aClientMessage,RThread aThreadOfClientInitiatingViewSwitch); |
|
108 void RequestClientDeactivationL(MVwsSessionObserver& aObserver,const TVwsViewId& aViewId,const TVwsViewId& aActiveViewId, TBool aDifferentInstanceOfSameApp); |
|
109 void RequestScreenDeviceChangeNotificationL(MVwsSessionObserver& aObserver,const TVwsViewId& aViewId); |
|
110 void SetMessageHandler(MVwsMessageHandler& aMessageHandler); |
|
111 void ClearMessageHandler(); |
|
112 TBool HasActiveView() const; |
|
113 TVwsViewId ActiveView() const; |
|
114 void SetActiveView(const TVwsViewId& aViewId); |
|
115 void ClearActiveView(); |
|
116 TInt CheckViewExists(const TVwsViewId& aViewId) const; |
|
117 TBool IsViewActive(const TVwsViewId& aViewId) const; |
|
118 void AddViewL(const TVwsViewId& aViewId); |
|
119 TInt RemoveView(const RMessage2& aMessage,const TVwsViewId& aViewId); |
|
120 TInt IndexById(const TVwsViewId& aViewId) const; |
|
121 TInt GetTopView(TVwsViewId& aViewId); |
|
122 inline TThreadId ClientThreadId() const; |
|
123 void HandleDeactivationL(const TVwsViewId& aDeactivatedViewId, const TVwsViewId& aActivatedViewId); |
|
124 void HandleActivationL(const TVwsViewId& aActivatedViewId, const TVwsViewId& ViewIdToBeDeactivated); |
|
125 inline TBool IsExiting() const; |
|
126 inline TBool IsLeaveAfterOwnershipTaken() const; |
|
127 inline void ResetLeaveAfterOwnershipTaken(); |
|
128 TBool Protected() const; |
|
129 |
|
130 public: |
|
131 CVwsClientMessage* iClientMessage; |
|
132 void SetClientMessageL( CVwsClientMessage* aClientMessage ); |
|
133 |
|
134 private: |
|
135 CVwsSession(const TThreadId& aThreadId,CVwsServer& aServer); |
|
136 void ConstructL(); |
|
137 private: // from CSession2 |
|
138 virtual void ServiceL(const RMessage2& aMessage); |
|
139 virtual void ServiceError(const RMessage2& aMessage,TInt aError); |
|
140 private: |
|
141 void AddViewL(const RMessage2& aMessage); |
|
142 void SetSystemDefaultViewL(const RMessage2& aMessage); |
|
143 void GetSystemDefaultViewL(const RMessage2& aMessage); |
|
144 void RemoveViewL(const RMessage2& aMessage); |
|
145 void RequestViewEventL(const RMessage2& aMessage); |
|
146 void CancelRequestViewEvent(); |
|
147 void CancelDeactivateActiveViewEvent(); |
|
148 void CancelActivateViewEvent(); |
|
149 void ActivateViewL(const RMessage2& aMessage,TVwsCompleteRequest aCompleteRequest); |
|
150 void RequestCustomMessageL(const RMessage2& aMessage); |
|
151 TVwsViewId ViewIdFromMessageL(const RMessage2& aMessage); |
|
152 void StartAppL(const RMessage2& aMessage); |
|
153 void DeactivateActiveViewL(const RMessage2& aMessage,TVwsCompleteRequest aCompleteRequest); |
|
154 void DeactivateActiveViewIfOwnerMatchL(const RMessage2& aMessage,TVwsCompleteRequest aCompleteRequest); |
|
155 void NotifyNextDeactivationL(const RMessage2& aMessage); |
|
156 void NotifyNextActivationL(const RMessage2& aMessage); |
|
157 void SetClientRequestTimeOut(const RMessage2& aMessage); |
|
158 void SetServerEventTimeOut(const RMessage2& aMessage); |
|
159 void EnableServerEventTimeOut(const RMessage2& aMessage); |
|
160 void CheckSourceOfViewSwitchL(const RMessage2& aMessage); |
|
161 void GetPriorityForActiveObjectL(const RMessage2& aMessage); |
|
162 void EnableServerBlankScreen(const RMessage2& aMessage); |
|
163 void SetProtectedL(const RMessage2& aMessage); |
|
164 void GetCurrentActiveViewIdL(const RMessage2& aMessage); |
|
165 private: |
|
166 RMessage2 iViewEventMessage; |
|
167 RMessage2 iPanicMessage; |
|
168 TVwsViewSwitchNotification iDeactivationNotification; |
|
169 TVwsViewSwitchNotification iActivationNotification; |
|
170 MVwsMessageHandler* iMessageHandler; |
|
171 CVwsServer& iServer; |
|
172 CVwsEventQueue* iEventQueue; |
|
173 TUid iAppUid; |
|
174 TState iState; |
|
175 CArrayFixFlat<TVwsViewId> iViewIdArray; |
|
176 TInt iActiveViewIndex; |
|
177 TInt iLastActiveViewIndex; |
|
178 TThreadId iClientThreadId; |
|
179 TBool iIsExiting; |
|
180 TInt iPanic; |
|
181 TBool iLeaveAfterOwnershipTaken; |
|
182 TBool iProtected; |
|
183 }; |
|
184 |
|
185 |
|
186 /** |
|
187 * The CVwsClientMessage class encapsulates the contents of the custom client mesages which can be sent when |
|
188 * activating a view. It is used server side to store the message contents associated with an activation event |
|
189 * which are recovered from the write to the server thread. |
|
190 */ |
|
191 class CVwsClientMessage : public CBase |
|
192 { |
|
193 public: |
|
194 static CVwsClientMessage* New(); |
|
195 static CVwsClientMessage* NewL(); |
|
196 static CVwsClientMessage* NewL(const TUid& aMessageId); |
|
197 static CVwsClientMessage* NewL(const TUid& aMessageId, TInt aMessageLength, const RMessage2& aMessage, TInt aParameter); |
|
198 ~CVwsClientMessage(); |
|
199 private: |
|
200 CVwsClientMessage(); |
|
201 CVwsClientMessage(const TUid& aMessageId); |
|
202 void ConstructL(TInt aMessageLength, const RMessage2& aMessage, TInt aParameter); |
|
203 public: |
|
204 TUid iMessageId; |
|
205 HBufC8* iMessage; |
|
206 }; |
|
207 |
|
208 |
|
209 // |
|
210 // Inlines |
|
211 // |
|
212 |
|
213 inline TThreadId CVwsSession::ClientThreadId() const |
|
214 {return iClientThreadId;} |
|
215 |
|
216 inline TBool CVwsSession::IsExiting() const |
|
217 {return iIsExiting;} |
|
218 |
|
219 inline TBool CVwsSession::IsLeaveAfterOwnershipTaken() const |
|
220 {return iLeaveAfterOwnershipTaken;} |
|
221 |
|
222 inline void CVwsSession::ResetLeaveAfterOwnershipTaken() |
|
223 {iLeaveAfterOwnershipTaken=EFalse;}; |
|
224 |
|
225 |
|
226 #endif |
|
227 |