1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/sipacceptcontactheader.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,172 @@
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 : sipacceptcontactheader.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 CSIPACCEPTCONTACTHEADER_H
1.29 +#define CSIPACCEPTCONTACTHEADER_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 CSIPAcceptContactHeaderParams;
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 +* "Accept-Contact" header.
1.45 +*
1.46 +* @lib sipcodec.lib
1.47 +*/
1.48 +class CSIPAcceptContactHeader : public CSIPParameterHeaderBase
1.49 + {
1.50 + public: // Constructors and destructor
1.51 +
1.52 + /**
1.53 + * Constructs a CSIPAcceptContactHeader from textual representation
1.54 + * of the header's value part.
1.55 + * @param aValue a value part of a "Accept-Contact"-header
1.56 + * (e.g. "*;param=value")
1.57 + * @return an array containing one to many instances
1.58 + * of CSIPAcceptContactHeader
1.59 + */
1.60 + IMPORT_C static RPointerArray<CSIPAcceptContactHeader>
1.61 + DecodeL(const TDesC8& aValue);
1.62 +
1.63 + /**
1.64 + * Creates a new instance of CSIPAcceptContactHeader
1.65 + * @return a new instance of CSIPAcceptContactHeader
1.66 + */
1.67 + IMPORT_C static CSIPAcceptContactHeader* NewL();
1.68 +
1.69 + /**
1.70 + * Creates a new instance of CSIPAcceptContactHeader
1.71 + * On return the new instance has left to the CleanupStack.
1.72 + * @return a new instance of CSIPAcceptContactHeader
1.73 + */
1.74 + IMPORT_C static CSIPAcceptContactHeader* NewLC();
1.75 +
1.76 + /**
1.77 + * Destructor, deletes the resources of CSIPAcceptContactHeader.
1.78 + */
1.79 + IMPORT_C virtual ~CSIPAcceptContactHeader();
1.80 +
1.81 +
1.82 + public: // New functions
1.83 +
1.84 + /**
1.85 + * Compares this instance to another "Accept-Contact" header object.
1.86 + * Two Accept-Contact-headers are equal,
1.87 + * if both contain exactly the same parameters.
1.88 + * The order of the parameters is not sufficient.
1.89 + * @param aHeader a header to compare to
1.90 + * @return ETrue, if the objects are equal otherwise EFalse
1.91 + */
1.92 + IMPORT_C TBool operator==(const CSIPAcceptContactHeader& aHeader) const;
1.93 +
1.94 + /**
1.95 + * Constructs an instance of a CSIPAcceptContactHeader from a RReadStream
1.96 + * @param aReadStream a stream containing the value of the
1.97 + * externalized object (header name not included).
1.98 + * @return an instance of a CSIPAcceptContactHeader
1.99 + */
1.100 + IMPORT_C static CSIPHeaderBase*
1.101 + InternalizeValueL(RReadStream& aReadStream);
1.102 +
1.103 +
1.104 + public: // From CSIPHeaderBase
1.105 +
1.106 + /**
1.107 + * From CSIPHeaderBase CloneL
1.108 + */
1.109 + IMPORT_C CSIPHeaderBase* CloneL() const;
1.110 +
1.111 + /**
1.112 + * From CSIPHeaderBase Name
1.113 + */
1.114 + IMPORT_C RStringF Name() const;
1.115 +
1.116 +
1.117 + public: // From CSIPHeaderBase, for internal use
1.118 +
1.119 + /**
1.120 + * @internalComponent
1.121 + */
1.122 + TBool HasCompactName() const;
1.123 +
1.124 + /**
1.125 + * @internalComponent
1.126 + */
1.127 + RStringF CompactName() const;
1.128 +
1.129 + /**
1.130 + * @internalComponent
1.131 + */
1.132 + TBool MoreThanOneAllowed() const;
1.133 +
1.134 + /**
1.135 + * @internalComponent
1.136 + */
1.137 + TPreferredPlace PreferredPlaceInMessage() const;
1.138 +
1.139 + public: // New functions, for internal use
1.140 +
1.141 + static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
1.142 +
1.143 + private: // From CSIPHeaderBase
1.144 +
1.145 + void ExternalizeValueL(RWriteStream& aWriteStream) const;
1.146 +
1.147 + private: // From CSIPParameterHeaderBase
1.148 +
1.149 + HBufC8* ToTextMandatoryPartLC() const;
1.150 + void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
1.151 + const CSIPParamContainerBase& Params() const;
1.152 + CSIPParamContainerBase& Params();
1.153 +
1.154 + private: // Constructors
1.155 +
1.156 + CSIPAcceptContactHeader();
1.157 + void ConstructL();
1.158 + void ConstructL(const CSIPAcceptContactHeader& aAcceptContactHeader);
1.159 +
1.160 + private: // New functions
1.161 +
1.162 + void DoInternalizeValueL(RReadStream& aReadStream);
1.163 +
1.164 + private: // Data
1.165 +
1.166 + CSIPAcceptContactHeaderParams* iParams;
1.167 +
1.168 + private: // For testing purposes
1.169 +
1.170 + UNIT_TEST(CSIPAcceptContactHeaderTest)
1.171 + };
1.172 +
1.173 +#endif // CSIPACCEPTCONTACTHEADER_H
1.174 +
1.175 +// End of File