Msrp/MsrpHeader/inc/CMsrpSuccessReportHeader.h
branchMSRP_FrameWork
changeset 25 505ad3f0ce5c
equal deleted inserted replaced
22:f1578314b8da 25:505ad3f0ce5c
       
     1 /*
       
     2 * Copyright (c) 2009-2010 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 * Initial Contributors:
       
     9 * Nokia Corporation - initial contribution.
       
    10 * Contributors:
       
    11 *
       
    12 * Description:
       
    13 * MSRP Implementation
       
    14 *
       
    15 */
       
    16 
       
    17 
       
    18 #ifndef CMSRPSUCCESSREPORTHEADER_H
       
    19 #define CMSRPSUCCESSREPORTHEADER_H
       
    20 
       
    21 //  INCLUDES
       
    22 #include "CMsrpHeaderBase.h"
       
    23 
       
    24 // CLASS DECLARATION
       
    25 /**
       
    26 * @publishedAll
       
    27 *
       
    28 * Class provides functions for setting and getting MSRP "Success-Report" header field
       
    29 *
       
    30 * @lib msrpcodec.lib
       
    31 */
       
    32 class CMSRPSuccessReportHeader : public CMSRPHeaderBase
       
    33 	{
       
    34 	public:	// Constructors and destructor
       
    35 
       
    36 		/**
       
    37 		* Creates a new instance of CMSRSuccessReportHeader
       
    38 		* @param aType type of the content
       
    39 		* @return a new instance of CMSRPSuccessReportHeader
       
    40 		*/
       
    41 		IMPORT_C static CMSRPSuccessReportHeader* NewL( const RStringF& aType );
       
    42 
       
    43 		/**
       
    44 		* Creates a new instance of CMSRPSuccessReportHeader and puts it to CleanupStack
       
    45 		* @param aType type of the content
       
    46 		* @return a new instance of CMSRPSuccessReportHeader
       
    47 		*/
       
    48 		IMPORT_C static CMSRPSuccessReportHeader* NewLC( const RStringF& aType );
       
    49 
       
    50 		/**
       
    51 		* Creates a new instance of CMSRSuccessReportHeader
       
    52 		* @return a new instance of CMSRPSuccessReportHeader
       
    53 		*/
       
    54 		static CMSRPSuccessReportHeader* NewL( );
       
    55 
       
    56 		/**
       
    57 		* Destructor, deletes the resources of CMSRPSuccessReportHeader.
       
    58 		*/
       
    59 		IMPORT_C ~CMSRPSuccessReportHeader();
       
    60 
       
    61 
       
    62 	public: // New functions
       
    63 
       
    64 		/**
       
    65 		* Constructs an instance of a CMSRPSuccessReportHeader from a RReadStream
       
    66 		* @param aReadStream a stream containing the value of the
       
    67 		*        externalized object (header name not included).
       
    68 		* @return an instance of a CMSRPSuccessReportHeader
       
    69 		*/
       
    70 		IMPORT_C static CMSRPSuccessReportHeader*
       
    71 			InternalizeValueL( RReadStream& aReadStream );
       
    72 
       
    73 
       
    74 	public: // From CMSRPHeaderBase
       
    75 
       
    76 		IMPORT_C void ExternalizeValueL( RWriteStream& aWriteStream ) const;
       
    77 
       
    78 	public: // From CMSRPHeaderBase
       
    79 
       
    80 		RStringF Name() const;
       
    81 		HBufC8* ToTextValueL() const;
       
    82 
       
    83 	private: // Constructors
       
    84 
       
    85 		/**
       
    86 		* Creates a new instance of CMSRSuccessReportHeader
       
    87 		* @param aType type of the content
       
    88 		*/
       
    89         void ConstructL( RStringF aType );
       
    90 
       
    91 		/**
       
    92 		* Creates a new instance of CMSRSuccessReportHeader
       
    93 		*/
       
    94         void ConstructL( );
       
    95 
       
    96 		/**
       
    97 		* Constructor
       
    98 		*/
       
    99 		CMSRPSuccessReportHeader();
       
   100 
       
   101 	private: // new functions
       
   102 		void DoInternalizeValueL( RReadStream& aReadStream );
       
   103 
       
   104   	private: // variables
       
   105 
       
   106 		// value as a string
       
   107 		RStringF iReportType;
       
   108 
       
   109 	};
       
   110 
       
   111 #endif // CMSRPSUCCESSREPORTHEADER_H
       
   112 
       
   113 // End of File