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