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