1.1 --- a/epoc32/include/sipeventheader.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/sipeventheader.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,195 @@
1.4 -sipeventheader.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 : sipeventheader.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 CSIPEVENTHEADER_H
1.30 +#define CSIPEVENTHEADER_H
1.31 +
1.32 +// INCLUDES
1.33 +#include <bamdesca.h>
1.34 +#include <badesca.h>
1.35 +#include "sipparameterheaderbase.h"
1.36 +#include "_sipcodecdefs.h"
1.37 +
1.38 +// FORWARD DECLARATIONS
1.39 +class CSIPEventHeaderParams;
1.40 +
1.41 +// CLASS DECLARATION
1.42 +/**
1.43 +* @publishedAll
1.44 +* @released
1.45 +*
1.46 +* Class provides functions for setting and getting parameters in
1.47 +* SIP "Event" header.
1.48 +*
1.49 +* @lib sipcodec.lib
1.50 +*/
1.51 +class CSIPEventHeader : public CSIPParameterHeaderBase
1.52 + {
1.53 + public: // Constructors and destructor
1.54 +
1.55 + /**
1.56 + * Constructs a CSIPEventHeader from textual representation
1.57 + * of the header's value part.
1.58 + * @param aValue a value part of a "Event"-header
1.59 + * @return a new instance of CSIPEventHeader
1.60 + */
1.61 + IMPORT_C static CSIPEventHeader* DecodeL(const TDesC8& aValue);
1.62 +
1.63 + /**
1.64 + * Creates a new instance of CSIPEventHeader
1.65 + * @param aEventPackage a Event-Package value
1.66 + * @return a new instance of CSIPEventHeader
1.67 + */
1.68 + IMPORT_C static CSIPEventHeader* NewL(const TDesC8& aEventPackage);
1.69 +
1.70 + /**
1.71 + * Creates a new instance of CSIPEventHeader and puts it to CleanupStack
1.72 + * @param aEventPackage a Event-Package value
1.73 + * @return a new instance of CSIPEventHeader
1.74 + */
1.75 +
1.76 + IMPORT_C static CSIPEventHeader* NewLC(const TDesC8& aEventPackage);
1.77 +
1.78 + /**
1.79 + * Destructor, deletes the resources of CSIPEventHeader.
1.80 + */
1.81 + IMPORT_C ~CSIPEventHeader();
1.82 +
1.83 +
1.84 + public: // New functions
1.85 +
1.86 + /**
1.87 + * Compares this instance to another CSIPEventHeader instance
1.88 + * @param aHeader a header to compare to
1.89 + * @return ETrue if the objects are equal otherwise EFalse
1.90 + */
1.91 + IMPORT_C TBool operator==(const CSIPEventHeader& aHeader) const;
1.92 +
1.93 + /**
1.94 + * Gets the Event-Package parameter from the "Event" header
1.95 + * @return the Event-Package parameter
1.96 + */
1.97 + IMPORT_C const TDesC8& EventPackage() const;
1.98 +
1.99 + /**
1.100 + * Sets the Event-Package parameter in the "Event" header;
1.101 + * @param aEventPackage a Event-Package parameter to set
1.102 + */
1.103 + IMPORT_C void SetEventPackageL(const TDesC8& aEventPackage);
1.104 +
1.105 + /**
1.106 + * Sets the event templates overwriting all the existing ones.
1.107 + * @param aEventTemplates an array of event templates
1.108 + */
1.109 + IMPORT_C void SetEventTemplatesL(const MDesC8Array& aEventTemplates);
1.110 +
1.111 + /**
1.112 + * Gets the event templates.
1.113 + * @return a reference to the currently set event templates.
1.114 + */
1.115 + IMPORT_C const MDesC8Array& EventTemplates() const;
1.116 +
1.117 + /**
1.118 + * Constructs an instance of a CSIPEventHeader from a RReadStream
1.119 + * @param aReadStream a stream containing the value of the
1.120 + * externalized object (header name not included).
1.121 + * @return an instance of a CSIPEventHeader
1.122 + */
1.123 + IMPORT_C static CSIPHeaderBase*
1.124 + InternalizeValueL(RReadStream& aReadStream);
1.125 +
1.126 +
1.127 + public: // From CSIPHeaderBase
1.128 +
1.129 + /**
1.130 + * From CSIPHeaderBase CloneL
1.131 + */
1.132 + IMPORT_C CSIPHeaderBase* CloneL() const;
1.133 +
1.134 + /**
1.135 + * From CSIPHeaderBase Name
1.136 + */
1.137 + IMPORT_C RStringF Name() const;
1.138 +
1.139 +
1.140 + public: // From CSIPHeaderBase, for internal use
1.141 +
1.142 + /**
1.143 + * @internalComponent
1.144 + */
1.145 + TBool HasCompactName() const;
1.146 +
1.147 + /**
1.148 + * @internalComponent
1.149 + */
1.150 + RStringF CompactName() const;
1.151 +
1.152 + /**
1.153 + * @internalComponent
1.154 + */
1.155 + TPreferredPlace PreferredPlaceInMessage() const;
1.156 +
1.157 + public: // New functions, for internal use
1.158 +
1.159 + static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
1.160 +
1.161 + private: // From CSIPHeaderBase
1.162 +
1.163 + void ExternalizeValueL(RWriteStream& aWriteStream) const;
1.164 +
1.165 + private: // From CSIPParameterHeaderBase
1.166 +
1.167 + HBufC8* ToTextMandatoryPartLC() const;
1.168 + void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
1.169 + const CSIPParamContainerBase& Params() const;
1.170 + CSIPParamContainerBase& Params();
1.171 +
1.172 + private: // Constructors
1.173 +
1.174 + CSIPEventHeader();
1.175 + void ConstructL();
1.176 + void ConstructL(const TDesC8& aEventPackage);
1.177 + void ConstructL(const CSIPEventHeader& aSIPEventHeader);
1.178 +
1.179 + private: // New functions
1.180 +
1.181 + void DoInternalizeValueL(RReadStream& aReadStream);
1.182 + void CheckTemplateL(const TDesC8& aParam) const;
1.183 + // Needed for cleanup of a RPointerArray<HBufC8>:
1.184 + static void ResetAndDestroy(TAny* anArray);
1.185 +
1.186 + private: // Data
1.187 +
1.188 + HBufC8* iEventPackage;
1.189 + CSIPEventHeaderParams* iParams;
1.190 + CDesC8ArraySeg* iEventTemplates;
1.191 +
1.192 + private: // For testing purposes
1.193 +
1.194 + UNIT_TEST(CSIPEventHeaderTest)
1.195 + };
1.196 +
1.197 +#endif // CSIPEVENTHEADER_H
1.198 +
1.199 +// End of File