hydroiceutil::Job Class Reference

#include <jobqueue.h>

Inherited by hydroiceutil::EventJob, InfiniteJob, orcaqcm::GetComponentsJob, and TestJob.

List of all members.

Public Member Functions
virtual void	execute ()=0
virtual std::string	toString () const =0
	Returns a text description of the job.
virtual int	expectedDuration () const
void	cancel ()
bool	isCancelled ()
	Returns TRUE if the job is in Cancelled state, FALSE otherwise.
virtual bool	isStopping ()
Public Attributes
bool	isTracable_

---

Detailed Description

A request to perform an operation which may take a long time (eg network job).

Job implementation must interrupt execution when the the job is cancelled. Check isCancelled() periodically.

---

Member Function Documentation

void hydroiceutil::Job::cancel

(

)

Cancel this job. Execution should stop. What to do in this case is job-dependent. Depending on the state in which the job is finished, it may be necessary to inform somebody about what did and did not happen.

virtual void hydroiceutil::Job::execute

(

)

[pure virtual]

Implement this function and do your job in it. It will be done by one of the 'workers' from the queue's thread pool.

Implemented in hydroiceutil::EventJob, and orcaqcm::GetComponentsJob.

virtual int hydroiceutil::Job::expectedDuration

(

)

const [inline, virtual]

Returns expected duration of the job in [ms]. Returns a negative number if the job duration is infinite or unknown (default). This information can be used by the JobQueue for detection of stalled jobs.

Reimplemented in hydroiceutil::EventJob.

virtual bool hydroiceutil::Job::isStopping

(

)

[inline, virtual]

Convenience function for compatibility with Stoppable interface. Returns the same result as isCancelled().

---

Member Data Documentation

bool hydroiceutil::Job::isTracable_

If TRUE, start and end of job execution are traced to info(). Default is FALSE. This is a debugging tool, use with care! Not thread safe. Normal usage: create a job, set isTracable_ to TRUE before adding the job to the job queue and do not modify it again.

---

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

• jobqueue.h
• jobqueue.cpp