Collapse all Symbian^3 Product Developer Library

CVoipEventLog Class Reference

class CVoipEventLog : public CBase

VoIP event log API class CVoipEventLog is responsible for writing and reading error information from central repository The maximu error count is saved in cenrep ini file, if there are more errors than maximum count, old error is overwritten.

  _LIT( KErrorText, "something wrong, man!" );
  CVoipEventLog* eventLog = CVoipEventLog::NewLC();
  CVoipErrorEntry* entry = CVoipErrorEntry::NewLC();
  entry->SetErrorCode( -1 );
  User::LeaveIfError( entry->SetErrorText( KErrorText ));
  TInt err = eventLog->WriteError( *entry );
  User::LeaveIfError( err );
  CleanupStack::PopAndDestroy( entry );
  CleanupStack::PopAndDestroy( eventLog );

voipeventlog.lib

Since: S60 v3.2

Inherits from

CVoipEventLog
- CBase

Public Member Functions
	~CVoipEventLog()
IMPORT_C TInt	ErrorCount()
IMPORT_C CVoipEventLog *	NewL()
IMPORT_C CVoipEventLog *	NewLC()
IMPORT_C TInt	ReadError(TInt, CVoipErrorEntry &)
IMPORT_C TInt	ResetLog()
IMPORT_C TInt	WriteError(const CVoipErrorEntry &)
IMPORT_C TInt	WriteError(TInt)

Private Member Functions
	CVoipEventLog()
void	ConstructL()
void	DoWriteErrorL(const CVoipErrorEntry &)
void	DoWriteErrorL(TInt)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	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()

Private Attributes
CVoipEventLogEngine *	iEngine

Constructor & Destructor Documentation

CVoipEventLog()

CVoipEventLog

(

)

[private]

C++ default constructor.

~CVoipEventLog()

IMPORT_C

~CVoipEventLog

(

)

Destructor.

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian 2nd phase constructor is private.

DoWriteErrorL(const CVoipErrorEntry &)

void

DoWriteErrorL

(

const CVoipErrorEntry &

aErrorEntry

)

[private]

Writes an error data to event log this is leave function

Since: S60 v3.2

Parameters

const CVoipErrorEntry & aErrorEntry

Error information

DoWriteErrorL(TInt)

void

DoWriteErrorL

(

TInt

aErrorCode

)

[private]

Writes an error code to event log this is leave function

Since: S60 v3.2

Parameters

TInt aErrorCode

VoIP error identification

ErrorCount()

IMPORT_C TInt

ErrorCount

(

)

const

Reads error count from the log

Since: S60 v3.2

NewL()

IMPORT_C CVoipEventLog *

NewL

(

)

[static]

Two-phased constructor.

NewLC()

IMPORT_C CVoipEventLog *

NewLC

(

)

[static]

ReadError(TInt, CVoipErrorEntry &)

IMPORT_C TInt	ReadError	(	TInt	aIndex,
			CVoipErrorEntry &	aErrorEntry
		)	const

Reads an error information from the log

Since: S60 v3.2

Parameters

TInt aIndex	the index of error to be read, 0 means latest error index
CVoipErrorEntry & aErrorEntry	in return, error information corresponding to aIndex

ResetLog()

IMPORT_C TInt

ResetLog

(

)

Clear all voip error entries from the log

Since: S60 v3.2

WriteError(const CVoipErrorEntry &)

IMPORT_C TInt

WriteError

(

const CVoipErrorEntry &

aErrorEntry

)

Writes an error data to event log

Since: S60 v3.2

Parameters

const CVoipErrorEntry & aErrorEntry

Error information

WriteError(TInt)

IMPORT_C TInt

WriteError

(

TInt

aErrorCode

)

Writes an error code to event log this function only writes the error code, no other infomration

Since: S60 v3.2

Parameters

TInt aErrorCode

VoIP error identification

Member Data Documentation

CVoipEventLogEngine * iEngine

CVoipEventLogEngine *

iEngine

[private]

CVoipEventLogEngine instance