|
1 // Copyright (c) 2005-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 // THIS API IS INTERNAL TO NETWORKING AND IS SUBJECT TO CHANGE AND NOT FOR EXTERNAL USE |
|
15 // |
|
16 // |
|
17 |
|
18 /** |
|
19 @file |
|
20 @internalComponent |
|
21 */ |
|
22 |
|
23 #ifndef SYMBIAN_NODEMESSAGES_REJOININGPROVIDER_H |
|
24 #define SYMBIAN_NODEMESSAGES_REJOININGPROVIDER_H |
|
25 |
|
26 namespace ESock |
|
27 { |
|
28 |
|
29 //any new enum added here needs to go into one of the utracedecoder definition files |
|
30 //NEVER INSERT ANYTHING IN HERE ONLY ADD THE PENALTY IS SUDDEN DEATH! |
|
31 class TCFRejoiningProvider |
|
32 { |
|
33 private: |
|
34 enum |
|
35 { |
|
36 ECFRejoinDataClientRequest = 1, |
|
37 ECFRejoinComplete = 2, |
|
38 }; |
|
39 protected: |
|
40 |
|
41 public: |
|
42 enum { ERealmId = 0x10285F4C }; //UID allocated on 4/6/08 from KUidNodeMessageRealms |
|
43 /*========================================================================== |
|
44 <<Keys:>> |
|
45 [Name]: <messagename> |
|
46 [Semantics]: Message semantics |
|
47 |
|
48 [Type]: Request for <responsemsg>|Response to <requestmsg>|Notification/[Peerless] |
|
49 Where: |
|
50 Request - request to perform an action. Sender should expect <responsemsg> |
|
51 to ackowledge the completion of the action. |
|
52 Response - acknowledgement that the previous request is now completed. |
|
53 Notification - a one-off message flagging an event. |
|
54 Peerless - the message is peerless, i.e.: the sender doesn't have to |
|
55 be the recipient's client. |
|
56 [Fallible]: Yes|No |
|
57 Only applicable to requests and denotes whether the request can fail or not, |
|
58 or, in other words, whether the request can be completed to with TError. |
|
59 |
|
60 [Structure]: |
|
61 Every message defined in this realm has at least: |
|
62 param iSender - the message sender |
|
63 param iActivityId - depending on the message type: |
|
64 Request - the activity id the response should be addressed to. |
|
65 Request senders fill up this param to match the response |
|
66 with the local activity. Activity id on the sender side |
|
67 should uniquelly identify the activity expecting the response. |
|
68 Response - the activity on the recipient side expecting this response. |
|
69 the activityid to put here has been previously conveyed |
|
70 with the request. |
|
71 Notification - ignored. |
|
72 ===========================================================================*/ |
|
73 |
|
74 /*========================================================================== |
|
75 [Name]: TRejoinDataClientRequest |
|
76 [Semantics]: Sent to a provider requesting that the provider will move |
|
77 one of its dataclient to another provider. |
|
78 |
|
79 [Type]: Request for RReJoinComplete. |
|
80 [Fallible]: Yes. |
|
81 |
|
82 [Structure]: |
|
83 param: iCommsId - the dataclient to be migrated. |
|
84 param: iCommsId - the new owner. |
|
85 ===========================================================================*/ |
|
86 typedef Messages::TMessageSigNodeIdNodeId<ECFRejoinDataClientRequest, TCFRejoiningProvider::ERealmId> TRejoinDataClientRequest; |
|
87 typedef Messages::TMessageSigVoid<ECFRejoinComplete, TCFRejoiningProvider::ERealmId> TRejoinComplete; |
|
88 |
|
89 }; |
|
90 |
|
91 } //namespace esock |
|
92 |
|
93 #endif |
|
94 //SYMBIAN_NODEMESSAGES_REJOININGPROVIDER_H |
|
95 |