blob: 64fc4288afe601a7272f58baf8b61e9af7343d4a (
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
|
/*
*
* 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 _Consumer_
#define _Consumer_
#include "qpid/broker/QueueCursor.h"
#include "qpid/broker/OwnershipToken.h"
#include <boost/shared_ptr.hpp>
#include <string>
namespace qpid {
namespace broker {
class DeliveryRecord;
class Message;
class Queue;
class QueueListeners;
/**
* Base class for consumers which represent a subscription to a queue.
*/
class Consumer : public QueueCursor {
const bool acquires;
// inListeners allows QueueListeners to efficiently track if this
// instance is registered for notifications without having to
// search its containers
bool inListeners;
// the name is generated by broker and is unique within broker scope. It is not
// provided or known by the remote Consumer.
const std::string name;
public:
typedef boost::shared_ptr<Consumer> shared_ptr;
Consumer(const std::string& _name, SubscriptionType type)
: QueueCursor(type), acquires(type == CONSUMER), inListeners(false), name(_name) {}
virtual ~Consumer(){}
bool preAcquires() const { return acquires; }
const std::string& getName() const { return name; }
virtual bool deliver(const QueueCursor& cursor, const Message& msg) = 0;
virtual void notify() = 0;
virtual bool filter(const Message&) { return true; }
virtual bool accept(const Message&) { return true; }
virtual OwnershipToken* getSession() = 0;
virtual void cancel() = 0;
/** Returns true if the browser wants acquired as well as
* available messages.
*/
virtual bool browseAcquired() const { return false; };
/** Called when the peer has acknowledged receipt of the message.
* Not to be confused with accept() above, which is asking if
* this consumer will consume/browse the message.
*/
virtual void acknowledged(const DeliveryRecord&) = 0;
/** Called if queue has been deleted, if true suppress the error message.
* Used by HA ReplicatingSubscriptions where such errors are normal.
*/
virtual bool hideDeletedError() { return false; }
protected:
//framing::SequenceNumber position;
private:
friend class QueueListeners;
};
}}
#endif
|
