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