Job::IO Class Reference

Base class for interaction between the outside world and the job. More...

#include <job.hh>

Inheritance diagram for Job::IO:

List of all members.

Public Member Functions
virtual	~IO ()
void	removeListener ()
	Remove yourself from the IOSource you are listening to, if any.
virtual void	job_deleted ()=0
	Called by the IOSource when it is deleted or when a different IO object is registered with it.
virtual void	job_succeeded ()=0
	Called when the job has successfully completed its task.
virtual void	job_failed (const string &message)=0
	Called when the job fails.
virtual void	job_message (const string &message)=0
	Informational message.

---

Detailed Description

Base class for interaction between the outside world and the job.

For example, depending on the IO object you register with a job, you can control the job via a gtk app or from within a command line utility.

An IO class is implemented by anyone interested in the information, and an instance registered with IOSource::addListener(), which appends a pointer to the instance to its list of listening objects. If the listener is deleted, it is *automatically* removed from the list it is on.

The messages are always in valid UTF-8. Their text is *never* "quoted", e.g. "<" is not replaced with "&lt;". Neither do they contain any markup.

The names of all methods here start with "job_". If a child class Job::SomeClass::IO adds any further methods, their name starts with "someClass_". This makes it easy to see which methods are introduced where.

---

Constructor & Destructor Documentation

virtual Job::IO::~IO

(

)

[inline, virtual]

---

Member Function Documentation

void Job::IO::removeListener

(

)

[inline]

Remove yourself from the IOSource you are listening to, if any.

References IListBase::iList_remove().

virtual void Job::IO::job_deleted

(

)

[pure virtual]

Called by the IOSource when it is deleted or when a different IO object is registered with it.

If the IO object considers itself owned by its job, it can delete itself.

Implemented in Job::DataSource::IO, and Job::MakeImageDl::IO.

virtual void Job::IO::job_succeeded

(

)

[pure virtual]

Called when the job has successfully completed its task.

Implemented in Job::DataSource::IO, and Job::MakeImageDl::IO.

virtual void Job::IO::job_failed

(

const string &

message

)

[pure virtual]

Called when the job fails.

The only remaining sensible action after getting this is probably to delete the job object.

Implemented in Job::DataSource::IO, and Job::MakeImageDl::IO.

virtual void Job::IO::job_message

(

const string &

message

)

[pure virtual]

Informational message.

Implemented in Job::DataSource::IO, and Job::MakeImageDl::IO.

---

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

• job/job.hh