epoc32/include/mw/sipunsignedintheaderbase.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     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 "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.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 
    31 
    32 // CLASS DECLARATION
    33 /**
    34 * @publishedAll
    35 * @released
    36 *
    37 * A base class for SIP headers having form: "Name: 1*DIGIT"
    38 *
    39 * @lib sipcodec.lib
    40 */
    41 class CSIPUnsignedIntHeaderBase : public CSIPHeaderBase
    42 	{
    43 	public:	// Constructors and destructor
    44 
    45 		/**
    46 		* Destructor, deletes the resources of CSIPUnsignedIntHeaderBase.
    47 		*/
    48 		IMPORT_C virtual ~CSIPUnsignedIntHeaderBase();
    49 
    50 
    51 	public: // New functions
    52 
    53 		/**
    54 		* Sets the header value as an unsigned integer 
    55 		* @param aValue a value to set
    56 		*/
    57 		IMPORT_C void SetValue(TUint aValue);
    58 	
    59 		/**
    60 		* Gets the header value as an unsigned integer 
    61 		* @return the header value
    62 		*/
    63 		IMPORT_C TUint Value() const;
    64 
    65 
    66 	public: // From CSIPHeaderBase
    67 
    68 		/**
    69 		* From CSIPHeaderBase ToTextValueL
    70 		*/
    71 		IMPORT_C HBufC8* ToTextValueL() const;
    72 
    73 
    74 	protected: // Constructors
    75 
    76 		CSIPUnsignedIntHeaderBase();
    77 		CSIPUnsignedIntHeaderBase(TUint aValue);
    78 
    79 	protected: // New functions
    80 
    81 		void ParseL(const TDesC8& aValue, TInt aErrorIfParsingFails);
    82 		void DoInternalizeValueL(RReadStream& aReadStream);
    83 
    84 	protected: // From CSIPHeaderBase
    85 
    86         /**
    87         * @internalComponent
    88         */
    89 		void ExternalizeValueL (RWriteStream& aWriteStream) const;
    90 
    91 	protected: // Data
    92 
    93         /**
    94         * @internalComponent
    95         */	
    96 		TUint iValue;
    97 	};
    98 
    99 #endif // CSIPUNSIGNEDINTHEADERBASE_H
   100 
   101 // End of File