blob: 090393c160b8f55adc1bb2d63dee399144692eae (
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
|
#ifndef _broker_MessageDistributor_h
#define _broker_MessageDistributor_h
/*
*
* 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.
*
*/
/** Abstraction used by Queue to determine the next "most desirable" message to provide to
* a particular consuming client
*/
#include "qpid/broker/Consumer.h"
namespace qpid {
namespace broker {
struct QueuedMessage;
class MessageDistributor
{
public:
virtual ~MessageDistributor() {};
/** Locking Note: all methods assume the caller is holding the Queue::messageLock
* during the method call.
*/
/** Determine the next message available for consumption by the consumer
* @param consumer the consumer that needs a message to consume
* @param next set to the next message that the consumer may consume.
* @return true if message is available and next is set
*/
virtual bool nextConsumableMessage( Consumer::shared_ptr& consumer,
QueuedMessage& next ) = 0;
/** Allow the comsumer to take ownership of the given message.
* @param consumer the name of the consumer that is attempting to acquire the message
* @param qm the message to be acquired, previously returned from nextConsumableMessage()
* @return true if ownership is permitted, false if ownership cannot be assigned.
*/
virtual bool allocate( const std::string& consumer,
const QueuedMessage& target) = 0;
/** Determine the next message available for browsing by the consumer
* @param consumer the consumer that is browsing the queue
* @param next set to the next message that the consumer may browse.
* @return true if a message is available and next is returned
*/
virtual bool nextBrowsableMessage( Consumer::shared_ptr& consumer,
QueuedMessage& next ) = 0;
/** hook to add any interesting management state to the status map */
virtual void query(qpid::types::Variant::Map&) const = 0;
};
}}
#endif
|
