williamr@2
|
1 |
/*
|
williamr@2
|
2 |
* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
|
williamr@2
|
3 |
* All rights reserved.
|
williamr@2
|
4 |
* This component and the accompanying materials are made available
|
williamr@2
|
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
|
williamr@2
|
6 |
* which accompanies this distribution, and is available
|
williamr@2
|
7 |
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
|
williamr@2
|
8 |
*
|
williamr@2
|
9 |
* Initial Contributors:
|
williamr@2
|
10 |
* Nokia Corporation - initial contribution.
|
williamr@2
|
11 |
*
|
williamr@2
|
12 |
* Contributors:
|
williamr@2
|
13 |
*
|
williamr@2
|
14 |
* Description:
|
williamr@2
|
15 |
* Name : sipsubscriptionstateheader.h
|
williamr@2
|
16 |
* Part of : SIP Codec
|
williamr@2
|
17 |
* Interface : SDK API, SIP Codec API
|
williamr@2
|
18 |
* Version : SIP/4.0
|
williamr@2
|
19 |
*
|
williamr@2
|
20 |
*/
|
williamr@2
|
21 |
|
williamr@2
|
22 |
|
williamr@2
|
23 |
|
williamr@2
|
24 |
|
williamr@2
|
25 |
#ifndef CSIPSUBSCRIPTIONSTATEHEADER_H
|
williamr@2
|
26 |
#define CSIPSUBSCRIPTIONSTATEHEADER_H
|
williamr@2
|
27 |
|
williamr@2
|
28 |
// INCLUDES
|
williamr@2
|
29 |
#include "sipparameterheaderbase.h"
|
williamr@2
|
30 |
#include "_sipcodecdefs.h"
|
williamr@2
|
31 |
|
williamr@2
|
32 |
// FORWARD DECLARATIONS
|
williamr@2
|
33 |
class CSIPSubscriptionStateHeaderParams;
|
williamr@2
|
34 |
|
williamr@2
|
35 |
// CLASS DECLARATION
|
williamr@2
|
36 |
/**
|
williamr@2
|
37 |
* @publishedAll
|
williamr@2
|
38 |
* @released
|
williamr@2
|
39 |
*
|
williamr@2
|
40 |
* Class provides functions for setting and getting SIP "Subscription-State"
|
williamr@2
|
41 |
* header fields.
|
williamr@2
|
42 |
*
|
williamr@2
|
43 |
* @lib sipcodec.lib
|
williamr@2
|
44 |
*/
|
williamr@2
|
45 |
class CSIPSubscriptionStateHeader : public CSIPParameterHeaderBase
|
williamr@2
|
46 |
{
|
williamr@2
|
47 |
public: // Constructors and destructor
|
williamr@2
|
48 |
|
williamr@2
|
49 |
/**
|
williamr@2
|
50 |
* Constructs a CSIPSubscriptionStateHeader from textual representation
|
williamr@2
|
51 |
* of the header's value part.
|
williamr@2
|
52 |
* @param aValue a value part of a "Subscription-State"-header
|
williamr@2
|
53 |
* @return a new instance of CSIPSubscriptionStateHeader
|
williamr@2
|
54 |
*/
|
williamr@2
|
55 |
IMPORT_C static CSIPSubscriptionStateHeader* DecodeL(const TDesC8& aValue);
|
williamr@2
|
56 |
|
williamr@2
|
57 |
/**
|
williamr@2
|
58 |
* Creates a new instance of CSIPSubscriptionStateHeader
|
williamr@2
|
59 |
* @param aSubStateValue a substate-value value
|
williamr@2
|
60 |
* @return a new instance of CSIPSubscriptionStateHeader
|
williamr@2
|
61 |
*/
|
williamr@2
|
62 |
IMPORT_C static CSIPSubscriptionStateHeader*
|
williamr@2
|
63 |
NewL(const TDesC8& aSubStateValue);
|
williamr@2
|
64 |
|
williamr@2
|
65 |
/**
|
williamr@2
|
66 |
* Creates a new instance of CSIPSubscriptionStateHeader
|
williamr@2
|
67 |
* and puts it to CleanupStack
|
williamr@2
|
68 |
* @param aSubStateValue a substate-value value
|
williamr@2
|
69 |
* @return a new instance of CSIPSubscriptionStateHeader
|
williamr@2
|
70 |
*/
|
williamr@2
|
71 |
IMPORT_C static CSIPSubscriptionStateHeader*
|
williamr@2
|
72 |
NewLC(const TDesC8& aSubStateValue);
|
williamr@2
|
73 |
|
williamr@2
|
74 |
/**
|
williamr@2
|
75 |
* Destructor, deletes the resources of CSIPSubscriptionStateHeader.
|
williamr@2
|
76 |
*/
|
williamr@2
|
77 |
IMPORT_C ~CSIPSubscriptionStateHeader();
|
williamr@2
|
78 |
|
williamr@2
|
79 |
|
williamr@2
|
80 |
public: // New functions
|
williamr@2
|
81 |
|
williamr@2
|
82 |
/**
|
williamr@2
|
83 |
* Gets the substate-value parameter from the "Subscription-State" header
|
williamr@2
|
84 |
* @return the substate-value parameter
|
williamr@2
|
85 |
*/
|
williamr@2
|
86 |
IMPORT_C const TDesC8& SubStateValue() const;
|
williamr@2
|
87 |
|
williamr@2
|
88 |
/**
|
williamr@2
|
89 |
* Sets the substate-value parameter in the "Subscription-State" header;
|
williamr@2
|
90 |
* @param aSubStateValue a substate-value parameter to set
|
williamr@2
|
91 |
*/
|
williamr@2
|
92 |
IMPORT_C void SetSubStateValueL(const TDesC8& aSubStateValue);
|
williamr@2
|
93 |
|
williamr@2
|
94 |
/**
|
williamr@2
|
95 |
* Gets the value of the "expires"-parameter
|
williamr@2
|
96 |
* @return "expires"-parameter or KErrNotFound if not present
|
williamr@2
|
97 |
*/
|
williamr@2
|
98 |
IMPORT_C TInt ExpiresParameter() const;
|
williamr@2
|
99 |
|
williamr@2
|
100 |
/**
|
williamr@2
|
101 |
* Sets the "expires"-parameter
|
williamr@2
|
102 |
* @pre aExpiresParam >= 0
|
williamr@2
|
103 |
* @param aExpiresParam a "expires"-parameter value to set
|
williamr@2
|
104 |
*/
|
williamr@2
|
105 |
IMPORT_C void SetExpiresParameterL(TInt aExpiresParam);
|
williamr@2
|
106 |
|
williamr@2
|
107 |
/**
|
williamr@2
|
108 |
* Gets the value of the "retry-after"-parameter
|
williamr@2
|
109 |
* @return "retry-after"-parameter or KErrNotFound if not present
|
williamr@2
|
110 |
*/
|
williamr@2
|
111 |
IMPORT_C TInt RetryAfterParameter() const;
|
williamr@2
|
112 |
|
williamr@2
|
113 |
/**
|
williamr@2
|
114 |
* Sets the "retry-after"-parameter
|
williamr@2
|
115 |
* @pre aRetryAfterParam >= 0
|
williamr@2
|
116 |
* @param aRetryAfterParam a "retry-after"-parameter value to set
|
williamr@2
|
117 |
*/
|
williamr@2
|
118 |
IMPORT_C void SetRetryAfterParameterL(TInt aRetryAfterParam);
|
williamr@2
|
119 |
|
williamr@2
|
120 |
/**
|
williamr@2
|
121 |
* Constructs an instance of a CSIPSubscriptionStateHeader
|
williamr@2
|
122 |
* from a RReadStream
|
williamr@2
|
123 |
* @param aReadStream a stream containing the value of the
|
williamr@2
|
124 |
* externalized object (header name not included).
|
williamr@2
|
125 |
* @return an instance of a CSIPSubscriptionStateHeader
|
williamr@2
|
126 |
*/
|
williamr@2
|
127 |
IMPORT_C static CSIPHeaderBase*
|
williamr@2
|
128 |
InternalizeValueL(RReadStream& aReadStream);
|
williamr@2
|
129 |
|
williamr@2
|
130 |
|
williamr@2
|
131 |
public: // From CSIPHeaderBase
|
williamr@2
|
132 |
|
williamr@2
|
133 |
/**
|
williamr@2
|
134 |
* From CSIPHeaderBase CloneL
|
williamr@2
|
135 |
*/
|
williamr@2
|
136 |
IMPORT_C CSIPHeaderBase* CloneL() const;
|
williamr@2
|
137 |
|
williamr@2
|
138 |
/**
|
williamr@2
|
139 |
* From CSIPHeaderBase Name
|
williamr@2
|
140 |
*/
|
williamr@2
|
141 |
IMPORT_C RStringF Name() const;
|
williamr@2
|
142 |
|
williamr@2
|
143 |
|
williamr@2
|
144 |
public: // From CSIPHeaderBase, for internal use
|
williamr@2
|
145 |
|
williamr@2
|
146 |
/**
|
williamr@2
|
147 |
* @internalComponent
|
williamr@2
|
148 |
*/
|
williamr@2
|
149 |
TPreferredPlace PreferredPlaceInMessage() const;
|
williamr@2
|
150 |
|
williamr@2
|
151 |
public: // New functions, for internal use
|
williamr@2
|
152 |
|
williamr@2
|
153 |
static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
|
williamr@2
|
154 |
|
williamr@2
|
155 |
private: // From CSIPHeaderBase
|
williamr@2
|
156 |
|
williamr@2
|
157 |
void ExternalizeValueL(RWriteStream& aWriteStream) const;
|
williamr@2
|
158 |
|
williamr@2
|
159 |
private: // From CSIPParameterHeaderBase
|
williamr@2
|
160 |
|
williamr@2
|
161 |
HBufC8* ToTextMandatoryPartLC() const;
|
williamr@2
|
162 |
void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
|
williamr@2
|
163 |
const CSIPParamContainerBase& Params() const;
|
williamr@2
|
164 |
CSIPParamContainerBase& Params();
|
williamr@2
|
165 |
|
williamr@2
|
166 |
private: // Constructors
|
williamr@2
|
167 |
|
williamr@2
|
168 |
CSIPSubscriptionStateHeader();
|
williamr@2
|
169 |
void ConstructL();
|
williamr@2
|
170 |
void ConstructL(const TDesC8& aSubStateValue);
|
williamr@2
|
171 |
void ConstructL (const CSIPSubscriptionStateHeader&
|
williamr@2
|
172 |
aSubscriptionStateHeader);
|
williamr@2
|
173 |
|
williamr@2
|
174 |
private: // New functions
|
williamr@2
|
175 |
|
williamr@2
|
176 |
void DoInternalizeValueL(RReadStream& aReadStream);
|
williamr@2
|
177 |
|
williamr@2
|
178 |
private: // Data
|
williamr@2
|
179 |
|
williamr@2
|
180 |
HBufC8* iSubStateValue;
|
williamr@2
|
181 |
CSIPSubscriptionStateHeaderParams* iParams;
|
williamr@2
|
182 |
|
williamr@2
|
183 |
private: // For testing purposes
|
williamr@2
|
184 |
|
williamr@2
|
185 |
UNIT_TEST(CSIPSubscriptionStateHeaderTest)
|
williamr@2
|
186 |
};
|
williamr@2
|
187 |
|
williamr@2
|
188 |
|
williamr@2
|
189 |
#endif // CSIPSUBSCRIPTIONSTATEHEADER_H
|
williamr@2
|
190 |
|
williamr@2
|
191 |
// End of File
|