1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/sipcontenttypeheader.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,187 @@
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 : sipcontenttypeheader.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 CSIPCONTENTTYPEHEADER_H
1.29 +#define CSIPCONTENTTYPEHEADER_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 CSIPContentTypeHeaderParams;
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 media types and
1.44 +* parameters in SIP "Content-Type" header.
1.45 +*
1.46 +* @lib sipcodec.lib
1.47 +*/
1.48 +class CSIPContentTypeHeader : public CSIPParameterHeaderBase
1.49 + {
1.50 + public: // Constructors and destructor
1.51 +
1.52 + /**
1.53 + * Constructs a CSIPContentTypeHeader from textual representation
1.54 + * of the header's value part.
1.55 + * @param aValue a value part of a "Content-Type"-header
1.56 + * @return a new instance of CSIPContentTypeHeader
1.57 + */
1.58 + IMPORT_C static CSIPContentTypeHeader* DecodeL(const TDesC8& aValue);
1.59 +
1.60 + /**
1.61 + * Creates a new instance of CSIPContentTypeHeader
1.62 + * @param aMediaType a media type to set. For example "application"
1.63 + * @param aMediaSubtype a media subtype to set. For example "sdp"
1.64 + * @return a new instance of CSIPContentTypeHeader
1.65 + */
1.66 + IMPORT_C static CSIPContentTypeHeader*
1.67 + NewL(const TDesC8& aMediaType, const TDesC8& aMediaSubtype);
1.68 +
1.69 + /**
1.70 + * Creates a new instance of CSIPContentTypeHeader
1.71 + * and puts it onto the cleanup stack
1.72 + * @param aMediaType a media type to set. For example "application"
1.73 + * @param aMediaSubtype a media subtype to set. For example "sdp"
1.74 + * @return a new instance of CSIPContentTypeHeader
1.75 + */
1.76 + IMPORT_C static CSIPContentTypeHeader*
1.77 + NewLC(const TDesC8& aMediaType, const TDesC8& aMediaSubtype);
1.78 +
1.79 + /**
1.80 + * Destructor, deletes the resources of CSIPContentTypeHeader.
1.81 + */
1.82 + IMPORT_C ~CSIPContentTypeHeader();
1.83 +
1.84 + public: // New functions
1.85 +
1.86 + /**
1.87 + * Gets the media type from the "Content-Type" header
1.88 + * @return a media type
1.89 + */
1.90 + IMPORT_C const TDesC8& MediaType() const;
1.91 +
1.92 + /**
1.93 + * Sets the media type in the "Content-Type" header
1.94 + * @param aMediaType a media type
1.95 + */
1.96 + IMPORT_C void SetMediaTypeL(const TDesC8& aMediaType);
1.97 +
1.98 + /**
1.99 + * Gets the media subtype from the "Content-Type" header
1.100 + * @return a media subtype
1.101 + */
1.102 + IMPORT_C const TDesC8& MediaSubtype() const;
1.103 +
1.104 + /**
1.105 + * Sets the media subtype in the "Content-Type" header
1.106 + * @param aMediaSubtype a media subtype
1.107 + */
1.108 + IMPORT_C void SetMediaSubtypeL(const TDesC8& aMediaSubtype);
1.109 +
1.110 + /**
1.111 + * Constructs an instance of a CSIPContentTypeHeader from a RReadStream
1.112 + * @param aReadStream a stream containing the value of the
1.113 + * externalized header object (header name not included).
1.114 + * @return an instance of a CSIPContentTypeHeader
1.115 + */
1.116 +
1.117 + IMPORT_C static CSIPHeaderBase*
1.118 + InternalizeValueL(RReadStream& aReadStream);
1.119 +
1.120 +
1.121 + public: // From CSIPHeaderBase
1.122 +
1.123 + /**
1.124 + * From CSIPHeaderBase CloneL
1.125 + */
1.126 + IMPORT_C CSIPHeaderBase* CloneL() const;
1.127 +
1.128 + /**
1.129 + * From CSIPHeaderBase Name
1.130 + */
1.131 + IMPORT_C RStringF Name() const;
1.132 +
1.133 +
1.134 + public: // From CSIPHeaderBase, for internal use
1.135 +
1.136 + /**
1.137 + * @internalComponent
1.138 + */
1.139 + TBool HasCompactName() const;
1.140 +
1.141 + /**
1.142 + * @internalComponent
1.143 + */
1.144 + RStringF CompactName() const;
1.145 +
1.146 + /**
1.147 + * @internalComponent
1.148 + */
1.149 + TPreferredPlace PreferredPlaceInMessage() const;
1.150 +
1.151 + public: // New functions, for internal use
1.152 +
1.153 + static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
1.154 +
1.155 + private: // From CSIPHeaderBase
1.156 +
1.157 + void ExternalizeValueL(RWriteStream& aWriteStream) const;
1.158 +
1.159 + private: // CSIPParameterHeaderBase
1.160 +
1.161 + HBufC8* ToTextMandatoryPartLC() const;
1.162 + void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
1.163 + const CSIPParamContainerBase& Params() const;
1.164 + CSIPParamContainerBase& Params();
1.165 +
1.166 + private: // Constructors
1.167 +
1.168 + CSIPContentTypeHeader();
1.169 + void ConstructL();
1.170 + void ConstructL(const TDesC8& aMediaType, const TDesC8& aMediaSubtype);
1.171 + void ConstructL(const CSIPContentTypeHeader& aContentTypeHeader);
1.172 +
1.173 + private: // New functions
1.174 +
1.175 + void DoInternalizeValueL(RReadStream& aReadStream);
1.176 +
1.177 + private: // Data
1.178 +
1.179 + HBufC8* iMediaType;
1.180 + HBufC8* iMediaSubtype;
1.181 + CSIPContentTypeHeaderParams* iParams;
1.182 +
1.183 + private: // For testing purposes
1.184 +
1.185 + UNIT_TEST(CSIPContentTypeHeaderTest)
1.186 + };
1.187 +
1.188 +#endif // CSIPCONTENTTYPEHEADER_H
1.189 +
1.190 +// End of File