1.1 --- a/epoc32/include/sipsubscriptionstateheader.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/sipsubscriptionstateheader.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,191 @@
1.4 -sipsubscriptionstateheader.h
1.5 +/*
1.6 +* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.7 +* All rights reserved.
1.8 +* This component and the accompanying materials are made available
1.9 +* 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
1.10 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description:
1.19 +* Name : sipsubscriptionstateheader.h
1.20 +* Part of : SIP Codec
1.21 +* Interface : SDK API, SIP Codec API
1.22 +* Version : SIP/4.0
1.23 +*
1.24 +*/
1.25 +
1.26 +
1.27 +
1.28 +
1.29 +#ifndef CSIPSUBSCRIPTIONSTATEHEADER_H
1.30 +#define CSIPSUBSCRIPTIONSTATEHEADER_H
1.31 +
1.32 +// INCLUDES
1.33 +#include "sipparameterheaderbase.h"
1.34 +#include "_sipcodecdefs.h"
1.35 +
1.36 +// FORWARD DECLARATIONS
1.37 +class CSIPSubscriptionStateHeaderParams;
1.38 +
1.39 +// CLASS DECLARATION
1.40 +/**
1.41 +* @publishedAll
1.42 +* @released
1.43 +*
1.44 +* Class provides functions for setting and getting SIP "Subscription-State"
1.45 +* header fields.
1.46 +*
1.47 +* @lib sipcodec.lib
1.48 +*/
1.49 +class CSIPSubscriptionStateHeader : public CSIPParameterHeaderBase
1.50 + {
1.51 + public: // Constructors and destructor
1.52 +
1.53 + /**
1.54 + * Constructs a CSIPSubscriptionStateHeader from textual representation
1.55 + * of the header's value part.
1.56 + * @param aValue a value part of a "Subscription-State"-header
1.57 + * @return a new instance of CSIPSubscriptionStateHeader
1.58 + */
1.59 + IMPORT_C static CSIPSubscriptionStateHeader* DecodeL(const TDesC8& aValue);
1.60 +
1.61 + /**
1.62 + * Creates a new instance of CSIPSubscriptionStateHeader
1.63 + * @param aSubStateValue a substate-value value
1.64 + * @return a new instance of CSIPSubscriptionStateHeader
1.65 + */
1.66 + IMPORT_C static CSIPSubscriptionStateHeader*
1.67 + NewL(const TDesC8& aSubStateValue);
1.68 +
1.69 + /**
1.70 + * Creates a new instance of CSIPSubscriptionStateHeader
1.71 + * and puts it to CleanupStack
1.72 + * @param aSubStateValue a substate-value value
1.73 + * @return a new instance of CSIPSubscriptionStateHeader
1.74 + */
1.75 + IMPORT_C static CSIPSubscriptionStateHeader*
1.76 + NewLC(const TDesC8& aSubStateValue);
1.77 +
1.78 + /**
1.79 + * Destructor, deletes the resources of CSIPSubscriptionStateHeader.
1.80 + */
1.81 + IMPORT_C ~CSIPSubscriptionStateHeader();
1.82 +
1.83 +
1.84 + public: // New functions
1.85 +
1.86 + /**
1.87 + * Gets the substate-value parameter from the "Subscription-State" header
1.88 + * @return the substate-value parameter
1.89 + */
1.90 + IMPORT_C const TDesC8& SubStateValue() const;
1.91 +
1.92 + /**
1.93 + * Sets the substate-value parameter in the "Subscription-State" header;
1.94 + * @param aSubStateValue a substate-value parameter to set
1.95 + */
1.96 + IMPORT_C void SetSubStateValueL(const TDesC8& aSubStateValue);
1.97 +
1.98 + /**
1.99 + * Gets the value of the "expires"-parameter
1.100 + * @return "expires"-parameter or KErrNotFound if not present
1.101 + */
1.102 + IMPORT_C TInt ExpiresParameter() const;
1.103 +
1.104 + /**
1.105 + * Sets the "expires"-parameter
1.106 + * @pre aExpiresParam >= 0
1.107 + * @param aExpiresParam a "expires"-parameter value to set
1.108 + */
1.109 + IMPORT_C void SetExpiresParameterL(TInt aExpiresParam);
1.110 +
1.111 + /**
1.112 + * Gets the value of the "retry-after"-parameter
1.113 + * @return "retry-after"-parameter or KErrNotFound if not present
1.114 + */
1.115 + IMPORT_C TInt RetryAfterParameter() const;
1.116 +
1.117 + /**
1.118 + * Sets the "retry-after"-parameter
1.119 + * @pre aRetryAfterParam >= 0
1.120 + * @param aRetryAfterParam a "retry-after"-parameter value to set
1.121 + */
1.122 + IMPORT_C void SetRetryAfterParameterL(TInt aRetryAfterParam);
1.123 +
1.124 + /**
1.125 + * Constructs an instance of a CSIPSubscriptionStateHeader
1.126 + * from a RReadStream
1.127 + * @param aReadStream a stream containing the value of the
1.128 + * externalized object (header name not included).
1.129 + * @return an instance of a CSIPSubscriptionStateHeader
1.130 + */
1.131 + IMPORT_C static CSIPHeaderBase*
1.132 + InternalizeValueL(RReadStream& aReadStream);
1.133 +
1.134 +
1.135 + public: // From CSIPHeaderBase
1.136 +
1.137 + /**
1.138 + * From CSIPHeaderBase CloneL
1.139 + */
1.140 + IMPORT_C CSIPHeaderBase* CloneL() const;
1.141 +
1.142 + /**
1.143 + * From CSIPHeaderBase Name
1.144 + */
1.145 + IMPORT_C RStringF Name() const;
1.146 +
1.147 +
1.148 + public: // From CSIPHeaderBase, for internal use
1.149 +
1.150 + /**
1.151 + * @internalComponent
1.152 + */
1.153 + TPreferredPlace PreferredPlaceInMessage() const;
1.154 +
1.155 + public: // New functions, for internal use
1.156 +
1.157 + static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
1.158 +
1.159 + private: // From CSIPHeaderBase
1.160 +
1.161 + void ExternalizeValueL(RWriteStream& aWriteStream) const;
1.162 +
1.163 + private: // From CSIPParameterHeaderBase
1.164 +
1.165 + HBufC8* ToTextMandatoryPartLC() const;
1.166 + void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
1.167 + const CSIPParamContainerBase& Params() const;
1.168 + CSIPParamContainerBase& Params();
1.169 +
1.170 + private: // Constructors
1.171 +
1.172 + CSIPSubscriptionStateHeader();
1.173 + void ConstructL();
1.174 + void ConstructL(const TDesC8& aSubStateValue);
1.175 + void ConstructL (const CSIPSubscriptionStateHeader&
1.176 + aSubscriptionStateHeader);
1.177 +
1.178 + private: // New functions
1.179 +
1.180 + void DoInternalizeValueL(RReadStream& aReadStream);
1.181 +
1.182 + private: // Data
1.183 +
1.184 + HBufC8* iSubStateValue;
1.185 + CSIPSubscriptionStateHeaderParams* iParams;
1.186 +
1.187 + private: // For testing purposes
1.188 +
1.189 + UNIT_TEST(CSIPSubscriptionStateHeaderTest)
1.190 + };
1.191 +
1.192 +
1.193 +#endif // CSIPSUBSCRIPTIONSTATEHEADER_H
1.194 +
1.195 +// End of File