1 /*

     2 * Copyright (c) 2003 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:  Interface for header information of history file

    15 *

    16 */

    17 

    18 

    19 #ifndef __MCALOGGERMESSAGEHEADER_H__

    20 #define __MCALOGGERMESSAGEHEADER_H__

    21 

    22 //INCLUDES

    23 

    24 #include <e32std.h>

    25 #include <e32base.h>

    26 

    27 //FORWARD DECLARATIONS

    28 

    29 class RWriteStream;

    30 

    31 // CLASS DECLARATION

    32 

    33 /**

    34  *  Interface for header information of history file

    35  *

    36  *  @lib CALogger.dll

    37  *  @since 2.1

    38  */

    39 class MCALoggerMessageHeader

    40     {

    41     public:

    42 

    43         /**

    44          * Destructor.

    45          */

    46         virtual ~MCALoggerMessageHeader() {};

    47 

    48     public: // Interface

    49 

    50         /**

    51          * Internalize the contact instance data.

    52          * Used by MCALoggerFactory.

    53          * @since 2.1

    54          * @param aStream The stream into which to internalize

    55          */

    56         virtual void InternalizeL( RReadStream& aStream ) = 0;

    57 

    58         /**

    59          * Externalize the contact instance data.

    60          * Used by CCALoggerWriter

    61          * @since 2.1

    62          * @param aStream The stream into which to externalize

    63          */

    64         virtual void ExternalizeL( RWriteStream& aStream ) const = 0;

    65 

    66         /**

    67          *	Disk space needed for saving message in externalize.

    68          *	@return Memory need in bytes.

    69          */

    70         virtual TInt MessageSizeInBytesL() const = 0;

    71 

    72         /**

    73          *	Get filename

    74          *	@since 2.1

    75          *	@return Real filename

    76          */

    77         virtual const TDesC& FilenameL() = 0;

    78 

    79         /**

    80          *	Set filename

    81          *	@since 2.1

    82          *	@param aFilename Filename to set

    83          */

    84         virtual void SetFilenameL( const TDesC& aFilename ) = 0;

    85 

    86         /**

    87          *	This triggers footer information like time when logging ends.

    88          */

    89         virtual void EndLogging() = 0;

    90     };

    91 

    92 #endif      // __MCALOGGERMESSAGEHEADER_H__

    93 

    94 // End of File