1.1 --- a/epoc32/include/sipretryafterheader.h Tue Mar 16 16:12:26 2010 +0000
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,179 +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 : sipretryafterheader.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 CSIPRETRYAFTERHEADER_H
1.29 -#define CSIPRETRYAFTERHEADER_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 CSIPRetryAfterHeaderParams;
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 parameters in SIP
1.44 -* "Retry-After" header.
1.45 -*
1.46 -* @lib sipcodec.lib
1.47 -*/
1.48 -class CSIPRetryAfterHeader : public CSIPParameterHeaderBase
1.49 - {
1.50 - public: // Constructors and destructor
1.51 -
1.52 - /**
1.53 - * Constructs a CSIPRetryAfterHeader from textual representation
1.54 - * of the header's value part.
1.55 - * @param aValue a value part of a "Retry-After"-header
1.56 - * (e.g. "18000;duration=3600")
1.57 - * @return a new instance of CSIPRetryAfterHeader
1.58 - */
1.59 - IMPORT_C static CSIPRetryAfterHeader* DecodeL(const TDesC8& aValue);
1.60 -
1.61 - /**
1.62 - * Creates a new instance of CSIPRetryAfterHeader
1.63 - * @param aRetryAfter a retry after value.
1.64 - * @return a new instance of CSIPRetryAfterHeader
1.65 - */
1.66 - IMPORT_C static CSIPRetryAfterHeader* NewL(TUint aRetryAfter);
1.67 -
1.68 - /**
1.69 - * Creates a new instance of CSIPRetryAfterHeader
1.70 - * On return the new instance has left to the CleanupStack.
1.71 - * @param aRetryAfter a retry after value.
1.72 - * @return a new instance of CSIPRetryAfterHeader
1.73 - */
1.74 - IMPORT_C static CSIPRetryAfterHeader* NewLC(TUint aRetryAfter);
1.75 -
1.76 - /**
1.77 - * Destructor, deletes the resources of CSIPRetryAfterHeader.
1.78 - */
1.79 - IMPORT_C virtual ~CSIPRetryAfterHeader();
1.80 -
1.81 -
1.82 - public: // New functions
1.83 -
1.84 - /**
1.85 - * Sets the retry after value
1.86 - * @param aValue a new retry after value to set.
1.87 - */
1.88 - IMPORT_C void SetRetryAfter(TUint aValue);
1.89 -
1.90 - /**
1.91 - * Gets the retry after value
1.92 - * @return a retry after value
1.93 - */
1.94 - IMPORT_C TUint RetryAfter() const;
1.95 -
1.96 - /**
1.97 - * Gets the comment value
1.98 - * @return a comment value or KNullDesC8
1.99 - */
1.100 - IMPORT_C const TDesC8& Comment() const;
1.101 -
1.102 - /**
1.103 - * Gets the value of the "duration"-parameter
1.104 - * @return the "duration"-parameter, or
1.105 - * KErrNotFound if the parameter is not present.
1.106 - */
1.107 - IMPORT_C TInt DurationParam() const;
1.108 -
1.109 - /**
1.110 - * Sets the "duration"-parameter
1.111 - * @pre aDurationParam >= 0
1.112 - * @param aDurationParam a "duration"-parameter value to set
1.113 - */
1.114 - IMPORT_C void SetDurationParamL(TInt aDurationParam);
1.115 -
1.116 - /**
1.117 - * Constructs an instance of a CSIPRetryAfterHeader from a RReadStream
1.118 - * @param aReadStream a stream containing the value of the
1.119 - * externalized object (header name not included).
1.120 - * @return an instance of a CSIPRetryAfterHeader
1.121 - */
1.122 - IMPORT_C static CSIPHeaderBase*
1.123 - InternalizeValueL(RReadStream& aReadStream);
1.124 -
1.125 -
1.126 - public: // From CSIPHeaderBase
1.127 -
1.128 - /**
1.129 - * From CSIPHeaderBase CloneL
1.130 - */
1.131 - IMPORT_C CSIPHeaderBase* CloneL() const;
1.132 -
1.133 - /**
1.134 - * From CSIPHeaderBase Name
1.135 - */
1.136 - IMPORT_C RStringF Name() const;
1.137 -
1.138 -
1.139 - public: // From CSIPHeaderBase, for internal use
1.140 -
1.141 - TPreferredPlace PreferredPlaceInMessage() const;
1.142 -
1.143 - public: // New functions, for internal use
1.144 -
1.145 - static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
1.146 -
1.147 - private: // From CSIPHeaderBase
1.148 -
1.149 - void ExternalizeValueL(RWriteStream& aWriteStream) const;
1.150 -
1.151 - private: // From CSIPParameterHeaderBase
1.152 -
1.153 - HBufC8* ToTextMandatoryPartLC() const;
1.154 - void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
1.155 - const CSIPParamContainerBase& Params() const;
1.156 - CSIPParamContainerBase& Params();
1.157 -
1.158 - private: // Constructors
1.159 -
1.160 - CSIPRetryAfterHeader();
1.161 - CSIPRetryAfterHeader(TUint aRetryAfter);
1.162 - void ConstructL();
1.163 - void ConstructL(const CSIPRetryAfterHeader& aRetryAfterHeader);
1.164 -
1.165 - private: // New functions
1.166 -
1.167 - void DoInternalizeValueL(RReadStream& aReadStream);
1.168 -
1.169 - private: // Data
1.170 -
1.171 - TUint iRetryAfter;
1.172 - HBufC8* iComment;
1.173 - CSIPRetryAfterHeaderParams* iParams;
1.174 -
1.175 - private: // For testing purposes
1.176 -
1.177 - UNIT_TEST(CSIPRetryAfterHeaderTest)
1.178 - };
1.179 -
1.180 -#endif // end of CSIPRETRYAFTERHEADER_H
1.181 -
1.182 -// End of File