Collapse all Symbian^3 Product Developer Library

CVtLogger Class Reference

class CVtLogger : public CActive

Debbuging support. To enable logging (either with RDebug or RFileLogger) follow steps below: 1. Create folder c: 2. Create file VTLOGCONF.txt 3. Open the file and define logging level by hexadecimal digit, see TLogLevel in class declaration below. Example: 2007 means that constructors (0x1), destructors (0x2 ) in media subsystem (0x4) are logged to file (0x2000), i.e. the values are bitwise or'ed. Log file name is "<thread name>.txt" where <thread name>=""> is name of the thread where logging takes places.

videoteleng

Since: 2.6

Inherits from

CVtLogger
- CActive
  - CBase

Public Member Functions
	~CVtLogger()
IMPORT_C TInt	Flags()
IMPORT_C void	Initialize()
CVtLogger *	NewL()
void	Print(TDesC &)
IMPORT_C void	Print(TInt, TPtrC)
IMPORT_C void	Print(TInt, TPtrC, TInt)
IMPORT_C void	Print(TInt, TPtrC, TInt, TInt)
IMPORT_C void	Print(TInt, const TBool, TPtrC, TInt)
IMPORT_C void	Uninitialize()

Private Member Functions
	CVtLogger()
TBool	CheckLevels(TInt)
void	ConstructL()
void	DoCancel()
CVtLogger *	Logger()
void	ReadCongigFile()
void	RunL()

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::RunError(TInt)
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Member Enumerations
enum	TLogLevel { ELogConstruction = 0x00000001, ELogDestruction = 0x00000002, ELogMedia = 0x00000004, ELogSession = 0x00000008, ELogAudio = 0x00000010, ELogDetails = 0x00000020, ELogGeneric = 0x00000040, ELogReturn = 0x00000080, ELogLogEverything = 0x0000007F, ELogTime = 0x00001000, ELogToFile = 0x00002000, ELogApp1 = 0x00004000, ELogApp2 = 0x00008000, ELogApp3 = 0x00010000, ELogApp4 = 0x00020000, ECfgBBLoopbackEnabled = 0x00100000, ECfgPVLoopbackEnabled = 0x00200000, ECfgNoAudioSink = 0x00400000, ECfgNoAudioSource = 0x00800000, ECfgNoVideoSource = 0x01000000, ECfgNoVideoSink = 0x02000000 }

Public Member Enumerations

enum

TLogLevel {
ELogConstruction = 0x00000001, ELogDestruction = 0x00000002, ELogMedia = 0x00000004, ELogSession = 0x00000008, ELogAudio = 0x00000010, ELogDetails = 0x00000020, ELogGeneric = 0x00000040, ELogReturn = 0x00000080, ELogLogEverything = 0x0000007F, ELogTime = 0x00001000, ELogToFile = 0x00002000, ELogApp1 = 0x00004000, ELogApp2 = 0x00008000, ELogApp3 = 0x00010000, ELogApp4 = 0x00020000, ECfgBBLoopbackEnabled = 0x00100000, ECfgPVLoopbackEnabled = 0x00200000, ECfgNoAudioSink = 0x00400000, ECfgNoAudioSource = 0x00800000, ECfgNoVideoSource = 0x01000000, ECfgNoVideoSink = 0x02000000
}

Private Member Enumerations
enum	anonymous { ETempBufLength = 80 }

Inherited Enumerations
	CActive:TPriority

Private Attributes
TInt	iAccessCount
TBuf< ETempBufLength >	iBuffer
TFileName	iFileName
RFs	iFs
TInt	iLogLevel
TBuf< ETempBufLength >	iTempBuf

Inherited Attributes
	CActive::iStatus

Constructor & Destructor Documentation

CVtLogger()

CVtLogger

(

)

[private]

C++ default constructor.

~CVtLogger()

~CVtLogger

(

)

[virtual]

Destructor.

Member Functions Documentation

CheckLevels(TInt)

TBool

CheckLevels

(

TInt

aLevels

)

const [private]

Returns if certain log levels are set.

Parameters

TInt aLevels

bitmap of TLogLevel values

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian 2nd phase constructor is private.

DoCancel()

void

DoCancel

(

)

[private, virtual]

Cancels monitoring file change

Flags()

IMPORT_C TInt

Flags

(

)

[static]

Returns flags in configuration file

Initialize()

IMPORT_C void

Initialize

(

)

[static]

Initializes logging. This must be called before any use of __VTPRINT macros.

Logger()

CVtLogger *

Logger

(

)

[private, static]

Returns logger.

NewL()

CVtLogger *

NewL

(

)

[static]

Two-phased constructor.

Print(TDesC &)

void

(

TDesC &

aDes

)

[virtual]

Writes to log file or RDebug.

Parameters

TDesC & aDes

text output

Print(TInt, TPtrC)

IMPORT_C void	Print	(	TInt	aLevel,
			TPtrC	aBuffer
		)	[static]

Writes buffer to log.

Parameters

TInt aLevel	combination of TLogLevel values
TPtrC aBuffer	buffer to log

Print(TInt, TPtrC, TInt)

IMPORT_C void	Print	(	TInt	aLevel,
			TPtrC	aBuffer,
			TInt	aValue
		)	[static]

Writes buffer to log.

Parameters

TInt aLevel	combination of TLogLevel values
TPtrC aBuffer	buffer to log
TInt aValue	value appended to buffer

Print(TInt, TPtrC, TInt, TInt)

IMPORT_C void	Print	(	TInt	aLevel,
			TPtrC	aBuffer,
			TInt	aValue1,
			TInt	aValue2
		)	[static]

Writes buffer to log.

Parameters

TInt aLevel	combination of TLogLevel values
TPtrC aBuffer	buffer to log
TInt aValue1	first value appended to buffer
TInt aValue2	second value appended to buffer

Print(TInt, const TBool, TPtrC, TInt)

IMPORT_C void	Print	(	TInt	aLevel,
			const TBool	aEntry,
			TPtrC	aBuffer,
			TInt	aRetVal = KVtDebugReturnValNotApplicable
		)	[static]

Writes buffer to log. This overloaded method is used for printing entry or exit from a function.

Since: Series60 2.8

Parameters

TInt aLevel	combination of TLogLevel values
const TBool aEntry	if ETrue "<" is appended to end of string if EFalse ">" is appended to end of string
TPtrC aBuffer	buffer to log
TInt aRetVal = KVtDebugReturnValNotApplicable	return value of the function. If this value is present (i.e. other than KVtDebugReturnValNotApplicable is passed) then aBuffer should include format tag 'd' where aRetValue should be placed.

ReadCongigFile()

void

ReadCongigFile

(

)

[private]

Reads configuration file and starts monitoring changes on it.

RunL()

void

RunL

(

)

[private, virtual]

Handles file change notification

Uninitialize()

IMPORT_C void

Uninitialize

(

)

[static]

Uninitializes logging. This must be called when client of logging service is deleted.

Member Enumerations Documentation

Enum anonymous

Enumerators

ETempBufLength = 80

Enum TLogLevel

Log level defining logging behavior.

Enumerators

ELogConstruction = 0x00000001
ELogDestruction = 0x00000002
ELogMedia = 0x00000004
ELogSession = 0x00000008
ELogAudio = 0x00000010
ELogDetails = 0x00000020
ELogGeneric = 0x00000040
ELogReturn = 0x00000080
ELogLogEverything = 0x0000007F
ELogTime = 0x00001000
ELogToFile = 0x00002000
ELogApp1 = 0x00004000
ELogApp2 = 0x00008000
ELogApp3 = 0x00010000
ELogApp4 = 0x00020000
ECfgBBLoopbackEnabled = 0x00100000	Loopback configuration (set only one of the following flags
ECfgPVLoopbackEnabled = 0x00200000
ECfgNoAudioSink = 0x00400000
ECfgNoAudioSource = 0x00800000
ECfgNoVideoSource = 0x01000000
ECfgNoVideoSink = 0x02000000

Member Data Documentation

TInt iAccessCount

TInt

iAccessCount

[private]

TBuf< ETempBufLength > iBuffer

TBuf< ETempBufLength >

iBuffer

[private]

TFileName iFileName

TFileName

iFileName

[private]

RFs iFs

RFs

iFs

[private]

TInt iLogLevel

TInt

iLogLevel

[private]

TBuf< ETempBufLength > iTempBuf

TBuf< ETempBufLength >

iTempBuf

[private]