Job::IO Class ReferenceBase class for interaction between the outside world and the job. More...
Public Member Functions
|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 DescriptionBase 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 "<". 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
Member Function Documentation
|virtual void Job::IO::job_deleted||(||)||
|virtual void Job::IO::job_succeeded||(||)||
|virtual void Job::IO::job_failed||(||const string &||message||)||
|virtual void Job::IO::job_message||(||const string &||message||)||
The documentation for this class was generated from the following file:
Generated on Tue Sep 23 14:27:43 2008 for jigdo by 1.5.6