1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/loggingservices/rfilelogger/Logger/inc/RFileLogger.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,137 @@
1.4 +/**
1.5 +* Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +
1.23 +/**
1.24 + @file RFileLogger.h
1.25 +*/
1.26 +
1.27 +#if !(defined __ET_RFILELOGGER_H__)
1.28 +#define __ET_RFILELOGGER_H__
1.29 +
1.30 +#include <e32base.h>
1.31 +
1.32 +const TInt KMaxSizOfTag=128;
1.33 +const TInt KMaxSizOfString = 256;
1.34 +const TInt KMaxFilename = 50;
1.35 +
1.36 +// *** Maintaince warning: the constant designed
1.37 +// used on both server side and client side. Any change shoud be
1.38 +// checked on both side
1.39 +_LIT(KMessageFormat," - %d - %S - %d - ");
1.40 +
1.41 +_LIT(KSeperation," - ");
1.42 +_LIT8(KSeperation8," - ");
1.43 +_LIT(KTagSeperation,"LogFieldsRequiredBeingAddedToAboveLogMessage");
1.44 +_LIT(KTagSeperationEnd,"\t\t\t\t\t\t"); // make them invisible
1.45 +_LIT(KTagSeperation8,"LogFieldsRequiredBeingAddedToAboveLogMessage");
1.46 +_LIT(KTagSeperationEnd8,"\t\t\t\t\t\t"); // make them invisible
1.47 +// *** End of Maintaince warning
1.48 +
1.49 +
1.50 +//#if !(defined __FILELOGGER_UREL)
1.51 +_LIT(KFileLogrerServerName,"RFileLoggerServer");
1.52 +const TInt KMaxLoggerFilePath = 256;
1.53 +const TInt KMaxLoggerLineLength = 512;
1.54 +
1.55 +const TInt KRFileLoggerMajorVersion = 1;
1.56 +const TInt KRFileLoggerMinorVersion = 1;
1.57 +const TInt KRFileLoggerBuildVersion = 1;
1.58 +
1.59 +struct TExtraLogField
1.60 + {
1.61 + TBuf<KMaxSizOfTag> iLogFieldName;
1.62 + TBuf<KMaxSizOfString> iLogFieldValue;
1.63 + };
1.64 +/**
1.65 + * RFileLoggerBody - class to provide internal data for the client side
1.66 + *
1.67 + * This class contains all data members which would otherwise be in the
1.68 + * RFileLogger class. They are instead in this file since that because
1.69 + * CreateSession is a protected member of RSessionBase, so we must derive
1.70 + *from it and provide a means to call this via pass-through inline functions.
1.71 + */
1.72 +class RFileLoggerBody : public RSessionBase
1.73 +{
1.74 +public:
1.75 + inline TInt DoCreateSession(const TDesC& aServer,const TVersion& aVersion,TInt aAsyncMessageSlots);
1.76 + inline TInt DoSendReceive(TInt aFunction,const TIpcArgs& aArgs) const;
1.77 + inline TInt DoSendReceive(TInt aFunction) const;
1.78 +
1.79 +
1.80 +};
1.81 +
1.82 +inline TInt RFileLoggerBody::DoCreateSession(const TDesC& aServer,const TVersion& aVersion,TInt aAsyncMessageSlots)
1.83 + {
1.84 + return CreateSession(aServer,aVersion,aAsyncMessageSlots);
1.85 + }
1.86 +
1.87 +inline TInt RFileLoggerBody::DoSendReceive(TInt aFunction,const TIpcArgs& aArgs) const
1.88 + {
1.89 + return SendReceive(aFunction,aArgs);
1.90 + }
1.91 +
1.92 +inline TInt RFileLoggerBody::DoSendReceive(TInt aFunction) const
1.93 + {
1.94 + return SendReceive(aFunction);
1.95 + }
1.96 +
1.97 +class RFileFlogger
1.98 +/**
1.99 +@internalComponent
1.100 +@test
1.101 +*/
1.102 + {
1.103 +public:
1.104 + enum TLogMode{ELogModeAppend,ELogModeOverWrite};
1.105 + // Logging level
1.106 + enum TLogSeverity{ESevrErr = 1,ESevrHigh, ESevrWarn, ESevrMedium, ESevrInfo, ESevrLow, ESevrTEFUnit, ESevrAll};
1.107 + enum TLogCommand{ECreateLog,EWriteLog};
1.108 +
1.109 + enum TLogType{EXml,ETxt};
1.110 +
1.111 + IMPORT_C RFileFlogger();
1.112 + IMPORT_C ~RFileFlogger();
1.113 +
1.114 +
1.115 + IMPORT_C TInt Connect();
1.116 + IMPORT_C TInt CreateLog(const TDesC& aLogFilePath,TLogMode aMode);
1.117 + IMPORT_C void Log(const TText8* aFile, TInt aLine, TLogSeverity aSeverity, TRefByValue<const TDesC> aFmt,...);
1.118 + IMPORT_C void Log(const TText8* aFile, TInt aLine, TLogSeverity aSeverity, TInt arraylength, TExtraLogField* aLogFields, TRefByValue<const TDesC> aFmt,...);
1.119 +
1.120 + IMPORT_C void SetLogLevel(TLogSeverity aloglevel);
1.121 + IMPORT_C void Close();
1.122 + IMPORT_C void Log(const TText8* aFile, TInt aLine, TLogSeverity aSeverity,TRefByValue<const TDesC> aFmt, VA_LIST aList);
1.123 + IMPORT_C void Log(const TText8* aFile, TInt aLine, TLogSeverity aSeverity, TInt arraylength, TExtraLogField* aLogFields, TRefByValue<const TDesC> aFmt, VA_LIST aList);
1.124 +
1.125 +private:
1.126 + void GetCPPModuleName(TDes& aModuleName, const TText8* aCPPFileName);
1.127 + void WriteL(const TDesC& aLogBuffer);
1.128 + void WriteL(TDes8& aLogBuffer);
1.129 + void AddTime(TDes8& aTime);
1.130 +
1.131 + RFileLoggerBody* ilogbody;
1.132 +
1.133 + TLogSeverity iloglevel;
1.134 + TBool iLogfileTag;
1.135 +
1.136 +
1.137 + };
1.138 +
1.139 +
1.140 +#endif