1 /* |
|
2 * Copyright (c) 2002-2007 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: SRCS session definition. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef _SRCSSESSION_H |
|
21 #define _SRCSSESSION_H |
|
22 |
|
23 // INCLUDES |
|
24 |
|
25 #include <e32svr.h> |
|
26 #include "obexserviceman.h" |
|
27 #include "SrcsServiceManager.h" |
|
28 |
|
29 // FORWARD DECLARATIONS |
|
30 class CObexSM; |
|
31 class CSrcsMessage; |
|
32 |
|
33 // CLASS DECLARATION |
|
34 |
|
35 /** |
|
36 * CSrcsSession class represent session on server side |
|
37 * |
|
38 */ |
|
39 class CSrcsSession : public CSession2, public MObexSMRequestObserver |
|
40 { |
|
41 public: // Constructors and destructor |
|
42 |
|
43 /** |
|
44 * Two-phased constructor. |
|
45 */ |
|
46 static CSrcsSession* NewL(CObexSM* aServer ); |
|
47 |
|
48 /** |
|
49 * Destructor. |
|
50 */ |
|
51 virtual ~CSrcsSession(); |
|
52 |
|
53 /** |
|
54 * 2nd phase construct for sessions |
|
55 * @return None |
|
56 */ |
|
57 void CreateL( ); |
|
58 |
|
59 public: // Functions from base classes |
|
60 |
|
61 /** |
|
62 * From CSession2 ServiceL |
|
63 * Client-server framework calls this function |
|
64 * to handle messages from client. |
|
65 * @param aMessage received message class |
|
66 * @return None |
|
67 */ |
|
68 virtual void ServiceL( const RMessage2 &aMessage ); |
|
69 |
|
70 /** |
|
71 * From CSession2 DispatchMessageL |
|
72 * Dispatchs and calls appropriate methods to |
|
73 * handle messages. |
|
74 * @param aMessage received message class |
|
75 * @return None |
|
76 */ |
|
77 void DispatchMessageL( const RMessage2 &aMessage ); |
|
78 |
|
79 /** |
|
80 * From CSession2 Server |
|
81 * Returns reference to server. |
|
82 * @param None |
|
83 * @return Reference to server |
|
84 */ |
|
85 CObexSM& Server(); |
|
86 |
|
87 public: // New functions |
|
88 |
|
89 /** |
|
90 * Complete Request |
|
91 * @param aMessage Request message to be completed |
|
92 * @param aError Error code |
|
93 * @return None. |
|
94 */ |
|
95 void RequestCompleted(const RMessage2 &aMessage, TInt aError); |
|
96 |
|
97 private: // New functions |
|
98 |
|
99 /** |
|
100 * OpCode function |
|
101 * Turns Services ON/OFF according to aState |
|
102 * @param aState boolean to indicate status of service. |
|
103 * @return None. |
|
104 */ |
|
105 void ManageServices( TSrcsTransport aTransport, TBool aState, const RMessage2& aMessage ); |
|
106 |
|
107 /** |
|
108 * Handles error situation. Panics client |
|
109 * or completes message with error status. |
|
110 * @param aError Error code |
|
111 * @return None |
|
112 */ |
|
113 void HandleError( TInt aError, const RMessage2& aMessage ); |
|
114 |
|
115 /** |
|
116 * Deletes message from message array |
|
117 * @param aMessage Pointer to message to be deleted. |
|
118 * @return None |
|
119 */ |
|
120 void DeleteMessage( CSrcsMessage* aMessage ); |
|
121 |
|
122 /** |
|
123 * Finds a message from message array |
|
124 * @param aMessage -reference to message. |
|
125 * @return Pointer to CSrcsMessage -instance. |
|
126 */ |
|
127 CSrcsMessage* FindMessage( const RMessage2& aMessage ); |
|
128 |
|
129 /** |
|
130 * Finds the first message with the function from message array |
|
131 * @param aFunction -the request function. |
|
132 * @return Pointer to CSrcsMessage -instance, NULL if not found. |
|
133 */ |
|
134 CSrcsMessage* FindMessage( TInt aFunction ); |
|
135 |
|
136 /** |
|
137 * Completes a message to client |
|
138 * @param aMessage -reference to message. |
|
139 * @param aReason -code to be delivered to client. |
|
140 */ |
|
141 void CompleteMessage( const RMessage2& aMessage, TInt aReason ); |
|
142 |
|
143 /** |
|
144 * Completes a message to client |
|
145 * @param aMessage -reference to message. |
|
146 * @param aReason -code to be delivered to client. |
|
147 */ |
|
148 void CompleteMessage( CSrcsMessage* aMessage, TInt aReason ); |
|
149 |
|
150 /** |
|
151 * Completes any messages pending in the CBTManMessage array. |
|
152 */ |
|
153 void CompletePendingMessages(); |
|
154 |
|
155 /** |
|
156 * Creates a new CSrcsMessage and puts it in |
|
157 * message array. |
|
158 * @param aMessage -reference to message. |
|
159 * @return None |
|
160 */ |
|
161 void CreateSrcsMessageL( const RMessage2& aMessage ); |
|
162 |
|
163 /** |
|
164 * Canceling previous request |
|
165 * @param aMessage -reference to message. |
|
166 */ |
|
167 void CancelingRequest(const RMessage2& aMessage); |
|
168 |
|
169 /** |
|
170 * Complete request when canceling |
|
171 * @param aMessage Request message to be completed |
|
172 * @param aError Error code |
|
173 * @param aPostponeCompletion Not completed yet |
|
174 * @return None. |
|
175 */ |
|
176 void CompleteCanceling(const RMessage2& aMessage, TInt aError, TBool& aPostponeCompletion); |
|
177 |
|
178 private: |
|
179 |
|
180 /** |
|
181 * C++ default constructor. |
|
182 */ |
|
183 CSrcsSession( CObexSM* aServer ); |
|
184 |
|
185 /** |
|
186 * Two-phase constructor. |
|
187 */ |
|
188 void ConstructL(); |
|
189 |
|
190 |
|
191 private: // Data |
|
192 CArrayPtr<CSrcsMessage>* iMessageArray; // array of outstanding messages |
|
193 CObexSM *iServer; |
|
194 TBool iCanceling; |
|
195 }; |
|
196 |
|
197 #endif // SRCSSESSION_H |
|
198 |
|
199 // End of File |
|