RFileLogger Class Reference

#include <comms-infras/commsdebugutility.h>

Link against: comsdbgutil.lib

class RFileLogger

Public Member Functions
	RFileLogger()
	~RFileLogger()
IMPORT_C TInt	ClearLog()
IMPORT_C void	Close()
IMPORT_C void	CloseLog()
IMPORT_C TInt	Connect()
IMPORT_C void	CreateLog(const TDesC &, const TDesC &, TFileLoggingMode)
IMPORT_C TInt	Handle()
IMPORT_C void	HexDump(const TDesC &, const TDesC &, TFileLoggingMode, const TText , const TText , const TUint8 *, TInt)
IMPORT_C void	HexDump(const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &)
IMPORT_C void	HexDump(const TText , const TText , const TUint8 *, TInt)
IMPORT_C void	HexDump(const TDesC8 &, const TDesC8 &)
IMPORT_C TInt	LastError()
IMPORT_C TBool	LogValid()
IMPORT_C void	SetDateAndTime(TBool, TBool)
IMPORT_C TInt	SetLogTags(const TDesC8 &, const TDesC8 &)
IMPORT_C TInt	Share()
IMPORT_C TVersion	Version()
IMPORT_C void	Write(const TDesC &, const TDesC &, TFileLoggingMode, const TDesC16 &)
IMPORT_C void	Write(const TDesC &, const TDesC &, TFileLoggingMode, const TDesC8 &)
IMPORT_C void	Write(const TDesC8 &, const TDesC8 &, const TDesC16 &)
IMPORT_C void	Write(const TDesC8 &, const TDesC8 &, const TDesC8 &)
IMPORT_C void	Write(const TDesC16 &)
IMPORT_C void	Write(const TDesC8 &)
IMPORT_C void	WriteBinary(const TDesC8 &)
IMPORT_C void	WriteFormat(const TDesC &, const TDesC &, TFileLoggingMode, TRefByValue< const TDesC16 >, ...)
IMPORT_C void	WriteFormat(const TDesC &, const TDesC &, TFileLoggingMode, TRefByValue< const TDesC16 >, VA_LIST &)
IMPORT_C void	WriteFormat(const TDesC &, const TDesC &, TFileLoggingMode, TRefByValue< const TDesC8 >, ...)
IMPORT_C void	WriteFormat(const TDesC &, const TDesC &, TFileLoggingMode, TRefByValue< const TDesC8 >, VA_LIST &)
IMPORT_C void	WriteFormat(const TDesC8 &, const TDesC8 &, const TRefByValue< const TDesC16 >, ...)
IMPORT_C void	WriteFormat(const TDesC8 &, const TDesC8 &, const TRefByValue< const TDesC16 >, VA_LIST &)
IMPORT_C void	WriteFormat(const TDesC8 &, const TDesC8 &, const TRefByValue< const TDesC8 >, ...)
IMPORT_C void	WriteFormat(const TDesC8 &, const TDesC8 &, const TRefByValue< const TDesC8 >, VA_LIST &)
IMPORT_C void	WriteFormat(TRefByValue< const TDesC16 >, ...)
IMPORT_C void	WriteFormat(TRefByValue< const TDesC16 >, VA_LIST &)
IMPORT_C void	WriteFormat(TRefByValue< const TDesC8 >, ...)
IMPORT_C void	WriteFormat(TRefByValue< const TDesC8 >, VA_LIST &)
IMPORT_C void	__DbgSetHeapFailure(TInt)
IMPORT_C void	__DbgShutDownServer()

Detailed Description

Flogger - File and Serial Logger client interface

DeprecatedMigrate to Open System Trace Instrumentation API instead

This class is responsible for providing all functions clients require of the flogger system. It is preferred, though, that clients use the provided macros which refer to these API's so that all logging code is governed by the global __FLOG_ACTIVE macro setting. The macro's are not currently documented using doxygen - you will need to consult the flogger user guide instead. RFileLogger is the only exported interface for the flogger component.

Constructor & Destructor Documentation

RFileLogger ( )

IMPORT_C

RFileLogger

(

)

Create a new flogger client interface object with an empty body.

~RFileLogger ( )

IMPORT_C

~RFileLogger

(

)

Destructor

Member Function Documentation

ClearLog ( )

IMPORT_C TInt

ClearLog

(

)

Request that the server empty the log file.

Pre-condition: The client requesting the log be cleared must be listed in the flogger "ini" file as an enabled logging client. This prevents unwanted clients clearing the log. The session with the server must be active, otherwise this will fail silently.

Post-condition: A message is added to the server write queue that indicates to clear the log. Once the message reaches the head of the queue flogger will empty the log file and begin filling it again.

Return Value: TInt indicating success code (KErrNone) or an error code.

Close ( )

IMPORT_C void

(

)

Close a client side session with the flogger server.

Post-condition: The client session is closed and the body of the class is deleted. Further calls to the Write functions will fail silently until a new session is opened.

CloseLog ( )

IMPORT_C void

CloseLog

(

)

Close a client side session with the flogger server. DeprecatedWith the advent of a single log file for all clients, closing the log file is no longer necessary. Use Close to close the session.

Connect ( )

IMPORT_C TInt

Connect

(

)

Connect to the flogger server - default number of message slots = 1

Return Value: TInt indicating success code (KErrNone), KErrNoMemory if failed to allocate log body or an error from RSessionBase::CreateSession. KErrAlreadyExists if Connect has already been called.

CreateLog ( const TDesC &, const TDesC &, TFileLoggingMode )

IMPORT_C void	CreateLog	(	const TDesC &	aSubsystem,
			const TDesC &	aComponent,
			TFileLoggingMode
		)

Sets the log tags. Not fully supported since flogger only uses one log file. Use SetLogTags instead.

Note:

This function is partially supported and is equivalent to calling SetLogTags.

Handle ( )

IMPORT_C TInt

Handle

(

)

const

HexDump ( const TDesC &, const TDesC &, TFileLoggingMode, const TText , const TText , const TUint8 *, TInt )

IMPORT_C void	HexDump	(	const TDesC &	aSubsystem,
			const TDesC &	aComponent,
			TFileLoggingMode	,
			const TText *	aHeader,
			const TText *	aMargin,
			const TUint8 *	aPtr,
			TInt	aLen
		)	[static]

Static Write. Dump arbitrary data to the log file as a standard hex dump. With the advent of a single log file for all clients, this function has been replaced by an equivalent without the aMode parameter.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: Each line is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

This function has poor performance since it performs a full connection and disconnection to the flogger server. Example of aHeader/aMargin. If "aHeader" is set to "Fn Output:" and "aMargin" is set to " ", then output would look like (for a print of the alphabet): TLOG Example 20 FnOutput:0000 : 61 62 63 64 65 66 67 68 69 6a 6b 6c 6d 6e 6f 70 abcdefghijklmnop TLOG Example 20 0010 : 71 72 73 74 75 76 77 78 79 7a qrstuvwxyz

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aHeader	Specify a zero-terminated string to be printed before the first hex line. Leave as null or an empty string for no header.
aMargin	Specify a zero-terminated string to be printed before each subsequent line. Leave as null or an empty string for no Margin.
aPtr	pointer to the data being dumped.
aLen	the number of bytes to dump

HexDump ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 & )

IMPORT_C void	HexDump	(	const TDesC8 &	aSubsystem,
			const TDesC8 &	aComponent,
			const TDesC8 &	aData,
			const TDesC8 &	aHeader = TPtrC8(NULL, 0)
		)	[static]

Static Write. Dump arbitrary data to the log file as a standard hex dump.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: Each line is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aData	the data being dumped.
aHeader	Specify a string to be printed before the first hex line. If not supplied, no header or Margin is written.

HexDump ( const TText , const TText , const TUint8 *, TInt )

IMPORT_C void	HexDump	(	const TText *	aHeader,
			const TText *	aMargin,
			const TUint8 *	aPtr,
			TInt	aLen
		)

Dump arbitrary data to the log file as a standard hex dump.

Pre-condition: The session with the server must be active, otherwise this no action is taken. The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: Each line is preceded in the log file by the two client tags and the client thread ID.

Note:

Example of aHeader/aMargin. If "aHeader" is set to "Fn Output:" and "aMargin" is set to " ", then output would look like (for a print of the alphabet): TLOG Example 20 FnOutput:0000 : 61 62 63 64 65 66 67 68 69 6a 6b 6c 6d 6e 6f 70 abcdefghijklmnop TLOG Example 20 0010 : 71 72 73 74 75 76 77 78 79 7a qrstuvwxyz

Parameters
aHeader	Specify a zero-terminated string to be printed before the first hex line. Leave as null or an empty string for no header.
aMargin	Specify a zero-terminated string to be printed before each subsequent line. Leave as null or an empty string for no Margin.
aPtr	pointer to the data being dumped.
aLen	the number of bytes to dump

HexDump ( const TDesC8 &, const TDesC8 & )

IMPORT_C void	HexDump	(	const TDesC8 &	aData,
			const TDesC8 &	aHeader = TPtrC8(NULL, 0)
		)

Dump arbitrary data to the log file as a standard hex dump.

Pre-condition: The session with the server must be active, otherwise this no action is taken. The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: Each line is preceded in the log file by the two client tags and the client thread ID.

Note:

Example of aHeader. If "aHeader" is set to "Fn Output:" then output would look like (for a print of the alphabet): TLOG Example 20 FnOutput:0000 : 61 62 63 64 65 66 67 68 69 6a 6b 6c 6d 6e 6f 70 abcdefghijklmnop TLOG Example 20 0010 : 71 72 73 74 75 76 77 78 79 7a qrstuvwxyz

Parameters
aData	the data being dumped.
aHeader	Specify a string to be printed before the first hex line. If not supplied, no header or margin is written. If supplied, then subsequent lines are indented to the length of aHeader.

LastError ( )

IMPORT_C TInt

LastError

(

)

const

Always returns KErrNone Flogger no longer retains internal errors.

Return Value: KErrNone always.

LogValid ( )

IMPORT_C TBool

LogValid

(

)

const

Always returns ETrue. With the advent of a single log file for all clients, checking for log validity is no longer necessary.

Return Value: ETrue always.

SetDateAndTime ( TBool, TBool )

IMPORT_C void	SetDateAndTime	(	TBool	aUseDate,
			TBool	aUseTime
		)

Does nothing. This function no longer needed since now logging to one file and date/time comes from system.

SetLogTags ( const TDesC8 &, const TDesC8 & )

IMPORT_C TInt	SetLogTags	(	const TDesC8 &	aSubsystem,
			const TDesC8 &	aComponent
		)

Set the two tag strings that all further writes by this client will use to idenitfy it in the log file.

Post-condition: The client session is updated so that all future calls use this tag set. Tags are truncated to KMaxTagLength.

Note:

If an error occurs, the client connection will be silently closed to protect the client.

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file

Return Value: TInt indicating success code (KErrNone) or an error code.

Share ( )

IMPORT_C TInt

(

)

Version ( )

IMPORT_C TVersion

Version

(

)

const

Return the client side version number

Return Value: TVersion 3-part version number: major, minor, build.

Write ( const TDesC &, const TDesC &, TFileLoggingMode, const TDesC16 & )

IMPORT_C void	Write	(	const TDesC &	aSubsystem,
			const TDesC &	aComponent,
			TFileLoggingMode	,
			const TDesC16 &	aText
		)	[static]

Static write. Write 16-bit aText to the log file if it is a valid file. With the advent of a single log file for all clients, this function has been replaced by an equivalent without the aMode parameter.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: The text is converted to 8-bit text before writing, and truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

This function has poor performance since it performs a full connection and disconnection to the flogger server.

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aText	Text to write

Write ( const TDesC &, const TDesC &, TFileLoggingMode, const TDesC8 & )

IMPORT_C void	Write	(	const TDesC &	aSubsystem,
			const TDesC &	aComponent,
			TFileLoggingMode	,
			const TDesC8 &	aText
		)	[static]

Static write. Write 8-bit aText to the log file. With the advent of a single log file for all clients, this function has been replaced by an equivalent without the aMode parameter.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: The text is truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

This function has poor performance since it performs a full connection and disconnection to the flogger server.

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aText	Text to log.

Write ( const TDesC8 &, const TDesC8 &, const TDesC16 & )

IMPORT_C void	Write	(	const TDesC8 &	aSubsystem,
			const TDesC8 &	aComponent,
			const TDesC16 &	aText
		)	[static]

Static write. Write 16-bit aText to the log file if it is a valid file.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: The text is converted to 8-bit text before writing, and truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

This function has poor performance since it performs a full connection and disconnection to the flogger server.

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aText	Text to write

Write ( const TDesC8 &, const TDesC8 &, const TDesC8 & )

IMPORT_C void	Write	(	const TDesC8 &	aSubsystem,
			const TDesC8 &	aComponent,
			const TDesC8 &	aText
		)	[static]

Static write. Write 8-bit aText to the log file.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: The text is truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

This function has poor performance since it performs a full connection and disconnection to the flogger server.

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aText	Text to log.

Write ( const TDesC16 & )

IMPORT_C void

Write

(

const TDesC16 &

aText

)

Write 16-bit aText to the log file.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur. The session with the server must be active, otherwise this will fail silently.

Post-condition: The 16-bit text is converted to 8-bit text before writing, and is truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID.

Note:

There is no need to supply CR, LF. If these are supplied it may cause the log output to be incorrect.

Parameters
aText	Text to write

Write ( const TDesC8 & )

IMPORT_C void

Write

(

const TDesC8 &

aText

)

Write 8-bit aText to the log file.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur. The session with the server must be active, otherwise this will fail silently.

Post-condition: The text is truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID.

Parameters
aText	Text to log.

WriteBinary ( const TDesC8 & )

IMPORT_C void

WriteBinary

(

const TDesC8 &

aData

)

Dump arbitrary data to the log file in a binary format.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur. The session with the server must be active, otherwise this will fail silently.

Post-condition: The 8-bit binary dump is preceded in the log file by the two client tags

Note:

Unlike all other write API's, no thread ID is written with this API.

Parameters
aData	Descriptor of the data to be dumped

WriteFormat ( const TDesC &, const TDesC &, TFileLoggingMode, TRefByValue< const TDesC16 >, ... )

IMPORT_C void	WriteFormat	(	const TDesC &	aSubsystem,
			const TDesC &	aComponent,
			TFileLoggingMode	aMode,
			TRefByValue< const TDesC16 >	aFmt,
			...
		)	[static]

Static write. Write the formatted 16-bit string aFmt to the log file. With the advent of a single log file for all clients, this function has been replaced by an equivalent without the aMode parameter.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: The text is converted to 8-bit text before writing, and truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

This function has poor performance since it performs a full connection and disconnection to the flogger server.

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aMode	not used
aFmt	c-style format descriptor, followed by any variables required by the format.

WriteFormat ( const TDesC &, const TDesC &, TFileLoggingMode, TRefByValue< const TDesC16 >, VA_LIST & )

IMPORT_C void	WriteFormat	(	const TDesC &	aSubsystem,
			const TDesC &	aComponent,
			TFileLoggingMode	,
			TRefByValue< const TDesC16 >	aFmt,
			VA_LIST &	aList
		)	[static]

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: The text is converted to 8-bit text before writing, and truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

This function has poor performance since it performs a full connection and disconnection to the flogger server.

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aFmt	c-style format descriptor
aList	any variables required by the format.

WriteFormat ( const TDesC &, const TDesC &, TFileLoggingMode, TRefByValue< const TDesC8 >, ... )

IMPORT_C void	WriteFormat	(	const TDesC &	aSubsystem,
			const TDesC &	aComponent,
			TFileLoggingMode	aMode,
			TRefByValue< const TDesC8 >	aFmt,
			...
		)	[static]

Static write. Write the formatted 8-bit string aFmt to the log file. With the advent of a single log file for all clients, this function has been replaced by an equivalent without the aMode parameter.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: The text is truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

This function has poor performance since it performs a full connection and disconnection to the flogger server.

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aMode	not used
aFmt	c-style format descriptor, followed by any variables required by the format.

WriteFormat ( const TDesC &, const TDesC &, TFileLoggingMode, TRefByValue< const TDesC8 >, VA_LIST & )

IMPORT_C void	WriteFormat	(	const TDesC &	aSubsystem,
			const TDesC &	aComponent,
			TFileLoggingMode	,
			TRefByValue< const TDesC8 >	aFmt,
			VA_LIST &	aList
		)	[static]

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: The text is truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

This function has poor performance since it performs a full connection and disconnection to the flogger server.

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aFmt	c-style format descriptor
aList	any variables required by the format.

WriteFormat ( const TDesC8 &, const TDesC8 &, const TRefByValue< const TDesC16 >, ... )

IMPORT_C void	WriteFormat	(	const TDesC8 &	aSubsystem,
			const TDesC8 &	aComponent,
			const TRefByValue< const TDesC16 >	aFmt,
			...
		)	[static]

Static write. Write the formatted 16-bit string aFmt to the log file.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: The text is converted to 8-bit text before writing, and truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

This function has poor performance since it performs a full connection and disconnection to the flogger server.

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aFmt	c-style format descriptor, followed by any variables required by the format.

WriteFormat ( const TDesC8 &, const TDesC8 &, const TRefByValue< const TDesC16 >, VA_LIST & )

IMPORT_C void	WriteFormat	(	const TDesC8 &	aSubsystem,
			const TDesC8 &	aComponent,
			const TRefByValue< const TDesC16 >	aFmt,
			VA_LIST &	aList
		)	[static]

Static write. Write the formatted 16-bit string aFmt to the log file.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: The text is converted to 8-bit text before writing, and truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

This function has poor performance since it performs a full connection and disconnection to the flogger server.

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aFmt	c-style format descriptor
aList	any variables required by the format.

WriteFormat ( const TDesC8 &, const TDesC8 &, const TRefByValue< const TDesC8 >, ... )

IMPORT_C void	WriteFormat	(	const TDesC8 &	aSubsystem,
			const TDesC8 &	aComponent,
			const TRefByValue< const TDesC8 >	aFmt,
			...
		)	[static]

Static write. Write the formatted 8-bit string aFmt to the log file.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: The text is truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

This function has poor performance since it performs a full connection and disconnection to the flogger server.

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aFmt	c-style format descriptor, followed by any variables required by the format.

WriteFormat ( const TDesC8 &, const TDesC8 &, const TRefByValue< const TDesC8 >, VA_LIST & )

IMPORT_C void	WriteFormat	(	const TDesC8 &	aSubsystem,
			const TDesC8 &	aComponent,
			const TRefByValue< const TDesC8 >	aFmt,
			VA_LIST &	aList
		)	[static]

Static write. Write the formatted 16-bit string aFmt to the log file.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur.

Post-condition: The text is truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID. "aSubsystem" and "aComponent" are each truncated to KMaxTagLength.

Note:

This function has poor performance since it performs a full connection and disconnection to the flogger server.

Parameters
aSubsystem	Specifies the tag1 name that goes into the log file
aComponent	specifies the tag2 name that goes into the log file
aFmt	c-style format descriptor
aList	any variables required by the format.

WriteFormat ( TRefByValue< const TDesC16 >, ... )

IMPORT_C void	WriteFormat	(	TRefByValue< const TDesC16 >	aFmt,
			...
		)

Write the formatted 16-bit string aFmt to the log file

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur. The session with the server must be active, otherwise this will fail silently.

Post-condition: The 16-bit text is converted to 8-bit text before writing, and is truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID.

Parameters
aFmt	c-style format descriptor, followed by any variables required by the format.

WriteFormat ( TRefByValue< const TDesC16 >, VA_LIST & )

IMPORT_C void	WriteFormat	(	TRefByValue< const TDesC16 >	aFmt,
			VA_LIST &	aList
		)

Write the formatted 16-bit string aFmt to the log file.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur. The session with the server must be active, otherwise this will fail silently.

Post-condition: The 16-bit text is converted to 8-bit text before writing, and is truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID.

Parameters
aFmt	c-style format descriptor
aList	any variables required by the format.

WriteFormat ( TRefByValue< const TDesC8 >, ... )

IMPORT_C void	WriteFormat	(	TRefByValue< const TDesC8 >	aFmt,
			...
		)

Write the formatted 8-bit string aFmt to the log file.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur. The session with the server must be active, otherwise this will fail silently.

Post-condition: The text is truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID.

Parameters
aFmt	c-style format descriptor, followed by any variables required by the format.

WriteFormat ( TRefByValue< const TDesC8 >, VA_LIST & )

IMPORT_C void	WriteFormat	(	TRefByValue< const TDesC8 >	aFmt,
			VA_LIST &	aList
		)

Write the formatted 8-bit string aFmt to the log file if it is a valid file.

Pre-condition: The client requesting to log must be listed in the flogger "ini" file as an enabled logging client, otherwise no logging will occur. The session with the server must be active, otherwise this will fail silently.

Post-condition: The text is truncated to KLogBufferSize if necessary. The text is preceded in the log file by the two client tags and the client thread ID.

Parameters
aFmt	c-style format descriptor
aList	any variables required by the format.

__DbgSetHeapFailure ( TInt )

IMPORT_C void

__DbgSetHeapFailure

(

TInt

aFailAfter

)

Debugging Tool. Ask the flogger server to set its heap failure. Only valid in DEBUG builds.

Parameters
aFailAfter	The number of successful memory allocations which will occur before a memory allocation is failed by the memory manager.

__DbgShutDownServer ( )

IMPORT_C void

__DbgShutDownServer

(

)

Debugging Tool. Ask the flogger server to shutdown. Only valid in DEBUG builds.

RFileLogger Class Reference

Detailed Description

Constructor & Destructor Documentation

RFileLogger ( )

~RFileLogger ( )

Member Function Documentation

ClearLog ( )

Close ( )

CloseLog ( )

Connect ( )

CreateLog ( const TDesC &, const TDesC &, TFileLoggingMode )

Handle ( )

HexDump ( const TDesC &, const TDesC &, TFileLoggingMode, const TText *, const TText *, const TUint8 *, TInt )

HexDump ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 & )

HexDump ( const TText *, const TText *, const TUint8 *, TInt )

HexDump ( const TDesC8 &, const TDesC8 & )

LastError ( )

LogValid ( )

SetDateAndTime ( TBool, TBool )

SetLogTags ( const TDesC8 &, const TDesC8 & )

Share ( )

Version ( )

Write ( const TDesC &, const TDesC &, TFileLoggingMode, const TDesC16 & )

Write ( const TDesC &, const TDesC &, TFileLoggingMode, const TDesC8 & )

Write ( const TDesC8 &, const TDesC8 &, const TDesC16 & )

Write ( const TDesC8 &, const TDesC8 &, const TDesC8 & )

Write ( const TDesC16 & )

Write ( const TDesC8 & )

WriteBinary ( const TDesC8 & )

WriteFormat ( const TDesC &, const TDesC &, TFileLoggingMode, TRefByValue< const TDesC16 >, ... )

WriteFormat ( const TDesC &, const TDesC &, TFileLoggingMode, TRefByValue< const TDesC16 >, VA_LIST & )

WriteFormat ( const TDesC &, const TDesC &, TFileLoggingMode, TRefByValue< const TDesC8 >, ... )

WriteFormat ( const TDesC &, const TDesC &, TFileLoggingMode, TRefByValue< const TDesC8 >, VA_LIST & )

WriteFormat ( const TDesC8 &, const TDesC8 &, const TRefByValue< const TDesC16 >, ... )

WriteFormat ( const TDesC8 &, const TDesC8 &, const TRefByValue< const TDesC16 >, VA_LIST & )

WriteFormat ( const TDesC8 &, const TDesC8 &, const TRefByValue< const TDesC8 >, ... )

WriteFormat ( const TDesC8 &, const TDesC8 &, const TRefByValue< const TDesC8 >, VA_LIST & )

WriteFormat ( TRefByValue< const TDesC16 >, ... )

WriteFormat ( TRefByValue< const TDesC16 >, VA_LIST & )

WriteFormat ( TRefByValue< const TDesC8 >, ... )

WriteFormat ( TRefByValue< const TDesC8 >, VA_LIST & )

__DbgSetHeapFailure ( TInt )

__DbgShutDownServer ( )

HexDump ( const TDesC &, const TDesC &, TFileLoggingMode, const TText , const TText , const TUint8 *, TInt )

HexDump ( const TText , const TText , const TUint8 *, TInt )