Msrp/MsrpHeader/inc/CMsrpStatusHeader.h
author Petteri Saari <petteri.saari@digia.com>
Fri, 26 Nov 2010 12:09:49 +0200
branchMSRP_FrameWork
changeset 59 b365c991829c
parent 58 cdb720e67852
permissions -rw-r--r--
Some comments changed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
58
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
     1
/*
59
b365c991829c Some comments changed
Petteri Saari <petteri.saari@digia.com>
parents: 58
diff changeset
     2
* Copyright (c) 2009-2010 Nokia Corporation and/or its subsidiary(-ies).
b365c991829c Some comments changed
Petteri Saari <petteri.saari@digia.com>
parents: 58
diff changeset
     3
* All rights reserved.
b365c991829c Some comments changed
Petteri Saari <petteri.saari@digia.com>
parents: 58
diff changeset
     4
* This component and the accompanying materials are made available
b365c991829c Some comments changed
Petteri Saari <petteri.saari@digia.com>
parents: 58
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
b365c991829c Some comments changed
Petteri Saari <petteri.saari@digia.com>
parents: 58
diff changeset
     6
* which accompanies this distribution, and is available
b365c991829c Some comments changed
Petteri Saari <petteri.saari@digia.com>
parents: 58
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html."
b365c991829c Some comments changed
Petteri Saari <petteri.saari@digia.com>
parents: 58
diff changeset
     8
* Initial Contributors:
b365c991829c Some comments changed
Petteri Saari <petteri.saari@digia.com>
parents: 58
diff changeset
     9
* Nokia Corporation - initial contribution.
b365c991829c Some comments changed
Petteri Saari <petteri.saari@digia.com>
parents: 58
diff changeset
    10
* Contributors:
58
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    11
*
59
b365c991829c Some comments changed
Petteri Saari <petteri.saari@digia.com>
parents: 58
diff changeset
    12
* Description:
b365c991829c Some comments changed
Petteri Saari <petteri.saari@digia.com>
parents: 58
diff changeset
    13
* MSRP Implementation
b365c991829c Some comments changed
Petteri Saari <petteri.saari@digia.com>
parents: 58
diff changeset
    14
*
58
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    15
*/
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    16
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    17
#ifndef CMSRPSTATUSHEADER_H
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    18
#define CMSRPSTATUSHEADER_H
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    19
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    20
//  INCLUDES
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    21
#include "CMsrpHeaderBase.h"
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    22
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    23
// CONSTANTS
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    24
const TInt KMaxLengthOfStatusCodeValue = 100;
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    25
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    26
// CLASS DECLARATION
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    27
/**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    28
* @publishedAll
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    29
*
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    30
* Class provides functions for setting and getting MSRP "Status" header field
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    31
*
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    32
* @lib msrpclient.lib
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    33
*/
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    34
class CMSRPStatusHeader : public CMSRPHeaderBase
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    35
	{
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    36
	public:	// Constructors and destructor
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    37
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    38
		/**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    39
		* Creates a new instance of CMSRMessageIdHeader
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    40
		* @param aStatusCode status code
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    41
		* @return a new instance of CMSRPStatusHeader
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    42
		*/
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    43
		IMPORT_C static CMSRPStatusHeader* NewL( TInt aStatusCode );
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    44
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    45
		/**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    46
		* Creates a new instance of CMSRPStatusHeader and puts it to CleanupStack
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    47
		* @param aStatusCode status code
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    48
		* @return a new instance of CMSRPStatusHeader
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    49
		*/
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    50
		IMPORT_C static CMSRPStatusHeader* NewLC( TInt aStatusCode );
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    51
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    52
		/**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    53
		* Creates a new instance of CMSRMessageIdHeader
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    54
		* @return a new instance of CMSRPStatusHeader
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    55
		*/
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    56
		static CMSRPStatusHeader* NewL( );
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    57
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    58
		/**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    59
		* Destructor, deletes the resources of CMSRPStatusHeader.
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    60
		*/
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    61
		IMPORT_C ~CMSRPStatusHeader();
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    62
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    63
	public: // New functions
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    64
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    65
		/**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    66
		* Constructs an instance of a CMSRPStatusHeader from a RReadStream
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    67
		* @param aReadStream a stream containing the value of the
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    68
		*        externalized object (header name not included).
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    69
		* @return an instance of a CMSRPStatusHeader
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    70
		*/
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    71
		IMPORT_C static CMSRPStatusHeader*
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    72
			InternalizeValueL( RReadStream& aReadStream );
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    73
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    74
		/**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    75
		* Sets the status code value
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    76
		* @param aStatusCode status code
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    77
		*/
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    78
		IMPORT_C void SetStatusCode( TInt aStartPos );
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    79
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    80
		/**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    81
		* Gets the status code value
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    82
		*/
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    83
		IMPORT_C TInt StatusCode( ) const;
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    84
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    85
	public: // From CMSRPHeaderBase
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    86
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    87
		IMPORT_C void ExternalizeValueL( RWriteStream& aWriteStream ) const;
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    88
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    89
	public: // From CMSRPHeaderBase
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    90
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    91
		RStringF Name() const;
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    92
		HBufC8* ToTextValueL() const;
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    93
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    94
	private: // Constructors
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    95
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    96
        /**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    97
        * Contructor.
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    98
        */
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    99
		CMSRPStatusHeader( );
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   100
        /**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   101
        * Contructor.
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   102
		* @param aStatusCode status code
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   103
        */
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   104
		CMSRPStatusHeader( TInt aStatusCode );
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   105
        /**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   106
        * two-phased contructor.
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   107
        */
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   108
        void ConstructL( ) const;
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   109
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   110
	private: // new functions
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   111
	    /**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   112
		* Internalize external object data
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   113
		* @param aReadStream a stream containing the value of the
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   114
		*        externalized object (header name not included).
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   115
		*/
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   116
		void DoInternalizeValueL( RReadStream& aReadStream );
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   117
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   118
  	private: // variables
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   119
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   120
		// status code value
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   121
		TInt iStatusCode;
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   122
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   123
	__DECLARE_TEST;
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   124
	};
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   125
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   126
#endif // CMSRPSTATUSHEADER_H
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   127
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
   128
// End of File