Msrp/MsrpHeader/inc/CMsrpReport.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 CMSRPREPORT_H
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    18
#define CMSRPREPORT_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 <e32base.h>
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    22
#include <s32strm.h>
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    23
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    24
#include "CMSRPMessageBase.h"
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
/**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    29
*  @publishedAll
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    30
*
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    31
*  Class provides functions for creation and manipulation of MSRP headers
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    32
*/
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    33
class CMSRPReport : public CMSRPMessageBase
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    34
    {
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    35
    public:  // Constructors and destructor
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    36
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
        * Constructor.
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    39
        */
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    40
	    IMPORT_C CMSRPReport();
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    41
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
        * Destructor.
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
		IMPORT_C ~CMSRPReport();
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    46
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    47
    public: // New functions
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    48
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
		* Check if the given externalised buffer contains MSRP Report
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    51
 		* @param aBuffer a Buffer containing the value of the
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    52
		*        externalized object
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    53
		* @return true if Buffer contains MSRP report
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    54
		*/
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    55
		IMPORT_C static TBool IsReport( const TDesC8& aBuffer );
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    56
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
		* Internalizes the class from given stream
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    59
 		* @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
    60
		*        externalized object
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    61
		* @return Internalized CMSRPReport object, ownership is transferred
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
		IMPORT_C static CMSRPReport* InternalizeL( RReadStream& aReadStream );
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
	public: // from base classes
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    66
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    67
		// from CMSRPMessageBase
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    68
		IMPORT_C void ExternalizeL( RWriteStream& aWriteStream );
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    69
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    70
    private:
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    71
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    72
        /**
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    73
        * Internalizes this message
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    74
 		* @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
    75
		*        externalized object (header name not included).
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    76
        */
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    77
	    void DoInternalizeL( RReadStream& aReadStream  );
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    78
	};
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
#endif // CMSRPREPORT_H
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    81
cdb720e67852 This release addresses the following issues:
Petteri Saari <petteri.saari@digia.com>
parents:
diff changeset
    82
// End of File