1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
/*
* This file is part of buteo-syncfw package
*
* Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
*
* Contact: Sateesh Kavuri <sateesh.kavuri@nokia.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* version 2.1 as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*
*/
#ifndef SYNCQUEUE_H
#define SYNCQUEUE_H
#include <QQueue>
namespace Buteo {
class SyncSession;
/*! \brief Class for queuing sync sessions.
*
* The queue is sorted every time when new items are added to it, so that
* the sync sessions with highest priority will be at the front of the queue.
*/
class SyncQueue
{
public:
/*! \brief Adds a new profile to the queue. Queue is sorted automatically.
*
* \param aSession Session to add to queue
*/
void enqueue(SyncSession *aSession);
/*! \brief Removes the sync session corresponding to the profile name and returns it.
*
* \return The removed item. NULL if the queue was empty.
*/
SyncSession *dequeue(const QString &aProfileName);
/*! \brief Removes the first item from the queue and returns it.
*
* \return The removed item. NULL if the queue was empty.
*/
SyncSession *dequeue();
/*! \brief Returns the first item in the queue but does not remove it.
*
* \return First item of the queue. NULL if the queue is empty.
*/
SyncSession *head();
/*! \brief Checks if the queue is empty.
*
* \return Is the queue empty.
*/
bool isEmpty() const;
/*! \brief Current size of the sync queue.
*
* \return Number of elements in the sync queue.
*/
int size() const;
/*! \brief Checks if a profile with the given name is in the queue.
*
* \return Is the profile in the queue.
*/
bool contains(const QString &aProfileName) const;
/*! \brief Returns as a const reference, the list of all SyncSessions
* currently queued.
*
* \return Is the profile in the queue.
*/
const QList<SyncSession *> &getQueuedSyncSessions() const;
private:
void sort();
QQueue<SyncSession *> iItems;
};
}
#endif // SYNCQUEUE_H
|
