|
1 /** @file |
|
2 * Copyright (c) 2005-2006 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: Declares main application class. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef C_CUPNPSSDPMESSAGE_H |
|
20 #define C_CUPNPSSDPMESSAGE_H |
|
21 |
|
22 // INCLUDES |
|
23 #include <e32base.h> |
|
24 #include <in_sock.h> |
|
25 #include "upnphttpmessage.h" |
|
26 #include "upnphttpheader.h" |
|
27 |
|
28 // CLASS DECLARATION |
|
29 |
|
30 /** |
|
31 * Ssdp-Message class. Used in sending and handling Ssdp messages. |
|
32 * |
|
33 * @since Series60 2.0 |
|
34 */ |
|
35 class CUpnpSsdpMessage : public CUpnpHttpMessage |
|
36 { |
|
37 |
|
38 public: |
|
39 |
|
40 /** |
|
41 * Enumeration for message types: |
|
42 */ |
|
43 enum TRequestType |
|
44 { |
|
45 // This value is used in notify-type of messages, such as |
|
46 // ssdp:alive. |
|
47 ERequestNotify =1, |
|
48 // This value is used in ssdp:byebye messages. |
|
49 ERequestByeBye, |
|
50 // This value is used in search messages. |
|
51 ERequestSearch, |
|
52 // This value is used in replies to search messages. |
|
53 ERequestSearchResponse, |
|
54 |
|
55 ERequestUndefined |
|
56 |
|
57 }; |
|
58 |
|
59 public: // Constructors and destructor |
|
60 |
|
61 /** |
|
62 * Two-phased constructor. |
|
63 * @param aAddr Sender's IP address. |
|
64 * @param aRequestType Type of message to be constructed. |
|
65 */ |
|
66 IMPORT_C static CUpnpSsdpMessage* NewL( TInetAddr& aAddr, |
|
67 TRequestType aRequestType); |
|
68 |
|
69 /** |
|
70 * Two-phased constructor. |
|
71 * @param aRequestType Type of message to be constructed. |
|
72 */ |
|
73 IMPORT_C static CUpnpSsdpMessage* NewL( TRequestType aRequestType ); |
|
74 |
|
75 /** |
|
76 * Two-phased constructor. |
|
77 * @param aBuffer Buffer which contains the message. |
|
78 * @param aAddr Target IP address. |
|
79 */ |
|
80 IMPORT_C static CUpnpSsdpMessage* NewL(TDesC8& aBuffer, TInetAddr& aAddr ); |
|
81 |
|
82 /** |
|
83 * Destructor. |
|
84 */ |
|
85 IMPORT_C ~CUpnpSsdpMessage(); |
|
86 |
|
87 public: // New functions |
|
88 |
|
89 /** |
|
90 * Buffer to string. |
|
91 * @since Series60 2.0 |
|
92 * @return HBufC8 pointer |
|
93 */ |
|
94 HBufC8* ToStringL(); |
|
95 |
|
96 /** |
|
97 * Cache control. |
|
98 * @since Series60 2.0 |
|
99 * @return TInt |
|
100 */ |
|
101 IMPORT_C TInt CacheControl(); |
|
102 |
|
103 /** |
|
104 * Return UUID |
|
105 * @since Series60 2.0 |
|
106 * @return TPtr8 |
|
107 */ |
|
108 IMPORT_C TPtr8 Uuid(); |
|
109 |
|
110 /** |
|
111 * Return location |
|
112 * @since Series60 2.0 |
|
113 * @return TDesC8 |
|
114 */ |
|
115 IMPORT_C TDesC8& Location(); |
|
116 |
|
117 /** |
|
118 * Returns if SSDP notify. |
|
119 * @since Series60 2.0 |
|
120 * @return TBool |
|
121 */ |
|
122 IMPORT_C TBool IsSsdpNotify(); |
|
123 |
|
124 /** |
|
125 * Sets the host-header of Ssdp message. |
|
126 * @since Series60 2.0 |
|
127 * @param aHost Value of host to be set. |
|
128 */ |
|
129 IMPORT_C void AddHostL( TDesC8& aHost ); |
|
130 |
|
131 /** |
|
132 * Sets the USN-header of Ssdp message. |
|
133 * @since Series60 2.0 |
|
134 * @param aUsn Value of USN to be set. |
|
135 */ |
|
136 void AddUsnL(TDesC8& aUsn); |
|
137 |
|
138 /** |
|
139 * Sets the Cache-control-header of Ssdp message. |
|
140 * @since Series60 2.0 |
|
141 * @param aMaxAge Value of Cache-Control to be set. |
|
142 */ |
|
143 void AddCacheControlL(TDesC8& aMaxAge); |
|
144 |
|
145 /** |
|
146 * Sets the Description-header of Ssdp message. |
|
147 * @since Series60 2.0 |
|
148 * @param aDescriptionLocation Value of description to be set. |
|
149 */ |
|
150 void AddLocationL(TDesC8& aDescriptionLocation); |
|
151 |
|
152 /** |
|
153 * Sets the ST-header of Ssdp message. |
|
154 * @since Series60 2.0 |
|
155 * @param aSt Value of ST to be set. |
|
156 */ |
|
157 void AddSearchTargetStringL(TDesC8& aSt); |
|
158 |
|
159 /** |
|
160 * Sets the NT-header of Ssdp message. |
|
161 * @since Series60 2.0 |
|
162 * @param aNT Value of NT to be set. |
|
163 */ |
|
164 void AddNotificationTypeL(TDesC8& aNT); |
|
165 |
|
166 /** |
|
167 * Sets the Server description-header of Ssdp message. |
|
168 * @since Series60 2.0 |
|
169 * @param aServerType Value of server description to be set. |
|
170 */ |
|
171 void AddServerL(TDesC8& aServerType); |
|
172 |
|
173 /** |
|
174 * Sets the MX-header of Ssdp message. |
|
175 * @since Series60 2.0 |
|
176 * @param aMx Value of MX to be set. |
|
177 */ |
|
178 IMPORT_C void AddMxL(TDesC8& aMx); |
|
179 |
|
180 /** |
|
181 * Search target. |
|
182 * @since Series60 2.0 |
|
183 * @return TInt |
|
184 */ |
|
185 IMPORT_C TInt SearchTarget(); |
|
186 |
|
187 /** |
|
188 * Returns ETrue, if message is a Alive-message, else returns EFalse. |
|
189 * @since Series60 2.0 |
|
190 * @return ETrue, if message is a Alive-message, |
|
191 * else returns EFalse. |
|
192 */ |
|
193 IMPORT_C TBool IsSsdpAlive(); |
|
194 |
|
195 /** |
|
196 * Returns ETrue, if message is a Byebye-message, else returns EFalse. |
|
197 * @since Series60 2.0 |
|
198 * @return ETrue, if message is a Byebye-message, |
|
199 * else returns EFalse. |
|
200 */ |
|
201 IMPORT_C TBool IsSsdpByebye(); |
|
202 |
|
203 /** |
|
204 * Returns ETrue, if message is a search message, else returns EFalse. |
|
205 * @since Series60 2.0 |
|
206 * @return ETrue, if message is a search message, else returns EFalse. |
|
207 */ |
|
208 IMPORT_C TBool IsSsdpMSearch(); |
|
209 |
|
210 /** |
|
211 * Return if SSDP response. |
|
212 * @since Series60 2.0 |
|
213 * @return ETrue, if message is a response to search message, |
|
214 * else returns EFalse. |
|
215 */ |
|
216 IMPORT_C TBool IsSsdpResponse(); |
|
217 |
|
218 /** |
|
219 * Return if search all. |
|
220 * @since Series60 2.0 |
|
221 * @return ETrue, if message is a search message and |
|
222 * search is for all devices, else returns EFalse. |
|
223 */ |
|
224 IMPORT_C TBool IsSearchAll(); |
|
225 |
|
226 /** |
|
227 * Return if search device. |
|
228 * @since Series60 2.0 |
|
229 * @return ETrue, if message is a search message and |
|
230 * search is for certain devices, else returns EFalse. |
|
231 */ |
|
232 IMPORT_C TBool IsSearchDevice(); |
|
233 |
|
234 /** |
|
235 * Return if search service. |
|
236 * @since Series60 2.0 |
|
237 * @return ETrue, if message is a search message and |
|
238 * search is for certain services, else returns EFalse. |
|
239 */ |
|
240 IMPORT_C TBool IsSearchService(); |
|
241 |
|
242 /** |
|
243 * Returns NT-header of Ssdp message. |
|
244 * @since Series60 2.0 |
|
245 * @return NT-header of Ssdp message. |
|
246 */ |
|
247 IMPORT_C TDesC8& Nt(); |
|
248 |
|
249 /** |
|
250 * Returns USN-header of Ssdp message. |
|
251 * @since Series60 2.0 |
|
252 * @return USN-header of Ssdp message. |
|
253 */ |
|
254 IMPORT_C TDesC8& Usn(); |
|
255 |
|
256 /** |
|
257 * Returns ST-header of Ssdp message. |
|
258 * @since Series60 2.0 |
|
259 * @return ST-header of Ssdp message. |
|
260 */ |
|
261 IMPORT_C TDesC8& St(); |
|
262 |
|
263 /** |
|
264 * Returns NTS-header of Ssdp message. |
|
265 * @since Series60 2.0 |
|
266 * @return NTS-header of Ssdp message. |
|
267 */ |
|
268 IMPORT_C TDesC8& Nts(); |
|
269 |
|
270 /** |
|
271 * Enumeration for search message types: |
|
272 * @since Series60 2.0 |
|
273 */ |
|
274 enum TSearchTarget |
|
275 { |
|
276 |
|
277 // This message is not a search message. |
|
278 ESsdpNone = 1, |
|
279 // This is a search all message. |
|
280 ESsdpAll, |
|
281 // This is a root device search. |
|
282 EUPnPRootDevice, |
|
283 // This is a search by specific uuid. |
|
284 EDeviceUid, |
|
285 // This is a search by specific device type. |
|
286 EDeviceType, |
|
287 // This is a search by specific service type. |
|
288 EServiceType |
|
289 |
|
290 }; |
|
291 |
|
292 protected: // from CUpnpHttpMessage |
|
293 /** |
|
294 Append ContentLength when headers are dumped to string (using public method HeadersToStringL) |
|
295 @param aHeaders without "Content-Length" |
|
296 **/ |
|
297 IMPORT_C virtual void AppendContentLengthToHeadersL(HBufC8*& aHeaders); |
|
298 |
|
299 private: |
|
300 |
|
301 /** |
|
302 * C++ default constructor. |
|
303 */ |
|
304 CUpnpSsdpMessage(); |
|
305 |
|
306 /** |
|
307 * By default Symbian 2nd phase constructor is private. |
|
308 * @param aRequestType Type of message to be constructed. |
|
309 */ |
|
310 void ConstructL( TRequestType aRequestType ); |
|
311 |
|
312 /** |
|
313 * By default Symbian 2nd phase constructor is private. |
|
314 * @param aAddr Remote IP address |
|
315 */ |
|
316 void HttpConstructL( TInetAddr& aAddr ); |
|
317 |
|
318 private: |
|
319 |
|
320 /** |
|
321 * Parse buffer. |
|
322 * @since Series60 2.0 |
|
323 * @param aBuffer buffer to be parsed. |
|
324 */ |
|
325 void ParseL(TDesC8& aBuffer); |
|
326 |
|
327 }; |
|
328 |
|
329 #endif // C_CUPNPSSDPMESSAGE_H |
|
330 |
|
331 // End of File |