JigdoCache::ProgressReporter Class Reference

Class allowing JigdoCache to convey information back to the creator of a JigdoCache object. More...

#include <scan.hh>

Inheritance diagram for JigdoCache::ProgressReporter:

List of all members.

Public Member Functions
virtual	~ProgressReporter ()
virtual void	error (const string &message)
	General-purpose error reporting.
virtual void	info (const string &message)
	Like error(), but for purely informational messages.
virtual void	scanningFile (const FilePart *file, uint64 offInFile)
	Called when the individual files are read.

---

Detailed Description

Class allowing JigdoCache to convey information back to the creator of a JigdoCache object.

---

Constructor & Destructor Documentation

virtual JigdoCache::ProgressReporter::~ProgressReporter

(

)

[inline, virtual]

---

Member Function Documentation

void JigdoCache::ProgressReporter::error

(

const string &

message

)

[virtual]

General-purpose error reporting.

NB: With JigdoCache, you can throw an exception inside this to abort whatever operation JigdoCache is doing. May be called during all checksum-returning methods of FilePart

Reimplemented in AnyReporter.

Referenced by JigdoCache::JigdoCache(), JigdoCache::readFilenames(), and JigdoCache::~JigdoCache().

void JigdoCache::ProgressReporter::info

(

const string &

message

)

[virtual]

Like error(), but for purely informational messages.

Default implementation, just like that of error(), prints message to cerr

Reimplemented in AnyReporter.

void JigdoCache::ProgressReporter::scanningFile	(	const FilePart *	file,
		uint64	offInFile
	)			[virtual]

Called when the individual files are read.

JigdoCache sometimes reads only the first md5BlockLength bytes and sometimes the whole file. This is *only* called when the whole file is read (if the file only consists of one MD5 block, it is also called).

Parameters:

	file	File being scanned, or null if not applicable (Contains filename info). Default version does nothing at all - you need to supply an object of a derived class to JigdoCache() to act on this.
	offInFile	Offset in this file

---

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

• scan.hh
• scan.cc