loggingservices/filelogger/INC/FLOGGER.H
branchRCL_3
changeset 9 667e88a979d7
parent 0 08ec8eefde2f
equal deleted inserted replaced
8:fa9941cf3867 9:667e88a979d7
    14 // FLogger Client side header
    14 // FLogger Client side header
    15 // 
    15 // 
    16 //
    16 //
    17 
    17 
    18 /**
    18 /**
    19  @file
    19 @file
    20  @internalTechnology
    20 @publishedAll
    21 */
    21 @deprecated Migrate to Open System Trace Instrumentation API instead
    22 
    22 */
    23 
       
    24 
    23 
    25 #ifndef __FLOGGER_H__
    24 #ifndef __FLOGGER_H__
    26 #define __FLOGGER_H__
    25 #define __FLOGGER_H__
    27 
    26 
    28 #include <e32base.h>
    27 #include <e32base.h>
    29 
    28 
    30 /** Maximum log buffer size.
    29 /** Maximum log buffer size.
    31 @internalTechnology */
    30 @publishedAll
       
    31 @deprecated Migrate to Open System Trace Instrumentation API instead
       
    32 */
    32 const TInt KLogBufferSize=150;
    33 const TInt KLogBufferSize=150;
    33 
    34 
    34 // [All of this start up stuff copied from DBMS]
    35 // [All of this start up stuff copied from DBMS]
    35 
    36 
    36 class FLogger
    37 class FLogger
    37 /** Controls the flogger server.
    38 /** Controls the flogger server.
    38 @internalComponent */
    39 @publishedAll
       
    40 @deprecated Migrate to Open System Trace Instrumentation API instead
       
    41 */
    39 	{
    42 	{
    40 public:
    43 public:
    41 	class TSignal
    44 	class TSignal
    42 /**
    45 /**
    43 @internalComponent
    46 @publishedAll
       
    47 @deprecated Migrate to Open System Trace Instrumentation API instead
    44 */
    48 */
    45 		{
    49 		{
    46 		friend class FLogger;
    50 		friend class FLogger;
    47 	public:
    51 	public:
    48 		inline TSignal() {}
    52 		inline TSignal() {}
    65 	static TInt Init();
    69 	static TInt Init();
    66 	};
    70 	};
    67 
    71 
    68 
    72 
    69 /** The mode used to write to the log file.
    73 /** The mode used to write to the log file.
    70 @internalTechnology */
    74 @publishedAll
       
    75 @deprecated Migrate to Open System Trace Instrumentation API instead
       
    76 */
    71 enum TFileLoggingMode 
    77 enum TFileLoggingMode 
    72 	{
    78 	{
    73 	/** Log file mode has not been explicitly set. */
    79 	/** Log file mode has not been explicitly set. */
    74 	EFileLoggingModeUnknown =0,
    80 	EFileLoggingModeUnknown =0,
    75 	/** Open the log file in append mode. */
    81 	/** Open the log file in append mode. */
    80 	EFileLoggingModeOverwriteRaw	
    86 	EFileLoggingModeOverwriteRaw	
    81 	};
    87 	};
    82 
    88 
    83 NONSHARABLE_CLASS(TLogFormatter16Overflow) :public TDes16Overflow
    89 NONSHARABLE_CLASS(TLogFormatter16Overflow) :public TDes16Overflow
    84 /** Unicode overflow handler.
    90 /** Unicode overflow handler.
    85 @internalComponent */
    91 @publishedAll
       
    92 @deprecated Migrate to Open System Trace Instrumentation API instead
       
    93 */
    86 	{
    94 	{
    87 public:
    95 public:
    88 	virtual void Overflow(TDes16& aDes);
    96 	virtual void Overflow(TDes16& aDes);
    89 	};
    97 	};
    90 
    98 
    91 NONSHARABLE_CLASS(TLogFormatter8Overflow) :public TDes8Overflow
    99 NONSHARABLE_CLASS(TLogFormatter8Overflow) :public TDes8Overflow
    92 /** Overflow handler.
   100 /** Overflow handler.
    93 @internalComponent */
   101 @publishedAll
       
   102 @deprecated Migrate to Open System Trace Instrumentation API instead
       
   103 */
    94 	{
   104 	{
    95 public:
   105 public:
    96 	virtual void Overflow(TDes8& aDes);
   106 	virtual void Overflow(TDes8& aDes);
    97 	};
   107 	};
    98 
   108 
    99 class TLogFormatter
   109 class TLogFormatter
   100 /** Formatting methods for log file data.
   110 /** Formatting methods for log file data.
   101 @internalComponent */
   111 @publishedAll
       
   112 @deprecated Migrate to Open System Trace Instrumentation API instead
       
   113 */
   102 	{
   114 	{
   103 public:
   115 public:
   104 	TLogFormatter();
   116 	TLogFormatter();
   105 	void SetDateAndTime(TBool aUseDate,TBool aUseTime);
   117 	void SetDateAndTime(TBool aUseDate,TBool aUseTime);
   106 	TInt FormatTextToWritableBuffer(TDes8& aBuf, const TDesC16& aText) const;
   118 	TInt FormatTextToWritableBuffer(TDes8& aBuf, const TDesC16& aText) const;
   118 	TLogFormatter8Overflow iOverflow8;
   130 	TLogFormatter8Overflow iOverflow8;
   119 	};
   131 	};
   120 
   132 
   121 class TLogFile
   133 class TLogFile
   122 /** General access to packaged log files.
   134 /** General access to packaged log files.
   123 @internalComponent */
   135 @publishedAll
       
   136 @deprecated Migrate to Open System Trace Instrumentation API instead
       
   137 */
   124 	{
   138 	{
   125 public:
   139 public:
   126 	TLogFile();
   140 	TLogFile();
   127 	TLogFile(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode);
   141 	TLogFile(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode);
   128 	TBool operator==(const TLogFile& aLogFile) const;
   142 	TBool operator==(const TLogFile& aLogFile) const;
   144 class RFileLogger : public RSessionBase
   158 class RFileLogger : public RSessionBase
   145 /** Provides access methods to file logging.
   159 /** Provides access methods to file logging.
   146 
   160 
   147 The file logger API contains both static and non-static versions of access 
   161 The file logger API contains both static and non-static versions of access 
   148 functions to the file logging system. 
   162 functions to the file logging system. 
   149 @internalTechnology */
   163 @publishedAll
       
   164 @deprecated Migrate to Open System Trace Instrumentation API instead
       
   165 */
   150 	{
   166 	{
   151 public:
   167 public:
   152 	IMPORT_C RFileLogger();
   168 	IMPORT_C RFileLogger();
   153 	IMPORT_C ~RFileLogger();
   169 	IMPORT_C ~RFileLogger();
   154 	IMPORT_C TVersion Version() const;
   170 	IMPORT_C TVersion Version() const;