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