[b5ebb5] | 1 | /*
|
---|
| 2 | * FragmentQueue.hpp
|
---|
| 3 | *
|
---|
| 4 | * Created on: Oct 19, 2011
|
---|
| 5 | * Author: heber
|
---|
| 6 | */
|
---|
| 7 |
|
---|
| 8 | #ifndef FRAGMENTQUEUE_HPP_
|
---|
| 9 | #define FRAGMENTQUEUE_HPP_
|
---|
| 10 |
|
---|
| 11 | // include config.h
|
---|
| 12 | #ifdef HAVE_CONFIG_H
|
---|
| 13 | #include <config.h>
|
---|
| 14 | #endif
|
---|
| 15 |
|
---|
| 16 | #include <deque>
|
---|
| 17 | #include <map>
|
---|
[9875cc] | 18 | #include <vector>
|
---|
[b5ebb5] | 19 |
|
---|
[d6b12c] | 20 | #include "CodePatterns/Observer/Observable.hpp"
|
---|
| 21 |
|
---|
[b5ebb5] | 22 | #include "types.hpp"
|
---|
[f0834d] | 23 | #include "Jobs/FragmentJob.hpp"
|
---|
[7670865] | 24 | #include "Results/FragmentResult.hpp"
|
---|
[b5ebb5] | 25 |
|
---|
[02f346] | 26 | class FragmentQueueTest;
|
---|
[b5ebb5] | 27 |
|
---|
| 28 | /** This class contains a deque for temporarily storing the FragmentJob
|
---|
[b0b64c] | 29 | * instances until they are received by the server. Also all results are
|
---|
[b5ebb5] | 30 | * contained herein.
|
---|
| 31 | */
|
---|
[d6b12c] | 32 | class FragmentQueue : public Observable
|
---|
[b5ebb5] | 33 | {
|
---|
[02f346] | 34 | friend class FragmentQueueTest;
|
---|
[b5ebb5] | 35 | public:
|
---|
| 36 | FragmentQueue();
|
---|
| 37 | ~FragmentQueue();
|
---|
| 38 |
|
---|
[d76161] | 39 | /** Channels for this observable.
|
---|
| 40 | *
|
---|
| 41 | * \note Be especially cautious of cyclic updates here as the updates are
|
---|
| 42 | * used by \ref FragmentScheduler to send new jobs to idle workers!
|
---|
| 43 | * If e.g. JobRemoved is added, then the popping of the job inside
|
---|
| 44 | * the callback will cause a cycle in the update, as the notification
|
---|
| 45 | * for JobAdded is not yet removed because we are still inside the
|
---|
| 46 | * callback!
|
---|
| 47 | */
|
---|
[d6b12c] | 48 | enum NotificationType {
|
---|
| 49 | JobAdded,
|
---|
| 50 | NotificationType_MAX // denotes the maximum of available notification types
|
---|
| 51 | };
|
---|
| 52 |
|
---|
[b5ebb5] | 53 | // entering jobs into queue
|
---|
[78ad7d] | 54 | void pushJob(FragmentJob::ptr job);
|
---|
| 55 | void pushJobs(std::vector<FragmentJob::ptr> &_jobs);
|
---|
| 56 | FragmentJob::ptr popJob();
|
---|
[12d15a] | 57 | bool isJobPresent() const;
|
---|
[fe95b7] | 58 | void resubmitJob(const JobId_t jobid);
|
---|
[b5ebb5] | 59 |
|
---|
| 60 | // querying for results
|
---|
| 61 | bool isResultPresent(JobId_t jobid) const;
|
---|
[35f587] | 62 | FragmentResult::ptr getResult(JobId_t jobid);
|
---|
| 63 | void pushResult(FragmentResult::ptr &result);
|
---|
| 64 | std::vector<FragmentResult::ptr> getAllResults();
|
---|
[b9c486] | 65 |
|
---|
[8ee5ac] | 66 | size_t getDoneJobs() const;
|
---|
[bf56f6] | 67 | size_t getPresentJobs() const;
|
---|
[b5ebb5] | 68 |
|
---|
| 69 | private:
|
---|
[35f587] | 70 | bool isPresentResult(const FragmentResult::ptr result) const;
|
---|
[b9c486] | 71 |
|
---|
[12d15a] | 72 | //!> result that takes place in ResultQueue after job has arrived before it has been popped.
|
---|
[35f587] | 73 | static FragmentResult::ptr NoResult;
|
---|
[12d15a] | 74 | //!> result that takes place in ResultQueue until real result has arrived.
|
---|
[35f587] | 75 | static FragmentResult::ptr NoResultQueued;
|
---|
[b5ebb5] | 76 | //!> result that takes place in ResultQueue after real result has been delivered.
|
---|
[35f587] | 77 | static FragmentResult::ptr ResultDelivered;
|
---|
[fe95b7] | 78 | //!> maximum number of attempts before job is not resubmitted
|
---|
| 79 | static size_t Max_Attempts;
|
---|
[b5ebb5] | 80 |
|
---|
[78ad7d] | 81 | typedef std::deque<FragmentJob::ptr> JobQueue;
|
---|
[fe95b7] | 82 | typedef std::map<JobId_t, FragmentJob::ptr> BackupMap;
|
---|
[35f587] | 83 | typedef std::map<JobId_t, FragmentResult::ptr> ResultMap;
|
---|
[fe95b7] | 84 | typedef std::map<JobId_t, size_t> AttemptsMap;
|
---|
[b5ebb5] | 85 |
|
---|
| 86 | //!> queue for all jobs
|
---|
| 87 | JobQueue jobs;
|
---|
[fe95b7] | 88 | //!> backup map for popped jobs that workers failed to calculate
|
---|
| 89 | BackupMap backup;
|
---|
[b5ebb5] | 90 | //!> map for all results that have been polled by the server
|
---|
| 91 | ResultMap results;
|
---|
[fe95b7] | 92 | //!> map for all jobs that had to be resubmitted storing how often this has been tried
|
---|
| 93 | AttemptsMap attempts;
|
---|
[b5ebb5] | 94 | };
|
---|
| 95 |
|
---|
| 96 |
|
---|
| 97 | #endif /* FRAGMENTQUEUE_HPP_ */
|
---|