FileStatsTarget Class Reference

FileStatsTarget implements the StatsTarget interface by writing to a simple text file. More...

#include <FileStatsTarget.h>

Inheritance diagram for FileStatsTarget:

List of all members.

Public Member Functions
	FileStatsTarget (std::string filename)
	Creates a new FileStatsTarget.
std::string	getFilename () const
	Gets name of file receiving stats.
virtual void	beginSnapshot ()
	Begins recording a snapshot.
virtual void	endSnapshot ()
	Finishes recording a snapshot.
virtual void	writeCounter (std::string name, int64_t value)
	Writes one int counter.
virtual void	onThreadStart ()
	Receives notification that stats polling is starting via a TimerThread.
virtual void	onThreadEnd ()
	Receives notification that stats polling via a TimerThread is ending.
Private Attributes
std::string	filename
std::ofstream	snapshotStream

---

Detailed Description

FileStatsTarget implements the StatsTarget interface by writing to a simple text file.

Definition at line 37 of file FileStatsTarget.h.

---

Constructor & Destructor Documentation

FileStatsTarget::FileStatsTarget

(

std::string

filename

)

[explicit]

Creates a new FileStatsTarget.

Parameters:

filename

name of file into which to write stats

Definition at line 30 of file FileStatsTarget.cpp.

References filename.

{
    filename = filenameInit;
}

---

Member Function Documentation

std::string FileStatsTarget::getFilename

(

)

const

Gets name of file receiving stats.

Definition at line 35 of file FileStatsTarget.cpp.

References filename.

{
    return filename;
}

void FileStatsTarget::beginSnapshot

(

)

[virtual]

Begins recording a snapshot.

Called before all writeCounter invocations for the snapshot.

Implements StatsTarget.

Definition at line 40 of file FileStatsTarget.cpp.

References filename, and snapshotStream.

{
    assert(!filename.empty());
    snapshotStream.open(filename.c_str(),std::ios::trunc);

    // TODO:  re-enable this.  I disabled it since /tmp/fennel.stats
    // can't be opened on mingw; need to parameterize it better
    // (or put in Performance Monitor integration)

    // assert(snapshotStream.good());
}

void FileStatsTarget::endSnapshot

(

)

[virtual]

Finishes recording a snapshot.

Called after all writeCounter invocations for the snapshot.

Implements StatsTarget.

Definition at line 52 of file FileStatsTarget.cpp.

References snapshotStream.

{
    snapshotStream.close();
}

void FileStatsTarget::writeCounter	(	std::string	name,
		int64_t	value
	)			[virtual]

Writes one int counter.

This is called from a StatsSource implementation in response to writeStats().

Parameters:

	name	name of counter
	value	snapshot value

Implements StatsTarget.

Definition at line 57 of file FileStatsTarget.cpp.

References snapshotStream.

{
    snapshotStream << name << ' ' << value << std::endl;
}

void StatsTarget::onThreadStart

(

)

[virtual, inherited]

Receives notification that stats polling is starting via a TimerThread.

Reimplemented in JavaTraceTarget.

Definition at line 111 of file StatsTimer.cpp.

Referenced by StatsTimer::onThreadStart().

{
    // by default do nothing
}

void StatsTarget::onThreadEnd

(

)

[virtual, inherited]

Receives notification that stats polling via a TimerThread is ending.

Reimplemented in JavaTraceTarget.

Definition at line 116 of file StatsTimer.cpp.

Referenced by StatsTimer::onThreadEnd().

{
    // by default do nothing
}

---

Member Data Documentation

std::string FileStatsTarget::filename [private]

Definition at line 39 of file FileStatsTarget.h.

Referenced by beginSnapshot(), FileStatsTarget(), and getFilename().

std::ofstream FileStatsTarget::snapshotStream [private]

Definition at line 40 of file FileStatsTarget.h.

Referenced by beginSnapshot(), endSnapshot(), and writeCounter().

---

The documentation for this class was generated from the following files:

• /home/pub/open/dev/fennel/common/FileStatsTarget.h
• /home/pub/open/dev/fennel/common/FileStatsTarget.cpp

---