CallStateEventWriter Class Reference

#include <CallStateEventWriter.h>

Inheritance diagram for CallStateEventWriter:

List of all members.

---

Detailed Description

This CallStateEventWriter writes CSE events out to either a file or a database to the specification doc/cdr/call-state-events.html.

Public Types
enum	CseLogTypes {   CseLogFile,   CseLogDatabase }
Public Member Functions
	CallStateEventWriter (CseLogTypes logType, const char *logName)
	Instantiate an event builder and set the observer name for its events.
virtual	~CallStateEventWriter ()
	Destructor.
virtual bool	writeLog (const char *event)=0
	Write event to the CSE log (file or database).
virtual bool	openLog ()=0
	Open the log that was specified in the constructor.
virtual bool	closeLog ()=0
	Close log that was specified in the constructor.
virtual bool	isWriteable ()
	Get writeable state of log.
virtual bool	getLogType ()
	Get type of log - file or database.
virtual void	flush ()
	Flush log - only functional for file.
Protected Attributes
UtlString	mLogName
bool	mbWriteable
CseLogTypes	mLogType

---

Member Enumeration Documentation

enum CseLogTypes

Enumerator:

CseLogFile
CseLogDatabase

---

Constructor & Destructor Documentation

CallStateEventWriter	(	CseLogTypes	logType,
		const char *	logName
	)

Instantiate an event builder and set the observer name for its events.

Parameters:

	logType	- Type of log, either file or database
	logName	- file name or database name

~CallStateEventWriter

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual bool writeLog

(

const char *

event

)

[pure virtual]

Write event to the CSE log (file or database).

Parameters:

event

(in) - call state event

Returns:

true if event could be written

Implemented in CallStateEventWriter_DB, and CallStateEventWriter_XML.

virtual bool openLog

(

)

[pure virtual]

Open the log that was specified in the constructor.

Implemented in CallStateEventWriter_DB, and CallStateEventWriter_XML.

virtual bool closeLog

(

)

[pure virtual]

Close log that was specified in the constructor.

Implemented in CallStateEventWriter_DB, and CallStateEventWriter_XML.

virtual bool isWriteable

(

)

[inline, virtual]

Get writeable state of log.

virtual bool getLogType

(

)

[inline, virtual]

Get type of log - file or database.

void flush

(

)

[virtual]

Flush log - only functional for file.

Reimplemented in CallStateEventWriter_XML.

---

Member Data Documentation

UtlString mLogName [protected]

bool mbWriteable [protected]

CseLogTypes mLogType [protected]