epoc32/include/sipunsignedintheaderbase.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
equal deleted inserted replaced
1:666f914201fb 2:2fe1408b6811
     1 sipunsignedintheaderbase.h
     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        : sipunsignedintheaderbase.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 CSIPUNSIGNEDINTHEADERBASE_H
       
    26 #define CSIPUNSIGNEDINTHEADERBASE_H
       
    27 
       
    28 //  INCLUDES
       
    29 #include "sipheaderbase.h"
       
    30 #include "_sipcodecdefs.h"
       
    31 
       
    32 
       
    33 // CLASS DECLARATION
       
    34 /**
       
    35 * @publishedAll
       
    36 * @released
       
    37 *
       
    38 * A base class for SIP headers having form: "Name: 1*DIGIT"
       
    39 *
       
    40 * @lib sipcodec.lib
       
    41 */
       
    42 class CSIPUnsignedIntHeaderBase : public CSIPHeaderBase
       
    43 	{
       
    44 	public:	// Constructors and destructor
       
    45 
       
    46 		/**
       
    47 		* Destructor, deletes the resources of CSIPUnsignedIntHeaderBase.
       
    48 		*/
       
    49 		IMPORT_C virtual ~CSIPUnsignedIntHeaderBase();
       
    50 
       
    51 
       
    52 	public: // New functions
       
    53 
       
    54 		/**
       
    55 		* Sets the header value as an unsigned integer 
       
    56 		* @param aValue a value to set
       
    57 		*/
       
    58 		IMPORT_C void SetValue(TUint aValue);
       
    59 	
       
    60 		/**
       
    61 		* Gets the header value as an unsigned integer 
       
    62 		* @return the header value
       
    63 		*/
       
    64 		IMPORT_C TUint Value() const;
       
    65 
       
    66 
       
    67 	public: // From CSIPHeaderBase
       
    68 
       
    69 		/**
       
    70 		* From CSIPHeaderBase ToTextValueL
       
    71 		*/
       
    72 		IMPORT_C HBufC8* ToTextValueL() const;
       
    73 
       
    74 
       
    75 	protected: // Constructors
       
    76 
       
    77 		CSIPUnsignedIntHeaderBase();
       
    78 		CSIPUnsignedIntHeaderBase(TUint aValue);
       
    79 
       
    80 	protected: // New functions
       
    81 
       
    82 		void ParseL(const TDesC8& aValue, TInt aErrorIfParsingFails);
       
    83 		void DoInternalizeValueL(RReadStream& aReadStream);
       
    84 
       
    85 	protected: // From CSIPHeaderBase
       
    86 
       
    87         /**
       
    88         * @internalComponent
       
    89         */
       
    90 		void ExternalizeValueL (RWriteStream& aWriteStream) const;
       
    91 
       
    92 	protected: // Data
       
    93 
       
    94         /**
       
    95         * @internalComponent
       
    96         */	
       
    97 		TUint iValue;
       
    98 	};
       
    99 
       
   100 #endif // CSIPUNSIGNEDINTHEADERBASE_H
       
   101 
       
   102 // End of File