|
1 /* |
|
2 * Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: RMessage2 wrapper holding general message utils. |
|
15 * |
|
16 */ |
|
17 |
|
18 // INCLUDES |
|
19 #include "RPEngMessage.h" |
|
20 #include "PEngMessagePacker.h" |
|
21 |
|
22 |
|
23 // MACROS |
|
24 /* |
|
25 #define __CHECK_CLIENT_PART_\ |
|
26 RThread client;\ |
|
27 CleanupClosePushL( client );\ |
|
28 iMessage.ClientL( client );\ |
|
29 TInt exitType( client.ExitType() );\ |
|
30 CleanupStack::PopAndDestroy();\ |
|
31 if ( exitType != EExitPending )\ |
|
32 {\ |
|
33 return;\ |
|
34 } |
|
35 |
|
36 #define __CHECK_CLIENT_PART_INT\ |
|
37 RThread client;\ |
|
38 CleanupClosePushL( client );\ |
|
39 iMessage.ClientL( client );\ |
|
40 TInt exitType( client.ExitType() );\ |
|
41 CleanupStack::PopAndDestroy();\ |
|
42 if ( exitType != EExitPending )\ |
|
43 {\ |
|
44 return EFalse;\ |
|
45 } |
|
46 |
|
47 #define __CHECK_CLIENT_PART_LEAVE\ |
|
48 RThread client;\ |
|
49 CleanupClosePushL( client );\ |
|
50 iMessage.ClientL( client );\ |
|
51 TInt exitType( client.ExitType() );\ |
|
52 if ( exitType != EExitPending )\ |
|
53 {\ |
|
54 User::Leave( KErrGeneral );\ |
|
55 }\ |
|
56 CleanupStack::PopAndDestroy(); |
|
57 */ |
|
58 #define __CHECK_CLIENT_PART_ |
|
59 #define __CHECK_CLIENT_PART_INT |
|
60 #define __CHECK_CLIENT_PART_LEAVE |
|
61 |
|
62 |
|
63 // ====================== MEMBER FUNCTIONS ====================================== |
|
64 // ----------------------------------------------------------------------------- |
|
65 // RPEngMessage::RPEngMessage() |
|
66 // C++ default constructor can NOT contain any code, that |
|
67 // might leave. |
|
68 // ----------------------------------------------------------------------------- |
|
69 // |
|
70 EXPORT_C RPEngMessage::RPEngMessage() |
|
71 : iMessageValid( EFalse ) |
|
72 { |
|
73 } |
|
74 |
|
75 |
|
76 // ----------------------------------------------------------------------------- |
|
77 // RPEngMessage::RPEngMessage |
|
78 // C++ constructor can NOT contain any code, that |
|
79 // might leave. |
|
80 // ----------------------------------------------------------------------------- |
|
81 // |
|
82 EXPORT_C RPEngMessage::RPEngMessage( const RMessage2& aMessage ) |
|
83 : iMessageValid( ETrue ), |
|
84 iMessage( aMessage ) |
|
85 { |
|
86 } |
|
87 |
|
88 |
|
89 // ----------------------------------------------------------------------------- |
|
90 // RPEngMessage::RPEngMessage() |
|
91 // C++ constructor can NOT contain any code, that |
|
92 // might leave. |
|
93 // ----------------------------------------------------------------------------- |
|
94 // |
|
95 EXPORT_C RPEngMessage::RPEngMessage( const RPEngMessage& aMyMessage ) |
|
96 : iMessageValid( aMyMessage.iMessageValid ), |
|
97 iMessage( aMyMessage.iMessage ) |
|
98 { |
|
99 } |
|
100 |
|
101 |
|
102 // ----------------------------------------------------------------------------- |
|
103 // RPEngMessage::RPEngMessage() |
|
104 // C++ assignment operator can NOT contain any code, that |
|
105 // might leave. |
|
106 // ----------------------------------------------------------------------------- |
|
107 // |
|
108 EXPORT_C RPEngMessage& RPEngMessage::operator=( |
|
109 const RPEngMessage & aMessage ) |
|
110 { |
|
111 iMessageValid = ETrue; |
|
112 iMessage = aMessage.iMessage; |
|
113 return( *this ); |
|
114 } |
|
115 |
|
116 |
|
117 // Destructor |
|
118 EXPORT_C RPEngMessage::~RPEngMessage() |
|
119 { |
|
120 } |
|
121 |
|
122 |
|
123 |
|
124 // ============================================================================= |
|
125 // =================== Message compete / validation ============================ |
|
126 // ============================================================================= |
|
127 |
|
128 // ----------------------------------------------------------------------------- |
|
129 // RPEngMessage::MessageValid() |
|
130 // Check if client message is still valid |
|
131 // ----------------------------------------------------------------------------- |
|
132 // |
|
133 EXPORT_C TBool RPEngMessage::MessageValid() const |
|
134 { |
|
135 if ( !iMessageValid ) |
|
136 { |
|
137 return iMessageValid; |
|
138 } |
|
139 __CHECK_CLIENT_PART_INT; |
|
140 return iMessageValid; |
|
141 } |
|
142 |
|
143 |
|
144 // ----------------------------------------------------------------------------- |
|
145 // RPEngMessage::Complete() |
|
146 // ----------------------------------------------------------------------------- |
|
147 // |
|
148 EXPORT_C void RPEngMessage::Complete( TInt aReason ) const |
|
149 { |
|
150 if ( iMessageValid ) |
|
151 { |
|
152 __CHECK_CLIENT_PART_; |
|
153 iMessage.Complete( aReason ); |
|
154 } |
|
155 |
|
156 // Once message is completed, |
|
157 // Set flag to empty ==> multiple completing of message do not harm |
|
158 ( const_cast<RPEngMessage*>( this ) )->iMessageValid = EFalse; |
|
159 } |
|
160 |
|
161 |
|
162 |
|
163 |
|
164 // ============================================================================= |
|
165 // ================== General message read/write utils ========================= |
|
166 // ============================================================================= |
|
167 |
|
168 |
|
169 // ----------------------------------------------------------------------------- |
|
170 // RPEngMessage::DesLength() |
|
171 // ----------------------------------------------------------------------------- |
|
172 // |
|
173 EXPORT_C TInt RPEngMessage::DesLength( TInt aParam ) const |
|
174 { |
|
175 __CHECK_CLIENT_PART_INT; |
|
176 return iMessage.GetDesLength( aParam ); |
|
177 } |
|
178 |
|
179 |
|
180 // ----------------------------------------------------------------------------- |
|
181 // RPEngMessage::DesMaxLength() |
|
182 // ----------------------------------------------------------------------------- |
|
183 // |
|
184 EXPORT_C TInt RPEngMessage::DesMaxLength( TInt aParam ) const |
|
185 { |
|
186 __CHECK_CLIENT_PART_INT; |
|
187 return iMessage.GetDesMaxLength( aParam ); |
|
188 } |
|
189 |
|
190 |
|
191 // ----------------------------------------------------------------------------- |
|
192 // RPEngMessage::ReadOneDescriptor16L() |
|
193 // ----------------------------------------------------------------------------- |
|
194 // |
|
195 EXPORT_C HBufC16* RPEngMessage::ReadOneDescriptor16L( TInt aParam ) const |
|
196 { |
|
197 HBufC16* desBuf = ReadOneDescriptor16LC( aParam ); |
|
198 CleanupStack::Pop(); // desBuf |
|
199 return desBuf; |
|
200 } |
|
201 |
|
202 |
|
203 // ----------------------------------------------------------------------------- |
|
204 // RPEngMessage::ReadOneDescriptor16L() |
|
205 // ----------------------------------------------------------------------------- |
|
206 // |
|
207 EXPORT_C HBufC16* RPEngMessage::ReadOneDescriptor16LC( TInt aParam ) const |
|
208 { |
|
209 __CHECK_CLIENT_PART_LEAVE; |
|
210 TInt length( DesLength( aParam ) ); |
|
211 if ( length < 0 ) |
|
212 { |
|
213 User::Leave( length ); |
|
214 } |
|
215 HBufC16* desBuf = HBufC16::NewLC( length ); |
|
216 TPtr des = desBuf->Des(); |
|
217 iMessage.ReadL( aParam, des ); |
|
218 return desBuf; |
|
219 } |
|
220 |
|
221 |
|
222 // ----------------------------------------------------------------------------- |
|
223 // RPEngMessage::ReadOneDescriptor() |
|
224 // ----------------------------------------------------------------------------- |
|
225 // |
|
226 EXPORT_C TInt RPEngMessage::ReadOneDescriptor( TInt aParam, |
|
227 HBufC16*& aDes ) const |
|
228 { |
|
229 __CHECK_CLIENT_PART_LEAVE; |
|
230 TInt length( DesLength( aParam ) ); |
|
231 if ( length < KErrNone ) |
|
232 { |
|
233 return length; |
|
234 } |
|
235 |
|
236 aDes = HBufC16::New( length ); |
|
237 if ( !aDes ) |
|
238 { |
|
239 return KErrNoMemory; |
|
240 } |
|
241 |
|
242 TPtr des = aDes->Des(); |
|
243 return iMessage.Read( aParam, des ); |
|
244 } |
|
245 |
|
246 // ----------------------------------------------------------------------------- |
|
247 // RPEngMessage::ReadOneDescriptor() |
|
248 // ----------------------------------------------------------------------------- |
|
249 // |
|
250 EXPORT_C void RPEngMessage::ReadOneDescriptorL( TInt aParam, |
|
251 RBuf& aDes ) const |
|
252 { |
|
253 __CHECK_CLIENT_PART_LEAVE; |
|
254 TInt length( DesLength( aParam ) ); |
|
255 User::LeaveIfError( length ); |
|
256 if ( length > aDes.MaxLength() ) |
|
257 { |
|
258 aDes.ReAllocL( length ); |
|
259 } |
|
260 aDes.Zero(); |
|
261 return iMessage.ReadL( aParam, aDes ); |
|
262 } |
|
263 |
|
264 // ----------------------------------------------------------------------------- |
|
265 // RPEngMessage::ReadOneDescriptor8L() |
|
266 // ----------------------------------------------------------------------------- |
|
267 // |
|
268 EXPORT_C HBufC8* RPEngMessage::ReadOneDescriptor8L( TInt aParam ) const |
|
269 { |
|
270 __CHECK_CLIENT_PART_LEAVE; |
|
271 HBufC8* desBuf = ReadOneDescriptor8LC( aParam ); |
|
272 CleanupStack::Pop( desBuf ); |
|
273 return desBuf; |
|
274 } |
|
275 |
|
276 |
|
277 // ----------------------------------------------------------------------------- |
|
278 // RPEngMessage::ReadOneDescriptor8LC() |
|
279 // ----------------------------------------------------------------------------- |
|
280 // |
|
281 EXPORT_C HBufC8* RPEngMessage::ReadOneDescriptor8LC( TInt aParam ) const |
|
282 { |
|
283 __CHECK_CLIENT_PART_LEAVE; |
|
284 TInt length( DesLength( aParam ) ); |
|
285 if ( length < 0 ) |
|
286 { |
|
287 User::Leave( length ); |
|
288 } |
|
289 |
|
290 HBufC8* desBuf = HBufC8::NewLC( length ); |
|
291 TPtr8 des = desBuf->Des(); |
|
292 iMessage.ReadL( aParam, des ); |
|
293 |
|
294 return desBuf; |
|
295 } |
|
296 |
|
297 |
|
298 // ----------------------------------------------------------------------------- |
|
299 // RPEngMessage::ReadOneDescriptor() |
|
300 // ----------------------------------------------------------------------------- |
|
301 // |
|
302 EXPORT_C TInt RPEngMessage::ReadOneDescriptor( TInt aParam, |
|
303 HBufC8*& aDes ) const |
|
304 { |
|
305 __CHECK_CLIENT_PART_LEAVE; |
|
306 TInt length( DesLength( aParam ) ); |
|
307 if ( length < KErrNone ) |
|
308 { |
|
309 return length; |
|
310 } |
|
311 |
|
312 aDes = HBufC8::New( length ); |
|
313 if ( !aDes ) |
|
314 { |
|
315 return KErrNoMemory; |
|
316 } |
|
317 |
|
318 TPtr8 des = aDes->Des(); |
|
319 return iMessage.Read( aParam, des ); |
|
320 } |
|
321 |
|
322 // ----------------------------------------------------------------------------- |
|
323 // RPEngMessage::ReadOneDescriptor() |
|
324 // ----------------------------------------------------------------------------- |
|
325 // |
|
326 EXPORT_C void RPEngMessage::ReadOneDescriptorL( TInt aParam, |
|
327 RBuf8& aDes ) const |
|
328 { |
|
329 __CHECK_CLIENT_PART_LEAVE; |
|
330 TInt length( DesLength( aParam ) ); |
|
331 User::LeaveIfError( length ); |
|
332 if ( length > aDes.MaxLength() ) |
|
333 { |
|
334 aDes.ReAllocL( length ); |
|
335 } |
|
336 aDes.Zero(); |
|
337 return iMessage.ReadL( aParam, aDes ); |
|
338 } |
|
339 |
|
340 // ----------------------------------------------------------------------------- |
|
341 // RPEngMessage::WriteOneDescriptorL() |
|
342 // ----------------------------------------------------------------------------- |
|
343 // |
|
344 EXPORT_C void RPEngMessage::WriteOneDescriptorL( TInt aParam, |
|
345 const TDesC16& aDes, |
|
346 TInt aOffset /* 0 */ ) const |
|
347 { |
|
348 __CHECK_CLIENT_PART_LEAVE; |
|
349 iMessage.WriteL( aParam, aDes, aOffset ); |
|
350 } |
|
351 |
|
352 |
|
353 // ----------------------------------------------------------------------------- |
|
354 // RPEngMessage::WriteOneDescriptor() |
|
355 // ----------------------------------------------------------------------------- |
|
356 // |
|
357 EXPORT_C TInt RPEngMessage::WriteOneDescriptor( TInt aParam, |
|
358 const TDesC16& aDes, |
|
359 TInt aOffset /* 0 */ ) const |
|
360 { |
|
361 __CHECK_CLIENT_PART_LEAVE; |
|
362 return iMessage.Write( aParam, aDes, aOffset ); |
|
363 } |
|
364 |
|
365 |
|
366 // ----------------------------------------------------------------------------- |
|
367 // RPEngMessage::WriteOneDescriptorL() |
|
368 // ----------------------------------------------------------------------------- |
|
369 // |
|
370 EXPORT_C void RPEngMessage::WriteOneDescriptorL( TInt aParam, |
|
371 const TDesC8& aDes, |
|
372 TInt aOffset /* 0 */ ) const |
|
373 { |
|
374 __CHECK_CLIENT_PART_LEAVE; |
|
375 iMessage.WriteL( aParam, aDes, aOffset ); |
|
376 } |
|
377 |
|
378 |
|
379 // ----------------------------------------------------------------------------- |
|
380 // RPEngMessage::WriteOneDescriptor( |
|
381 // ----------------------------------------------------------------------------- |
|
382 // |
|
383 EXPORT_C TInt RPEngMessage::WriteOneDescriptor( TInt aParam, |
|
384 const TDesC8& aDes, |
|
385 TInt aOffset /* 0 */ ) const |
|
386 { |
|
387 __CHECK_CLIENT_PART_LEAVE; |
|
388 return iMessage.Write( aParam, aDes, aOffset ); |
|
389 } |
|
390 |
|
391 |
|
392 |
|
393 |
|
394 |
|
395 // ============================================================================= |
|
396 // =========== message read/write descriptor array functions =================== |
|
397 // ============================================================================= |
|
398 |
|
399 |
|
400 // ----------------------------------------------------------------------------- |
|
401 // RPEngMessage::ReadDescriptorArrayCount |
|
402 // ----------------------------------------------------------------------------- |
|
403 // |
|
404 EXPORT_C TInt RPEngMessage::ReadDescriptorArrayCountL( TInt aParam ) const |
|
405 { |
|
406 __CHECK_CLIENT_PART_LEAVE; |
|
407 // read just first element where is stored info about the count |
|
408 TBuf<1> buf; |
|
409 iMessage.ReadL( aParam, buf ); |
|
410 return PEngMessagePacker::DesArrayCount( buf ); |
|
411 } |
|
412 |
|
413 |
|
414 // ----------------------------------------------------------------------------- |
|
415 // RPEngMessage::ReadFirstDescriptorFromArrayL() |
|
416 // ----------------------------------------------------------------------------- |
|
417 // |
|
418 EXPORT_C HBufC16* RPEngMessage::ReadFirstDescriptorFromArrayL( TInt aParam ) const |
|
419 { |
|
420 HBufC16* desBuf = ReadOneDescriptor16LC( aParam ); |
|
421 HBufC16* ret = PEngMessagePacker::UnpackFirstDesFromArrayL( *desBuf ); |
|
422 CleanupStack::PopAndDestroy(); // desBuf |
|
423 return ret; |
|
424 } |
|
425 |
|
426 |
|
427 // ----------------------------------------------------------------------------- |
|
428 // RPEngMessage::ReadDescriptorArrayL |
|
429 // ----------------------------------------------------------------------------- |
|
430 // |
|
431 EXPORT_C void RPEngMessage::ReadDescriptorArrayL( |
|
432 TInt aParam, |
|
433 CDesCArray& aTargetArray ) const |
|
434 { |
|
435 HBufC16* desBuf = ReadOneDescriptor16LC( aParam ); |
|
436 PEngMessagePacker::UnpackDesArrayL( *desBuf, aTargetArray ); |
|
437 CleanupStack::PopAndDestroy(); // desBuf |
|
438 } |
|
439 |
|
440 // ----------------------------------------------------------------------------- |
|
441 // RPEngMessage::ReadDescriptorArrayL |
|
442 // ----------------------------------------------------------------------------- |
|
443 // |
|
444 EXPORT_C HBufC* RPEngMessage::ReadDescriptorArrayLC( |
|
445 TInt aParam, |
|
446 CPtrCArray& aTargetArray ) const |
|
447 { |
|
448 HBufC16* desBuf = ReadOneDescriptor16LC( aParam ); |
|
449 PEngMessagePacker::UnpackDesArrayL( *desBuf, aTargetArray ); |
|
450 return desBuf; |
|
451 } |
|
452 |
|
453 // ----------------------------------------------------------------------------- |
|
454 // RPEngMessage::WriteDescriptorArrayL( |
|
455 // ----------------------------------------------------------------------------- |
|
456 // |
|
457 EXPORT_C void RPEngMessage::WriteDescriptorArrayL( |
|
458 TInt aParam, |
|
459 const MDesCArray& aSourceArray ) const |
|
460 { |
|
461 HBufC16* bufDes = PEngMessagePacker::PackDesArrayL( aSourceArray ); |
|
462 CleanupStack::PushL( bufDes ); |
|
463 WriteOneDescriptorL( aParam, *bufDes ); |
|
464 CleanupStack::PopAndDestroy( ); //bufDes |
|
465 } |
|
466 |
|
467 |
|
468 |
|
469 |
|
470 // ============================================================================= |
|
471 // =========== message read/write RArray<TInt> functions ======================= |
|
472 // ============================================================================= |
|
473 |
|
474 // ----------------------------------------------------------------------------- |
|
475 // RPEngMessage::WriteTIntArrayL |
|
476 // ----------------------------------------------------------------------------- |
|
477 // |
|
478 EXPORT_C void RPEngMessage::WriteTIntArrayL( |
|
479 TInt aParam, |
|
480 RArray<TInt>& aTargetArray ) const |
|
481 { |
|
482 HBufC16* desBuf = PEngMessagePacker::PackTIntArrayL( aTargetArray ); |
|
483 CleanupStack::PushL( desBuf ); |
|
484 WriteOneDescriptorL( aParam, *desBuf ); |
|
485 CleanupStack::PopAndDestroy( ); // desBuf |
|
486 } |
|
487 |
|
488 |
|
489 |
|
490 // ============================================================================= |
|
491 // =========== RMessage2 take over functions =================================== |
|
492 // ============================================================================= |
|
493 |
|
494 // ----------------------------------------------------------------------------- |
|
495 // RPEngMessage::Int0() |
|
496 // ----------------------------------------------------------------------------- |
|
497 // |
|
498 EXPORT_C TInt RPEngMessage::Int0() const |
|
499 { |
|
500 return iMessage.Int0(); |
|
501 } |
|
502 |
|
503 |
|
504 // ----------------------------------------------------------------------------- |
|
505 // RPEngMessage::Int1() |
|
506 // ----------------------------------------------------------------------------- |
|
507 // |
|
508 EXPORT_C TInt RPEngMessage::Int1() const |
|
509 { |
|
510 return iMessage.Int1(); |
|
511 } |
|
512 |
|
513 |
|
514 // ----------------------------------------------------------------------------- |
|
515 // RPEngMessage::Int2() |
|
516 // ----------------------------------------------------------------------------- |
|
517 // |
|
518 EXPORT_C TInt RPEngMessage::Int2() const |
|
519 { |
|
520 return iMessage.Int2(); |
|
521 } |
|
522 |
|
523 |
|
524 // ----------------------------------------------------------------------------- |
|
525 // RPEngMessage::Int3() |
|
526 // ----------------------------------------------------------------------------- |
|
527 // |
|
528 EXPORT_C TInt RPEngMessage::Int3() const |
|
529 { |
|
530 return iMessage.Int3(); |
|
531 } |
|
532 |
|
533 |
|
534 // ----------------------------------------------------------------------------- |
|
535 // RPEngMessage::Panic() |
|
536 // ----------------------------------------------------------------------------- |
|
537 // |
|
538 EXPORT_C void RPEngMessage::Panic( const TDesC& aCategory, |
|
539 TInt aReason ) const |
|
540 { |
|
541 iMessage.Panic( aCategory, aReason ); |
|
542 } |
|
543 |
|
544 // ----------------------------------------------------------------------------- |
|
545 // RPEngMessage::Kill() |
|
546 // ----------------------------------------------------------------------------- |
|
547 // |
|
548 EXPORT_C void RPEngMessage::Kill( TInt aReason ) const |
|
549 { |
|
550 iMessage.Kill( aReason ); |
|
551 } |
|
552 |
|
553 |
|
554 // ----------------------------------------------------------------------------- |
|
555 // RPEngMessage::Terminate() |
|
556 // ----------------------------------------------------------------------------- |
|
557 // |
|
558 EXPORT_C void RPEngMessage::Terminate( TInt aReason ) const |
|
559 { |
|
560 iMessage.Terminate( aReason ); |
|
561 } |
|
562 |
|
563 |
|
564 // ----------------------------------------------------------------------------- |
|
565 // RPEngMessage::Function() |
|
566 // ----------------------------------------------------------------------------- |
|
567 // |
|
568 EXPORT_C TInt RPEngMessage::Function() const |
|
569 { |
|
570 return iMessage.Function(); |
|
571 } |
|
572 |
|
573 |
|
574 // ----------------------------------------------------------------------------- |
|
575 // RPEngMessage::Client() |
|
576 // ----------------------------------------------------------------------------- |
|
577 // |
|
578 EXPORT_C TInt RPEngMessage::Client( RThread& aClient, |
|
579 TOwnerType aOwnerType ) const |
|
580 { |
|
581 return iMessage.Client( aClient, aOwnerType ); |
|
582 } |
|
583 |
|
584 |
|
585 // End of File |
|
586 |
|
587 |