blob: 0c9f08465d3ef0757d57b57d5fd19f79db0a3a87 (
plain)
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef SD_SLIDESORTER_REQUEST_QUEUE_HXX
#define SD_SLIDESORTER_REQUEST_QUEUE_HXX
#include "SlsRequestPriorityClass.hxx"
#include "cache/SlsCacheContext.hxx"
#include "taskpane/SlideSorterCacheDisplay.hxx"
#include <drawdoc.hxx>
#include "osl/mutex.hxx"
namespace sd { namespace slidesorter { namespace cache {
class RequestData;
/** The request queue stores requests that are described by the RequestData
sorted according to priority class and then priority.
*/
class RequestQueue
{
public:
RequestQueue (const SharedCacheContext& rpCacheContext);
~RequestQueue (void);
/** Insert a request with highest or lowest priority in its priority
class. When the request is already present then it is first
removed. This effect is then a re-prioritization.
@param rRequestData
The request.
@param eRequestClass
The priority class in which to insert the request with highest
or lowest priority.
@param bInsertWithHighestPriority
When this flag is <TRUE/> the request is inserted with highes
priority in its class. When <FALSE/> the request is inserted
with lowest priority.
*/
void AddRequest (
CacheKey aKey,
RequestPriorityClass eRequestClass,
bool bInsertWithHighestPriority = false);
/** Remove the specified request from the queue.
@param rRequestData
It is OK when the specified request is not a member of the
queue.
@return
Returns <TRUE/> when the request has been successfully been
removed from the queue. Otherwise, e.g. because the request was
not a member of the queue, <FALSE/> is returned.
*/
bool RemoveRequest (CacheKey aKey);
/** Change the priority class of the specified request.
*/
void ChangeClass (
CacheKey aKey,
RequestPriorityClass eNewRequestClass);
/** Get the request with the highest priority int the highest priority class.
*/
CacheKey GetFront (void);
// For debugging.
RequestPriorityClass GetFrontPriorityClass (void);
/** Really a synonym for RemoveRequest(GetFront());
*/
void PopFront (void);
/** Returns <TRUE/> when there is no element in the queue.
*/
bool IsEmpty (void);
/** Remove all requests from the queue. This resets the minimum and
maximum priorities to their default values.
*/
void Clear (void);
/** Return the mutex that guards the access to the priority queue.
*/
::osl::Mutex& GetMutex (void);
private:
::osl::Mutex maMutex;
class Container;
::boost::scoped_ptr<Container> mpRequestQueue;
SharedCacheContext mpCacheContext;
/** A lower bound of the lowest priority of all elements in the queues.
The start value is 0. It is assigned and then decreased every time
when an element is inserted or marked as the request with lowest
priority.
*/
int mnMinimumPriority;
/** An upper bound of the highest priority of all elements in the queues.
The start value is 1. It is assigned and then increased every time
when an element is inserted or marked as the request with highest
priority.
*/
int mnMaximumPriority;
};
} } } // end of namespace ::sd::slidesorter::cache
#endif
|
