Queue Class Reference

API between Database and C for tasks. More...

#include <Queue.h>

Inheritance diagram for Queue:

List of all members.

Public Member Functions
	Queue ()
	Queue constructor.
virtual	~Queue ()
	Queue destructor.
virtual list< string >	getInWaitTasks ()=0
	Get all the tasks in wait.
virtual list< string >	getTerminatedTasks ()=0
	Get all the tasks terminated.
virtual list< string >	getInUseTasks ()=0
	Get all the tasks in use.
virtual list< string >	getExpiredTasks ()=0
	Get all the tasks expired.
virtual void	saveTask (Task *aDescriptor)=0
virtual void	updateAging ()=0
virtual void	changeStateToInWait (string &aIdTask)=0
	Permit to put the task in mode in wait.
virtual void	changeStateToInUse (string &aIdTask)=0
	Permit to put the task in mode in use.
virtual void	changeStateToExpired (string &aIdTask)=0
	Permit to put the task in mode expired.
virtual void	changeStateToTerminated (string &aIdTask)=0
	Permit to put the task in mode terminated.
virtual list< string >	orderInWaitTasks ()=0
	Permit to reorder the list of tasks in wait.
virtual bool	extractTaskToExec (PGAgentInfo *aAgent, Task *aDesc, string &aIp, string &aPort)=0
virtual void	updateAdvanceTask (string &aTaskId, string &value)=0
	Permit to update the advance of the task for task in use.
virtual list< vector< string > >	getInformations (string aTaskId)=0
	Permit to get all the informations of a task.
virtual void	addTaskAgentInUse (string aTask, string aAgent)=0
virtual void	deleteTaskAgentInUse (string aAgent, bool aError)=0
virtual void	checkTimeout ()=0
	Permit to verify if the agents are still active. If they aren't, they are delete;.
virtual void	eraseBase ()=0
	Delete all the base.

---

Detailed Description

API between Database and C for tasks.

Author:

Richard DUFOUR

Version:

1.0

Date:

17-03-2006

Bug:

no one known

Warning:

beta version

That interface defines the api of the language C and database for all the interactions with tasks informations. This is a general interface, which must be implements in order to use a specific database.

---

Member Function Documentation

Queue::changeStateToExpired (  string &  aIdTask  )  [pure virtual]

Permit to put the task in mode expired. Parameters: aIdTask  string which is the name of the task. Implemented in PGQueue.

Queue::changeStateToInUse (  string &  aIdTask  )  [pure virtual]

Permit to put the task in mode in use. Parameters: aIdTask  string which is the name of the task. Implemented in PGQueue.

Queue::changeStateToInWait (  string &  aIdTask  )  [pure virtual]

Permit to put the task in mode in wait. Parameters: aIdTask  string which is the name of the task. Implemented in PGQueue.

Queue::changeStateToTerminated (  string &  aIdTask  )  [pure virtual]

Permit to put the task in mode terminated. Parameters: aIdTask  string which is the name of the task. Implemented in PGQueue.

Queue::getExpiredTasks (   )  [pure virtual]

Get all the tasks expired. Returns: list<string> of tasks names. Implemented in PGQueue.

Queue::getInformations (  string  aTaskId  )  [pure virtual]

Permit to get all the informations of a task. Parameters: aTaskId  string is the name of the task. Returns: list<vector<string > > list of informations. Implemented in PGQueue.

Queue::getInUseTasks (   )  [pure virtual]

Get all the tasks in use. Returns: list<string> of tasks names. Implemented in PGQueue.

Queue::getInWaitTasks (   )  [pure virtual]

Get all the tasks in wait. Returns: list<string> of tasks names. Implemented in PGQueue.

Queue::getTerminatedTasks (   )  [pure virtual]

Get all the tasks terminated. Returns: list<string> of tasks names. Implemented in PGQueue.

Queue::orderInWaitTasks (   )  [pure virtual]

Permit to reorder the list of tasks in wait. Returns: list<string> is the list of tasks reordered. Implemented in PGQueue.

Queue::updateAdvanceTask (  string &  aTaskId, string &  value )  [pure virtual]

Permit to update the advance of the task for task in use. Parameters: aTaskId  string is the name of the task. value  string is the new value of the advance. Implemented in PGQueue.

---

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

• dao/src/Queue.h

---