epoc32/include/sipcontenttypeheader.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* 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
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:
williamr@2
    15
* Name        : sipcontenttypeheader.h
williamr@2
    16
* Part of     : SIP Codec
williamr@2
    17
* Interface   : SDK API, SIP Codec API
williamr@2
    18
* Version     : SIP/4.0 
williamr@2
    19
*
williamr@2
    20
*/
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
williamr@2
    25
#ifndef CSIPCONTENTTYPEHEADER_H
williamr@2
    26
#define CSIPCONTENTTYPEHEADER_H
williamr@2
    27
williamr@2
    28
//  INCLUDES
williamr@2
    29
#include "sipparameterheaderbase.h"
williamr@2
    30
#include "_sipcodecdefs.h"
williamr@2
    31
williamr@2
    32
// FORWARD DECLARATIONS
williamr@2
    33
class CSIPContentTypeHeaderParams;
williamr@2
    34
williamr@2
    35
// CLASS DECLARATION
williamr@2
    36
/**
williamr@2
    37
* @publishedAll
williamr@2
    38
* @released
williamr@2
    39
*
williamr@2
    40
* Class provides functions for setting and getting media types and
williamr@2
    41
* parameters in SIP "Content-Type" header.
williamr@2
    42
*
williamr@2
    43
*  @lib sipcodec.lib
williamr@2
    44
*/
williamr@2
    45
class CSIPContentTypeHeader : public CSIPParameterHeaderBase
williamr@2
    46
	{
williamr@2
    47
	public:	// Constructors and destructor
williamr@2
    48
williamr@2
    49
		/**
williamr@2
    50
		* Constructs a CSIPContentTypeHeader from textual representation 
williamr@2
    51
		* of the header's value part.
williamr@2
    52
		* @param aValue a value part of a "Content-Type"-header
williamr@2
    53
		* @return a new instance of CSIPContentTypeHeader
williamr@2
    54
		*/
williamr@2
    55
		IMPORT_C static CSIPContentTypeHeader* DecodeL(const TDesC8& aValue);
williamr@2
    56
williamr@2
    57
		/**
williamr@2
    58
		* Creates a new instance of CSIPContentTypeHeader
williamr@2
    59
		* @param aMediaType a media type to set. For example "application"
williamr@2
    60
		* @param aMediaSubtype a media subtype to set. For example "sdp"
williamr@2
    61
		* @return a new instance of CSIPContentTypeHeader
williamr@2
    62
		*/
williamr@2
    63
		IMPORT_C static CSIPContentTypeHeader* 
williamr@2
    64
			NewL(const TDesC8& aMediaType, const TDesC8& aMediaSubtype);
williamr@2
    65
williamr@2
    66
		/**
williamr@2
    67
		* Creates a new instance of CSIPContentTypeHeader 
williamr@2
    68
		* and puts it onto the cleanup stack
williamr@2
    69
		* @param aMediaType a media type to set. For example "application"
williamr@2
    70
		* @param aMediaSubtype a media subtype to set. For example "sdp"
williamr@2
    71
		* @return a new instance of CSIPContentTypeHeader
williamr@2
    72
		*/
williamr@2
    73
		IMPORT_C static CSIPContentTypeHeader* 
williamr@2
    74
			NewLC(const TDesC8& aMediaType, const TDesC8& aMediaSubtype);
williamr@2
    75
williamr@2
    76
		/**
williamr@2
    77
		* Destructor, deletes the resources of CSIPContentTypeHeader.
williamr@2
    78
		*/
williamr@2
    79
		IMPORT_C ~CSIPContentTypeHeader();
williamr@2
    80
williamr@2
    81
	public: // New functions
williamr@2
    82
williamr@2
    83
		/**
williamr@2
    84
		* Gets the media type from the "Content-Type" header
williamr@2
    85
		* @return a media type
williamr@2
    86
		*/
williamr@2
    87
		IMPORT_C const TDesC8& MediaType() const;
williamr@2
    88
williamr@2
    89
		/**
williamr@2
    90
		* Sets the media type in the "Content-Type" header
williamr@2
    91
		* @param aMediaType a media type
williamr@2
    92
		*/
williamr@2
    93
		IMPORT_C void SetMediaTypeL(const TDesC8& aMediaType);
williamr@2
    94
williamr@2
    95
		/**
williamr@2
    96
		* Gets the media subtype from the "Content-Type" header
williamr@2
    97
		* @return a media subtype
williamr@2
    98
		*/
williamr@2
    99
		IMPORT_C const TDesC8& MediaSubtype() const;
williamr@2
   100
williamr@2
   101
		/**
williamr@2
   102
		* Sets the media subtype in the "Content-Type" header
williamr@2
   103
		* @param aMediaSubtype a media subtype
williamr@2
   104
		*/
williamr@2
   105
		IMPORT_C void SetMediaSubtypeL(const TDesC8& aMediaSubtype);
williamr@2
   106
williamr@2
   107
		/**
williamr@2
   108
		* Constructs an instance of a CSIPContentTypeHeader from a RReadStream
williamr@2
   109
		* @param aReadStream a stream containing the value of the
williamr@2
   110
		*        externalized header object (header name not included).
williamr@2
   111
		* @return an instance of a CSIPContentTypeHeader
williamr@2
   112
		*/
williamr@2
   113
williamr@2
   114
		IMPORT_C static CSIPHeaderBase* 
williamr@2
   115
			InternalizeValueL(RReadStream& aReadStream);
williamr@2
   116
williamr@2
   117
williamr@2
   118
	public: // From CSIPHeaderBase
williamr@2
   119
williamr@2
   120
		/**
williamr@2
   121
		* From CSIPHeaderBase CloneL
williamr@2
   122
		*/
williamr@2
   123
		IMPORT_C CSIPHeaderBase* CloneL() const;
williamr@2
   124
williamr@2
   125
		/**
williamr@2
   126
		* From CSIPHeaderBase Name
williamr@2
   127
		*/	
williamr@2
   128
		IMPORT_C RStringF Name() const;
williamr@2
   129
williamr@2
   130
williamr@2
   131
	public: // From CSIPHeaderBase, for internal use
williamr@2
   132
williamr@2
   133
        /**
williamr@2
   134
        * @internalComponent
williamr@2
   135
        */
williamr@2
   136
		TBool HasCompactName() const;
williamr@2
   137
		
williamr@2
   138
        /**
williamr@2
   139
        * @internalComponent
williamr@2
   140
        */		
williamr@2
   141
		RStringF CompactName() const;
williamr@2
   142
		
williamr@2
   143
        /**
williamr@2
   144
        * @internalComponent
williamr@2
   145
        */		
williamr@2
   146
		TPreferredPlace PreferredPlaceInMessage() const;
williamr@2
   147
williamr@2
   148
	public: // New functions, for internal use
williamr@2
   149
williamr@2
   150
		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
williamr@2
   151
williamr@2
   152
	private: // From CSIPHeaderBase
williamr@2
   153
williamr@2
   154
		void ExternalizeValueL(RWriteStream& aWriteStream) const;
williamr@2
   155
williamr@2
   156
	private: // CSIPParameterHeaderBase
williamr@2
   157
williamr@2
   158
		HBufC8* ToTextMandatoryPartLC() const;
williamr@2
   159
		void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
williamr@2
   160
		const CSIPParamContainerBase& Params() const;
williamr@2
   161
		CSIPParamContainerBase& Params();
williamr@2
   162
williamr@2
   163
	private: // Constructors
williamr@2
   164
williamr@2
   165
		CSIPContentTypeHeader();
williamr@2
   166
		void ConstructL();
williamr@2
   167
		void ConstructL(const TDesC8& aMediaType, const TDesC8& aMediaSubtype);
williamr@2
   168
		void ConstructL(const CSIPContentTypeHeader& aContentTypeHeader);
williamr@2
   169
williamr@2
   170
	private: // New functions
williamr@2
   171
williamr@2
   172
		void DoInternalizeValueL(RReadStream& aReadStream);
williamr@2
   173
williamr@2
   174
	private: // Data
williamr@2
   175
williamr@2
   176
		HBufC8* iMediaType;
williamr@2
   177
		HBufC8* iMediaSubtype;
williamr@2
   178
		CSIPContentTypeHeaderParams* iParams;
williamr@2
   179
williamr@2
   180
	private: // For testing purposes
williamr@2
   181
	
williamr@2
   182
		UNIT_TEST(CSIPContentTypeHeaderTest)
williamr@2
   183
	};
williamr@2
   184
williamr@2
   185
#endif // CSIPCONTENTTYPEHEADER_H
williamr@2
   186
williamr@2
   187
// End of File