epoc32/include/sipcontentencodingheader.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
     1 /*
     2 * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     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
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:
    15 * Name        : sipcontentencodingheader.h
    16 * Part of     : SIP Codec
    17 * Interface   : SDK API, SIP Codec API
    18 * Version     : SIP/4.0 
    19 *
    20 */
    21 
    22 
    23 
    24 
    25 #ifndef CSIPCONTENTENCODINGHEADER_H
    26 #define CSIPCONTENTENCODINGHEADER_H
    27 
    28 //  INCLUDES
    29 #include "siptokenheaderbase.h"
    30 #include "_sipcodecdefs.h"
    31 
    32 // CLASS DECLARATION
    33 /**
    34 * @publishedAll
    35 * @released
    36 *
    37 * Class provides functions for setting and getting parameters 
    38 * in SIP "Content-Encoding" header.
    39 *
    40 *  @lib sipcodec.lib
    41 */
    42 class CSIPContentEncodingHeader : public CSIPTokenHeaderBase
    43 	{
    44 	public:	// Constructors and destructor
    45 
    46 		/**
    47 		* Constructs a CSIPContentEncodingHeader from textual representation
    48 		* of the header's value part.
    49 		* @param aValue a value part of a "Content-Encoding"-header
    50 		* @return an array containing 1..n instances of 
    51 		*         CSIPContentEncodingHeader
    52 		*/
    53 		IMPORT_C static RPointerArray<CSIPContentEncodingHeader> 
    54 			DecodeL(const TDesC8& aValue);
    55 
    56 		/**
    57 		* Creates a new instance of CSIPContentEncodingHeader
    58 		* @param aValue a content-coding value 
    59 		* @return a new instance of CSIPContentEncodingHeader
    60 		*/
    61 		IMPORT_C static CSIPContentEncodingHeader* NewL(RStringF aValue);
    62 
    63 		/**
    64 		* Creates a new instance of CSIPContentEncodingHeader 
    65 		* and puts it to CleanupStack
    66 		* @param aValue a content-coding value
    67 		* @return a new instance of CSIPContentEncodingHeader
    68 		*/
    69 		IMPORT_C static CSIPContentEncodingHeader* NewLC(RStringF aValue);
    70 
    71 		/**
    72 		* Destructor, deletes the resources of CSIPContentEncodingHeader.
    73 		*/
    74 		IMPORT_C ~CSIPContentEncodingHeader();
    75 
    76 
    77 	public: // New functions
    78 
    79 		/**
    80 		* Constructs an instance of a CSIPContentEncodingHeader 
    81 		* from a RReadStream
    82 		* @param aReadStream a stream containing the value of the
    83 		*        externalized object (header name not included).
    84 		* @return an instance of a CSIPContentEncodingHeader
    85 		*/
    86 
    87 		IMPORT_C static CSIPHeaderBase* 
    88 			InternalizeValueL(RReadStream& aReadStream);
    89 
    90 
    91 	public: // From CSIPHeaderBase
    92 
    93 		/**
    94 		* From CSIPHeaderBase CloneL
    95 		*/
    96 		IMPORT_C CSIPHeaderBase* CloneL() const;
    97 
    98 		/**
    99 		* From CSIPHeaderBase Name
   100 		*/
   101 		IMPORT_C RStringF Name() const;
   102 
   103 
   104 	public: // From CSIPHeaderBase, for internal use
   105 
   106         /**
   107         * @internalComponent
   108         */
   109 		TBool HasCompactName() const;
   110 		
   111         /**
   112         * @internalComponent
   113         */		
   114 		RStringF CompactName() const;
   115 		
   116         /**
   117         * @internalComponent
   118         */		
   119 		TPreferredPlace PreferredPlaceInMessage() const;
   120 
   121 	public: // New functions, for internal use
   122 
   123 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
   124 
   125 	private: // Constructors
   126 
   127 		CSIPContentEncodingHeader();
   128 		CSIPContentEncodingHeader(const CSIPContentEncodingHeader& aHeader);
   129 		};
   130 
   131 #endif // CSIPCONTENTENCODINGHEADER_H
   132 
   133 // End of File