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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
#ifndef QPID_MESSAGING_RECEIVER_H
#define QPID_MESSAGING_RECEIVER_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.
*
*/
#include "qpid/messaging/ImportExport.h"
#include "qpid/messaging/exceptions.h"
#include "qpid/messaging/Handle.h"
#include "qpid/messaging/Duration.h"
namespace qpid {
namespace messaging {
#ifndef SWIG
template <class> class PrivateImplRef;
#endif
class Message;
class ReceiverImpl;
class Session;
/** \ingroup messaging
* Interface through which messages are received.
*/
class QPID_MESSAGING_CLASS_EXTERN Receiver : public qpid::messaging::Handle<ReceiverImpl>
{
public:
QPID_MESSAGING_EXTERN Receiver(ReceiverImpl* impl = 0);
QPID_MESSAGING_EXTERN Receiver(const Receiver&);
QPID_MESSAGING_EXTERN ~Receiver();
QPID_MESSAGING_EXTERN Receiver& operator=(const Receiver&);
/**
* Retrieves a message from this receivers local queue, or waits
* for upto the specified timeout for a message to become
* available.
*/
QPID_MESSAGING_EXTERN bool get(Message& message, Duration timeout=Duration::FOREVER);
/**
* Retrieves a message from this receivers local queue, or waits
* for up to the specified timeout for a message to become
* available.
*
* @exception NoMessageAvailable if there is no message to give
* after waiting for the specified timeout, or if the Receiver is
* closed, in which case isClose() will be true.
*/
QPID_MESSAGING_EXTERN Message get(Duration timeout=Duration::FOREVER);
/**
* Retrieves a message for this receivers subscription or waits
* for up to the specified timeout for one to become
* available. Unlike get() this method will check with the server
* that there is no message for the subscription this receiver is
* serving before returning false.
*
* @return false if there is no message to give after
* waiting for the specified timeout, or if the Receiver is
* closed, in which case isClose() will be true.
*/
QPID_MESSAGING_EXTERN bool fetch(Message& message, Duration timeout=Duration::FOREVER);
/**
* Retrieves a message for this receivers subscription or waits
* for up to the specified timeout for one to become
* available. Unlike get() this method will check with the server
* that there is no message for the subscription this receiver is
* serving before throwing an exception.
*
* @exception NoMessageAvailable if there is no message to give
* after waiting for the specified timeout, or if the Receiver is
* closed, in which case isClose() will be true.
*/
QPID_MESSAGING_EXTERN Message fetch(Duration timeout=Duration::FOREVER);
/**
* Sets the capacity for the receiver. The capacity determines how
* many incoming messages can be held in the receiver before being
* requested by a client via fetch() (or pushed to a listener).
*/
QPID_MESSAGING_EXTERN void setCapacity(uint32_t);
/**
* @return the capacity of the receiver. The capacity determines
* how many incoming messages can be held in the receiver before
* being requested by a client via fetch() (or pushed to a
* listener).
*/
QPID_MESSAGING_EXTERN uint32_t getCapacity();
/**
* @return the number of messages received and waiting to be
* fetched.
*/
QPID_MESSAGING_EXTERN uint32_t getAvailable();
/**
* @return a count of the number of messages received on this
* receiver that have been acknowledged, but for which that
* acknowledgement has not yet been confirmed as processed by the
* server.
*/
QPID_MESSAGING_EXTERN uint32_t getUnsettled();
/**
* Cancels this receiver.
*/
QPID_MESSAGING_EXTERN void close();
/**
* Return true if the receiver was closed by a call to close()
*/
QPID_MESSAGING_EXTERN bool isClosed() const;
/**
* Returns the name of this receiver.
*/
QPID_MESSAGING_EXTERN const std::string& getName() const;
/**
* Returns a handle to the session associated with this receiver.
*/
QPID_MESSAGING_EXTERN Session getSession() const;
#ifndef SWIG
private:
friend class qpid::messaging::PrivateImplRef<Receiver>;
#endif
};
}} // namespace qpid::messaging
#endif /*!QPID_MESSAGING_RECEIVER_H*/
|
