1 sipproxyrequireheader.h |
1 /* |
|
2 * Copyright (c) 2004-2009 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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * Name : sipproxyrequireheader.h |
|
16 * Part of : SIP Codec |
|
17 * Interface : SDK API, SIP Codec API |
|
18 * Version : SIP/4.0 |
|
19 * |
|
20 */ |
|
21 |
|
22 |
|
23 |
|
24 |
|
25 #ifndef CSIPPROXYREQUIREHEADER_H |
|
26 #define CSIPPROXYREQUIREHEADER_H |
|
27 |
|
28 // INCLUDES |
|
29 #include "siptokenheaderbase.h" |
|
30 #include "_sipcodecdefs.h" |
|
31 |
|
32 // CLASS DECLARATION |
|
33 /** |
|
34 * @publishedAll |
|
35 * @released |
|
36 * |
|
37 * Class provides functions for setting and getting parameters in |
|
38 * SIP "Proxy-Require" header. |
|
39 * |
|
40 * @lib sipcodec.lib |
|
41 */ |
|
42 class CSIPProxyRequireHeader : public CSIPTokenHeaderBase |
|
43 { |
|
44 public: // Constructors and destructor |
|
45 |
|
46 /** |
|
47 * Constructs a CSIPProxyRequireHeader from textual representation |
|
48 * of the header's value part. |
|
49 * @param aValue a value part of a "Proxy-Require"-header |
|
50 * @return an array containing 1..n instances of CSIPProxyRequireHeader |
|
51 */ |
|
52 IMPORT_C static RPointerArray<CSIPProxyRequireHeader> |
|
53 DecodeL(const TDesC8& aValue); |
|
54 |
|
55 /** |
|
56 * Creates a new instance of CSIPProxyRequireHeader |
|
57 * @param aValue a tag value |
|
58 * @return a new instance of CSIPProxyRequireHeader |
|
59 */ |
|
60 IMPORT_C static CSIPProxyRequireHeader* NewL(RStringF aValue); |
|
61 |
|
62 /** |
|
63 * Creates a new instance of CSIPProxyRequireHeader |
|
64 * and puts it to CleanupStack |
|
65 * @param aValue a tag value |
|
66 * @return a new instance of CSIPProxyRequireHeader |
|
67 */ |
|
68 IMPORT_C static CSIPProxyRequireHeader* NewLC(RStringF aValue); |
|
69 |
|
70 /** |
|
71 * Destructor, deletes the resources of CSIPProxyRequireHeader. |
|
72 */ |
|
73 IMPORT_C ~CSIPProxyRequireHeader(); |
|
74 |
|
75 |
|
76 public: // New functions |
|
77 |
|
78 /** |
|
79 * Constructs an instance of a CSIPProxyRequireHeader from a RReadStream |
|
80 * @param aReadStream a stream containing the value of the |
|
81 * externalized object (header name not included). |
|
82 * @return an instance of a CSIPProxyRequireHeader |
|
83 */ |
|
84 IMPORT_C static CSIPHeaderBase* InternalizeValueL(RReadStream& aReadStream); |
|
85 |
|
86 |
|
87 public: // From CSIPHeaderBase |
|
88 |
|
89 /** |
|
90 * From CSIPHeaderBase CloneL |
|
91 */ |
|
92 IMPORT_C CSIPHeaderBase* CloneL() const; |
|
93 |
|
94 /** |
|
95 * From CSIPHeaderBase Name |
|
96 */ |
|
97 IMPORT_C RStringF Name() const; |
|
98 |
|
99 |
|
100 public: // From CSIPHeaderBase, For internal use |
|
101 |
|
102 /** |
|
103 * @internalComponent |
|
104 */ |
|
105 TPreferredPlace PreferredPlaceInMessage() const; |
|
106 |
|
107 public: // New functions, for internal use |
|
108 |
|
109 static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue); |
|
110 |
|
111 private: // Constructors |
|
112 |
|
113 CSIPProxyRequireHeader(); |
|
114 CSIPProxyRequireHeader(const CSIPProxyRequireHeader& aHeader); |
|
115 }; |
|
116 |
|
117 #endif // end of CSIPPROXYREQUIREHEADER_H |
|
118 |
|
119 // End of File |