|
sl@0
|
1 |
// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
//
|
|
sl@0
|
15 |
|
|
sl@0
|
16 |
#ifndef MMRCSERVERINFO_H__
|
|
sl@0
|
17 |
#define MMRCSERVERINFO_H__
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
#include <e32base.h>
|
|
sl@0
|
20 |
#include <e32msgqueue.h>
|
|
sl@0
|
21 |
#include "mmrcutil.h"
|
|
sl@0
|
22 |
#include "mmrcclientserver.h"
|
|
sl@0
|
23 |
#include "mmrcserversession.h"
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
class CMMRCServerController;
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
/**
|
|
sl@0
|
28 |
@internalComponent
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
This class implements the MMRC Server Info.
|
|
sl@0
|
31 |
The main purpose of this class is to contain the different information
|
|
sl@0
|
32 |
about the MMRC Server.
|
|
sl@0
|
33 |
The server state
|
|
sl@0
|
34 |
The queue of resource Context
|
|
sl@0
|
35 |
The queue of resource in process
|
|
sl@0
|
36 |
*/
|
|
sl@0
|
37 |
NONSHARABLE_CLASS( CMMRCServerInfo ): public CBase
|
|
sl@0
|
38 |
{
|
|
sl@0
|
39 |
typedef RMMRCFifoQueue<CMMRCServerSession> RMMRCContextsQueueTD;
|
|
sl@0
|
40 |
typedef RMMRCFifoOrderQueue<CMMRCServerSession> RMMRCContextsQueueOrderTD;
|
|
sl@0
|
41 |
|
|
sl@0
|
42 |
public:
|
|
sl@0
|
43 |
/**
|
|
sl@0
|
44 |
* Constructs, and returns a pointer to, a new CMMRCServerInfo object.
|
|
sl@0
|
45 |
* Leaves on failure.
|
|
sl@0
|
46 |
* @param CMMRCServerController& A reference on the MMRC Server controller
|
|
sl@0
|
47 |
* @return CMMRCServerInfo* A pointer to newly created utlitly object.
|
|
sl@0
|
48 |
*/
|
|
sl@0
|
49 |
static CMMRCServerInfo* NewL(CMMRCServerController& aServerController);
|
|
sl@0
|
50 |
|
|
sl@0
|
51 |
/**
|
|
sl@0
|
52 |
* Constructs, leaves object on the cleanup stack, and returns a pointer
|
|
sl@0
|
53 |
* to, a new CMMRCServerInfo object.
|
|
sl@0
|
54 |
* Leaves on failure.
|
|
sl@0
|
55 |
* @param CMMRCServerController& A reference on the MMRC Server controller
|
|
sl@0
|
56 |
* @return CMMRCServerInfo* A pointer to newly created utlitly object.
|
|
sl@0
|
57 |
*/
|
|
sl@0
|
58 |
static CMMRCServerInfo* NewLC(CMMRCServerController& aServerController);
|
|
sl@0
|
59 |
|
|
sl@0
|
60 |
/**
|
|
sl@0
|
61 |
* Destructor.
|
|
sl@0
|
62 |
*/
|
|
sl@0
|
63 |
~CMMRCServerInfo();
|
|
sl@0
|
64 |
|
|
sl@0
|
65 |
public:
|
|
sl@0
|
66 |
|
|
sl@0
|
67 |
TInt AllocatedPausedContextsCount();
|
|
sl@0
|
68 |
TInt RequestsCount();
|
|
sl@0
|
69 |
TInt AllocatedResourceContextsCount();
|
|
sl@0
|
70 |
TInt AllocatedAPRContextsCount();
|
|
sl@0
|
71 |
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
/**
|
|
sl@0
|
74 |
* Change the state of the server
|
|
sl@0
|
75 |
* @param TMMRCServerState aNewState
|
|
sl@0
|
76 |
* @param TUint64 aContextId
|
|
sl@0
|
77 |
*/
|
|
sl@0
|
78 |
void SwitchServerState(TMMRCServerState aNewState, TUint64 aContextId);
|
|
sl@0
|
79 |
|
|
sl@0
|
80 |
|
|
sl@0
|
81 |
/**
|
|
sl@0
|
82 |
* get the state of the server
|
|
sl@0
|
83 |
* @param TMMRCServerState the state of the server
|
|
sl@0
|
84 |
* @param TUint64 aContextId
|
|
sl@0
|
85 |
*/
|
|
sl@0
|
86 |
void ServerState(TMMRCServerState& aServerState, TUint64& aContextId) const;
|
|
sl@0
|
87 |
|
|
sl@0
|
88 |
/**
|
|
sl@0
|
89 |
* Push a Context on the Context queue
|
|
sl@0
|
90 |
* @param CMMRCServerSession& aServerSession
|
|
sl@0
|
91 |
* @leave in case of memory error
|
|
sl@0
|
92 |
*/
|
|
sl@0
|
93 |
void PushRequestL(const CMMRCServerSession& aServerSession);
|
|
sl@0
|
94 |
|
|
sl@0
|
95 |
/**
|
|
sl@0
|
96 |
* Pop and remove the first Context from the Context queue
|
|
sl@0
|
97 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
98 |
*/
|
|
sl@0
|
99 |
CMMRCServerSession* PopAndRemoveFirstRequest();
|
|
sl@0
|
100 |
|
|
sl@0
|
101 |
/**
|
|
sl@0
|
102 |
* Pop and remove the first Context from the Context queue by contextId
|
|
sl@0
|
103 |
* @param const TAudioContextId& aContextId
|
|
sl@0
|
104 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
105 |
*/
|
|
sl@0
|
106 |
CMMRCServerSession* PopAndRemoveFirstRequestByContextId( const TAudioContextId& aContextId );
|
|
sl@0
|
107 |
|
|
sl@0
|
108 |
/**
|
|
sl@0
|
109 |
* Pop and remove the first Context of the highest priority from the Context queue
|
|
sl@0
|
110 |
* @param TInt aPriority
|
|
sl@0
|
111 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
112 |
*/
|
|
sl@0
|
113 |
CMMRCServerSession* PopAndRemoveRequestFirstHighestPriority( );
|
|
sl@0
|
114 |
|
|
sl@0
|
115 |
/**
|
|
sl@0
|
116 |
* Pop and remove the first Context of the highest priority and more than aPriority
|
|
sl@0
|
117 |
* from the Context queue
|
|
sl@0
|
118 |
* @param TInt aPriority
|
|
sl@0
|
119 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
120 |
*/
|
|
sl@0
|
121 |
CMMRCServerSession* PopAndRemoveRequestFirstHighestPriority( TInt aPriority );
|
|
sl@0
|
122 |
|
|
sl@0
|
123 |
/**
|
|
sl@0
|
124 |
* Pop the first Context from the Context queue
|
|
sl@0
|
125 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
126 |
*/
|
|
sl@0
|
127 |
CMMRCServerSession* PopFirstRequest( ) const;
|
|
sl@0
|
128 |
|
|
sl@0
|
129 |
/**
|
|
sl@0
|
130 |
* Pop the first Context of the highest priority from the Context queue
|
|
sl@0
|
131 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
132 |
*/
|
|
sl@0
|
133 |
CMMRCServerSession* PopRequestFirstHighestPriority( ) const;
|
|
sl@0
|
134 |
|
|
sl@0
|
135 |
/**
|
|
sl@0
|
136 |
* Pop the first Context of the highest priority and more than aPriority
|
|
sl@0
|
137 |
* from the Context queue
|
|
sl@0
|
138 |
* @param TInt aPriority
|
|
sl@0
|
139 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
140 |
*/
|
|
sl@0
|
141 |
CMMRCServerSession* PopRequestFirstHighestPriority( TInt aPriority ) const;
|
|
sl@0
|
142 |
|
|
sl@0
|
143 |
/**
|
|
sl@0
|
144 |
* Push an Context on the in-process Context queue
|
|
sl@0
|
145 |
* @param CMMRCServerSession& aServerSession
|
|
sl@0
|
146 |
* @leave in case of memory error
|
|
sl@0
|
147 |
*/
|
|
sl@0
|
148 |
void PushAllocatedResourceContextL(const CMMRCServerSession& aServerSession);
|
|
sl@0
|
149 |
|
|
sl@0
|
150 |
/**
|
|
sl@0
|
151 |
* Pop and remove the first Context of the highest priority from the in-process Context queue
|
|
sl@0
|
152 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
153 |
*/
|
|
sl@0
|
154 |
CMMRCServerSession* PopAndRemoveFirstAllocatedResourceContext();
|
|
sl@0
|
155 |
|
|
sl@0
|
156 |
/**
|
|
sl@0
|
157 |
* Pop and remove the first Context from the in-process Context queue by contextId
|
|
sl@0
|
158 |
* @param const TAudioContextId& aContextId
|
|
sl@0
|
159 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
160 |
*/
|
|
sl@0
|
161 |
CMMRCServerSession* PopAndRemoveFirstAllocatedResourceContextByContextId( const TAudioContextId& aContextId );
|
|
sl@0
|
162 |
|
|
sl@0
|
163 |
|
|
sl@0
|
164 |
/**
|
|
sl@0
|
165 |
* Pop the first Context from the in-process Context queue
|
|
sl@0
|
166 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
167 |
*/
|
|
sl@0
|
168 |
CMMRCServerSession* PopFirstAllocatedResourceContext( ) const;
|
|
sl@0
|
169 |
|
|
sl@0
|
170 |
void PushPausedContextL(const CMMRCServerSession& aServerSession );
|
|
sl@0
|
171 |
CMMRCServerSession* PopAndRemoveFirstPausedContext();
|
|
sl@0
|
172 |
CMMRCServerSession* PopAndRemovePausedContext(const TAudioContextId& aContextId );
|
|
sl@0
|
173 |
CMMRCServerSession* PausedContextByIndex(TInt aIndex);
|
|
sl@0
|
174 |
|
|
sl@0
|
175 |
void PushAPRContextL(const CMMRCServerSession& aServerSession );
|
|
sl@0
|
176 |
CMMRCServerSession* PopAndRemoveFirstAPRContext();
|
|
sl@0
|
177 |
CMMRCServerSession* PopAndRemoveFirstAPRContextByContextId(const TAudioContextId& aContextId );
|
|
sl@0
|
178 |
CMMRCServerSession* PopFirstAPRContext() const;
|
|
sl@0
|
179 |
|
|
sl@0
|
180 |
TBool IsOnAPRList(TAudioContextId aId);
|
|
sl@0
|
181 |
TBool IsOnPauseList(TAudioContextId aId);
|
|
sl@0
|
182 |
|
|
sl@0
|
183 |
|
|
sl@0
|
184 |
private:
|
|
sl@0
|
185 |
/**
|
|
sl@0
|
186 |
* Push an Context on the Context queue in parameter
|
|
sl@0
|
187 |
* @param RMMRCContextsQueueTD& aContextsQueue
|
|
sl@0
|
188 |
* @param CMMRCServerSession& aServerSession
|
|
sl@0
|
189 |
* @leave in case of memory error
|
|
sl@0
|
190 |
*/
|
|
sl@0
|
191 |
void PushContextL(RMMRCContextsQueueTD& aContextsQueue, const CMMRCServerSession& aServerSession);
|
|
sl@0
|
192 |
|
|
sl@0
|
193 |
/**
|
|
sl@0
|
194 |
* Pop and remove the first Context of the highest priority from the Context queue in parameter
|
|
sl@0
|
195 |
* @param RMMRCContextsQueueTD& aContextsQueue
|
|
sl@0
|
196 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
197 |
*/
|
|
sl@0
|
198 |
CMMRCServerSession* PopAndRemoveFirstContext(RMMRCContextsQueueTD& aContextsQueue);
|
|
sl@0
|
199 |
|
|
sl@0
|
200 |
/**
|
|
sl@0
|
201 |
* Pop and remove the first Context from the Context queue in parameter by contextId
|
|
sl@0
|
202 |
* @param RMMRCContextsQueueTD& aContextsQueue
|
|
sl@0
|
203 |
* @param const TAudioContextId& aContextId
|
|
sl@0
|
204 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
205 |
*/
|
|
sl@0
|
206 |
CMMRCServerSession* PopAndRemoveFirstContextByContextId(RMMRCContextsQueueTD& aContextsQueue, const TAudioContextId& aContextId );
|
|
sl@0
|
207 |
|
|
sl@0
|
208 |
/**
|
|
sl@0
|
209 |
* Pop and remove the first Context of the highest priority from the Context queue in parameter
|
|
sl@0
|
210 |
* @param RMMRCContextsQueueTD& aContextsQueue
|
|
sl@0
|
211 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
212 |
*/
|
|
sl@0
|
213 |
CMMRCServerSession* PopAndRemoveContextFirstHighestPriority(RMMRCContextsQueueTD& aContextsQueue);
|
|
sl@0
|
214 |
|
|
sl@0
|
215 |
/**
|
|
sl@0
|
216 |
* Pop and remove the first Context of the highest priority and more than aPriority
|
|
sl@0
|
217 |
* from the Context queue in parameter
|
|
sl@0
|
218 |
* @param RMMRCContextsQueueTD& aContextsQueue
|
|
sl@0
|
219 |
* @param TInt aPriority
|
|
sl@0
|
220 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
221 |
*/
|
|
sl@0
|
222 |
CMMRCServerSession* PopAndRemoveContextFirstHighestPriority(RMMRCContextsQueueTD& aContextsQueue, TInt aPriority );
|
|
sl@0
|
223 |
|
|
sl@0
|
224 |
/**
|
|
sl@0
|
225 |
* Pop the first Context from the Context queue in parameter
|
|
sl@0
|
226 |
* @param RMMRCContextsQueueTD& aContextsQueue
|
|
sl@0
|
227 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
228 |
*/
|
|
sl@0
|
229 |
CMMRCServerSession* PopFirstContext(const RMMRCContextsQueueTD& aContextsQueue) const;
|
|
sl@0
|
230 |
|
|
sl@0
|
231 |
/**
|
|
sl@0
|
232 |
* Pop the first Context of the highest priority from the Context queue in parameter
|
|
sl@0
|
233 |
* @param RMMRCContextsQueueTD& aContextsQueue
|
|
sl@0
|
234 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
235 |
*/
|
|
sl@0
|
236 |
CMMRCServerSession* PopContextFirstHighestPriority(const RMMRCContextsQueueTD& aContextsQueue) const;
|
|
sl@0
|
237 |
|
|
sl@0
|
238 |
/**
|
|
sl@0
|
239 |
* Pop the first Context of the highest priority and more than aPriority
|
|
sl@0
|
240 |
* from the Context queue in parameter
|
|
sl@0
|
241 |
* @param RMMRCContextsQueueTD& aContextsQueue
|
|
sl@0
|
242 |
* @param TInt aPriority
|
|
sl@0
|
243 |
* @return CMMRCServerSession* the session of the Context
|
|
sl@0
|
244 |
*/
|
|
sl@0
|
245 |
CMMRCServerSession* PopContextFirstHighestPriority(const RMMRCContextsQueueTD& aContextsQueue, TInt aPriority ) const;
|
|
sl@0
|
246 |
|
|
sl@0
|
247 |
void PushContextInOrderL(RMMRCContextsQueueOrderTD& aContextsQueue, const CMMRCServerSession& aServerSession);
|
|
sl@0
|
248 |
CMMRCServerSession* PopAndRemoveFirstContextForPause(RMMRCContextsQueueOrderTD& aContextsQueue);
|
|
sl@0
|
249 |
CMMRCServerSession* PopAndRemoveContextIdForPause(RMMRCContextsQueueOrderTD& aContextsQueue, const TAudioContextId& aContextId );
|
|
sl@0
|
250 |
CMMRCServerSession* PausedContextByIndexForPause(RMMRCContextsQueueOrderTD& aContextsQueue, TInt aIndex);
|
|
sl@0
|
251 |
|
|
sl@0
|
252 |
|
|
sl@0
|
253 |
private:
|
|
sl@0
|
254 |
/**
|
|
sl@0
|
255 |
* By default Symbian 2nd phase constructor is private.
|
|
sl@0
|
256 |
* @param CMMRCServerController& A reference on the MMRC Server controller
|
|
sl@0
|
257 |
*/
|
|
sl@0
|
258 |
CMMRCServerInfo(CMMRCServerController& aServerController);
|
|
sl@0
|
259 |
|
|
sl@0
|
260 |
/**
|
|
sl@0
|
261 |
* By default Symbian 2nd phase constructor is private.
|
|
sl@0
|
262 |
*/
|
|
sl@0
|
263 |
void ConstructL();
|
|
sl@0
|
264 |
|
|
sl@0
|
265 |
private:
|
|
sl@0
|
266 |
CMMRCServerController& iMMRCServerController;
|
|
sl@0
|
267 |
TMMRCServerState iMMRCServerInfoState;
|
|
sl@0
|
268 |
RMMRCContextsQueueTD iMMRCContextsQueue; //0 or more context(s)
|
|
sl@0
|
269 |
RMMRCContextsQueueTD iMMRCAllocatedResourceContextsQueue;
|
|
sl@0
|
270 |
RMMRCContextsQueueOrderTD iMMRCPausedContextsQueue;
|
|
sl@0
|
271 |
RMMRCContextsQueueTD iMMRCAPRContextsQueue;
|
|
sl@0
|
272 |
TUint64 iLastTransactionContextId;
|
|
sl@0
|
273 |
};
|
|
sl@0
|
274 |
|
|
sl@0
|
275 |
#endif //__MMRCSERVERINFO_H__
|