|
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 "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: |
|
15 * Name : siprequireheader.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 CSIPREQUIREHEADER_H |
|
26 #define CSIPREQUIREHEADER_H |
|
27 |
|
28 // INCLUDES |
|
29 #include "siptokenheaderbase.h" |
|
30 |
|
31 // CLASS DECLARATION |
|
32 /** |
|
33 * @publishedAll |
|
34 * @released |
|
35 * |
|
36 * Class provides functions for setting and getting parameters in |
|
37 * SIP "Require" header. |
|
38 * |
|
39 * @lib sipcodec.lib |
|
40 */ |
|
41 class CSIPRequireHeader : public CSIPTokenHeaderBase |
|
42 { |
|
43 public: // Constructors and destructor |
|
44 |
|
45 /** |
|
46 * Constructs a CSIPRequireHeader from textual representation |
|
47 * of the header's value part. |
|
48 * @param aValue a value part of a "Require"-header |
|
49 * @return an array containing 1..n instances of CSIPRequireHeader |
|
50 */ |
|
51 IMPORT_C static RPointerArray<CSIPRequireHeader> |
|
52 DecodeL(const TDesC8& aValue); |
|
53 |
|
54 /** |
|
55 * Creates a new instance of CSIPRequireHeader |
|
56 * @param aValue a tag value |
|
57 * @return a new instance of CSIPRequireHeader |
|
58 */ |
|
59 IMPORT_C static CSIPRequireHeader* NewL(RStringF aValue); |
|
60 |
|
61 /** |
|
62 * Creates a new instance of CSIPRequireHeader |
|
63 * and puts it to CleanupStack |
|
64 * @param aValue a tag value |
|
65 * @return a new instance of CSIPRequireHeader |
|
66 */ |
|
67 IMPORT_C static CSIPRequireHeader* NewLC(RStringF aValue); |
|
68 |
|
69 /** |
|
70 * Destructor, deletes the resources of CSIPRequireHeader. |
|
71 */ |
|
72 IMPORT_C ~CSIPRequireHeader(); |
|
73 |
|
74 |
|
75 public: // New functions |
|
76 |
|
77 /** |
|
78 * Constructs an instance of a CSIPRequireHeader from a RReadStream |
|
79 * @param aReadStream a stream containing the value of the |
|
80 * externalized object (header name not included). |
|
81 * @return an instance of a CSIPRequireHeader |
|
82 */ |
|
83 IMPORT_C static CSIPHeaderBase* InternalizeValueL(RReadStream& aReadStream); |
|
84 |
|
85 |
|
86 public: // From CSIPHeaderBase |
|
87 |
|
88 /** |
|
89 * From CSIPHeaderBase CloneL |
|
90 */ |
|
91 IMPORT_C CSIPHeaderBase* CloneL() const; |
|
92 |
|
93 /** |
|
94 * From CSIPHeaderBase Name |
|
95 */ |
|
96 IMPORT_C RStringF Name() const; |
|
97 |
|
98 |
|
99 public: // From CSIPHeaderBase, For internal use |
|
100 |
|
101 /** |
|
102 * @internalComponent |
|
103 */ |
|
104 TPreferredPlace PreferredPlaceInMessage() const; |
|
105 |
|
106 public: // New functions, for internal use |
|
107 |
|
108 static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue); |
|
109 |
|
110 private: // Constructors |
|
111 |
|
112 CSIPRequireHeader(); |
|
113 CSIPRequireHeader(const CSIPRequireHeader& aHeader); |
|
114 }; |
|
115 |
|
116 #endif // end of CSIPREQUIREHEADER_H |
|
117 |
|
118 // End of File |