1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/sipcontentdispositionheader.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,165 @@
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 : sipcontentdispositionheader.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 CSIPCONTENTDISPOSITIONHEADER_H
1.29 +#define CSIPCONTENTDISPOSITIONHEADER_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 CSIPHeaderGenericParams;
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
1.44 +* SIP "Content-Disposition" header.
1.45 +*
1.46 +* @lib sipcodec.lib
1.47 +*/
1.48 +class CSIPContentDispositionHeader : public CSIPParameterHeaderBase
1.49 + {
1.50 + public: // Constructors and destructor
1.51 +
1.52 + /**
1.53 + * Constructs a CSIPContentDispositionHeader from textual representation
1.54 + * of the header's value part.
1.55 + * @param aValue a value part of a "Content-Disposition"-header
1.56 + * @return a new instance of CSIPContentDispositionHeader
1.57 + */
1.58 + IMPORT_C static CSIPContentDispositionHeader*
1.59 + DecodeL (const TDesC8& aValue);
1.60 +
1.61 + /**
1.62 + * Creates a new instance of CSIPContentDispositionHeader
1.63 + * @param aDispType a Disp-Type value
1.64 + * @return a new instance of CSIPContentDispositionHeader
1.65 + */
1.66 + IMPORT_C static CSIPContentDispositionHeader*
1.67 + NewL(const TDesC8& aDispType);
1.68 +
1.69 + /**
1.70 + * Creates a new instance of CSIPContentDispositionHeader
1.71 + * and puts it to CleanupStack
1.72 + * @param aDispType a Disp-Type value
1.73 + * @return a new instance of CSIPContentDispositionHeader
1.74 + */
1.75 + IMPORT_C static CSIPContentDispositionHeader*
1.76 + NewLC(const TDesC8& aDispType);
1.77 +
1.78 + /**
1.79 + * Destructor. deletes the resources of CSIPContentDispositionHeader.
1.80 + */
1.81 + IMPORT_C ~CSIPContentDispositionHeader();
1.82 +
1.83 +
1.84 + public: // New functions
1.85 +
1.86 + /**
1.87 + * Gets the disp-type parameter from the "Content-Disposition" header
1.88 + * @return the disp-type parameter
1.89 + */
1.90 + IMPORT_C const TDesC8& DispType() const;
1.91 +
1.92 + /**
1.93 + * Sets the disp-type parameter in the "Content-Disposition" header;
1.94 + * @param aTag a disp-type parameter to set
1.95 + */
1.96 + IMPORT_C void SetDispTypeL(const TDesC8& aDispType);
1.97 +
1.98 + /**
1.99 + * Constructs an instance of a CSIPContentDispositionHeader
1.100 + * from a RReadStream
1.101 + * @param aReadStream a stream containing the value of the
1.102 + * externalized object (header name not included).
1.103 + * @return an instance of a CSIPContentDispositionHeader
1.104 + */
1.105 + IMPORT_C static CSIPHeaderBase*
1.106 + InternalizeValueL(RReadStream& aReadStream);
1.107 +
1.108 +
1.109 + public: // From CSIPHeaderBase
1.110 +
1.111 + /**
1.112 + * From CSIPHeaderBase CloneL
1.113 + */
1.114 + IMPORT_C CSIPHeaderBase* CloneL() const;
1.115 +
1.116 + /**
1.117 + * From CSIPHeaderBase Name
1.118 + */
1.119 + IMPORT_C RStringF Name() const;
1.120 +
1.121 +
1.122 + public: // From CSIPHeaderBase, for internal use
1.123 +
1.124 + /**
1.125 + * @internalComponent
1.126 + */
1.127 + TPreferredPlace PreferredPlaceInMessage() const;
1.128 +
1.129 + public: // New functions, for internal use
1.130 +
1.131 + static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
1.132 +
1.133 + private: // From CSIPHeaderBase
1.134 +
1.135 + void ExternalizeValueL(RWriteStream& aWriteStream) const;
1.136 +
1.137 + private: // From CSIPParameterHeaderBase
1.138 +
1.139 + HBufC8* ToTextMandatoryPartLC() const;
1.140 + void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
1.141 + const CSIPParamContainerBase& Params() const;
1.142 + CSIPParamContainerBase& Params();
1.143 +
1.144 + private: // Constructors
1.145 +
1.146 + CSIPContentDispositionHeader();
1.147 + void ConstructL();
1.148 + void ConstructL(const TDesC8& aDispType);
1.149 + void ConstructL(const TDesC8& aDispType, const TDesC8& aHandlingParam);
1.150 + void ConstructL(const CSIPContentDispositionHeader& aHeader);
1.151 +
1.152 + private: // New functions
1.153 +
1.154 + void DoInternalizeValueL(RReadStream& aReadStream);
1.155 +
1.156 + private: // Data
1.157 +
1.158 + HBufC8* iDispType;
1.159 + CSIPHeaderGenericParams* iParams;
1.160 +
1.161 + private: // For testing purposes
1.162 +
1.163 + UNIT_TEST(CSIPContentDispositionHeaderTest)
1.164 + };
1.165 +
1.166 +#endif // CSIPCONTENTDISPOSITIONHEADER_H
1.167 +
1.168 +// End of File