epoc32/include/mw/sipexpiresheader.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
equal deleted inserted replaced
2:2fe1408b6811 3:e1b950c65cb4
       
     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        : sipexpiresheader.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 CSIPEXPIRESHEADER_H
       
    26 #define CSIPEXPIRESHEADER_H
       
    27 
       
    28 //  INCLUDES
       
    29 #include "sipunsignedintheaderbase.h"
       
    30 #include "_sipcodecdefs.h"
       
    31 
       
    32 // CLASS DECLARATION
       
    33 /**
       
    34 * @publishedAll
       
    35 * @released
       
    36 *
       
    37 * Class encapsulates a "Expires" header value.
       
    38 *
       
    39 *  @lib sipcodec.lib
       
    40 */
       
    41 class CSIPExpiresHeader : public CSIPUnsignedIntHeaderBase
       
    42 	{
       
    43 	public:	// Constructors and destructor
       
    44 
       
    45 		/**
       
    46 		* Constructs a CSIPExpiresHeader from textual representation 
       
    47 		* of the header's value part.
       
    48 		* @param aValue a value part of a "Expires"-header (e.g. "3600")
       
    49 		* @return a new instance of CSIPExpiresHeader
       
    50 		*/
       
    51 		IMPORT_C static CSIPExpiresHeader* DecodeL(const TDesC8& aValue);
       
    52 	
       
    53 		/**
       
    54 		* Constructor
       
    55 		* @param aValue the value to set
       
    56 		*/
       
    57 		IMPORT_C CSIPExpiresHeader(TUint aValue);
       
    58 	
       
    59 		/**
       
    60 		* Destructor, deletes the resources of CSIPExpiresHeader.
       
    61 		*/
       
    62 		IMPORT_C ~CSIPExpiresHeader();
       
    63 
       
    64 
       
    65 	public: // New functions
       
    66 
       
    67 		/**
       
    68 		* Constructs an instance of a CSIPExpiresHeader from a RReadStream
       
    69 		* @param aReadStream a stream containing the value of the
       
    70 		*        externalized header object (header name not included).
       
    71 		* @return an instance of a CSIPExpiresHeader
       
    72 		*/
       
    73 		IMPORT_C static CSIPHeaderBase* 
       
    74 			InternalizeValueL(RReadStream& aReadStream);
       
    75 
       
    76 
       
    77 	public: // From CSIPHeaderBase
       
    78 
       
    79 		/**
       
    80 		* From CSIPHeaderBase CloneL
       
    81 		*/
       
    82 		IMPORT_C CSIPHeaderBase* CloneL() const;
       
    83 
       
    84 		/**
       
    85 		* From CSIPHeaderBase Name
       
    86 		*/
       
    87 		IMPORT_C RStringF Name() const;
       
    88 
       
    89 
       
    90 	public: // From CSIPHeaderBase, for internal use
       
    91 
       
    92         /**
       
    93         * @internalComponent
       
    94         */
       
    95 		TPreferredPlace PreferredPlaceInMessage() const;
       
    96 
       
    97 	public: // New functions, for internal use
       
    98 
       
    99 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
       
   100 
       
   101 	private: // For testing purposes
       
   102 	
       
   103 		UNIT_TEST(CSIPExpiresHeaderTest)
       
   104 	};
       
   105 
       
   106 #endif // CSIPEXPIRESHEADER_H
       
   107 
       
   108 // End of File