|
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 file should be removed once FindOrCreateTM is removed by changes being made by subramanian |
|
15 // THIS API IS INTERNAL TO NETWORKING AND IS SUBJECT TO CHANGE AND NOT FOR EXTERNAL USE |
|
16 // |
|
17 // |
|
18 |
|
19 /** |
|
20 @file |
|
21 @internalAll |
|
22 */ |
|
23 |
|
24 #ifndef SYMBIAN_NODEMESSAGES_TIERMANAGERFACTORY_H |
|
25 #define SYMBIAN_NODEMESSAGES_TIERMANAGERFACTORY_H |
|
26 |
|
27 #include <comms-infras/ss_nodemessages_factory.h> |
|
28 |
|
29 namespace ESock |
|
30 { |
|
31 |
|
32 |
|
33 //any new enum added here needs to go into one of the utracedecoder definition files |
|
34 //NEVER INSERT ANYTHING IN HERE ONLY ADD THE PENALTY IS SUDDEN DEATH! |
|
35 class TCFTierManagerFactory //: public TCFFactory |
|
36 { |
|
37 private: |
|
38 enum |
|
39 { |
|
40 ECFFindOrCreateTM = 1 //new realm TTierManagerFactory. if tricky ignore till robs changes pulled in |
|
41 }; |
|
42 protected: |
|
43 |
|
44 public: |
|
45 enum { ERealmId = 0x10285F53 }; //UID allocated on 4/6/08 from KUidNodeMessageRealms |
|
46 /*========================================================================== |
|
47 <<Keys:>> |
|
48 [Name]: <messagename> |
|
49 [Semantics]: Message semantics |
|
50 |
|
51 [Type]: Request for <responsemsg>|Response to <requestmsg>|Notification/[Peerless] |
|
52 Where: |
|
53 Request - request to perform an action. Sender should expect <responsemsg> |
|
54 to ackowledge the completion of the action. |
|
55 Response - acknowledgement that the previous request is now completed. |
|
56 Notification - a one-off message flagging an event. |
|
57 Peerless - the message is peerless, i.e.: the sender doesn't have to |
|
58 be the recipient's client. |
|
59 [Fallible]: Yes|No |
|
60 Only applicable to requests and denotes whether the request can fail or not, |
|
61 or, in other words, whether the request can be completed to with TError. |
|
62 |
|
63 [Structure]: |
|
64 Every message defined in this realm has at least: |
|
65 param iSender - the message sender |
|
66 param iActivityId - depending on the message type: |
|
67 Request - the activity id the response should be addressed to. |
|
68 Request senders fill up this param to match the response |
|
69 with the local activity. Activity id on the sender side |
|
70 should uniquelly identify the activity expecting the response. |
|
71 Response - the activity on the recipient side expecting this response. |
|
72 the activityid to put here has been previously conveyed |
|
73 with the request. |
|
74 Notification - ignored. |
|
75 ===========================================================================*/ |
|
76 |
|
77 //--Factories-- |
|
78 /*========================================================================== |
|
79 [Name]: TFindOrCreateTM |
|
80 [Semantics]: Request sent to a factory container. The TierManager object is to |
|
81 be preexisting or newly created. |
|
82 |
|
83 [Type]: Request |
|
84 [Fallible]: Yes |
|
85 |
|
86 [Structure]: |
|
87 param iUid - UID of the top-most tier (used to initialise the new TM) |
|
88 ===========================================================================*/ |
|
89 typedef Messages::TMessageSigUid<ECFFindOrCreateTM, TCFTierManagerFactory::ERealmId> TFindOrCreateTM; |
|
90 }; |
|
91 } //namespace esock |
|
92 |
|
93 #endif |
|
94 //SYMBIAN_NODEMESSAGES_TIERMANAGERFACTORY_H |
|
95 |