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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
#ifndef QPID_MESSAGING_SESSION_H
#define QPID_MESSAGING_SESSION_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/Duration.h"
#include "qpid/messaging/Handle.h"
#include <string>
namespace qpid {
namespace messaging {
#ifndef SWIG
template <class> class PrivateImplRef;
#endif
class Address;
class Connection;
class Message;
class Sender;
class Receiver;
class SessionImpl;
/** \ingroup messaging
* A session represents a distinct 'conversation' which can involve
* sending and receiving messages to and from different addresses.
*/
class QPID_MESSAGING_CLASS_EXTERN Session : public qpid::messaging::Handle<SessionImpl>
{
public:
QPID_MESSAGING_EXTERN Session(SessionImpl* impl = 0);
QPID_MESSAGING_EXTERN Session(const Session&);
QPID_MESSAGING_EXTERN ~Session();
QPID_MESSAGING_EXTERN Session& operator=(const Session&);
/**
* Closes a session and all associated senders and receivers. An
* opened session should be closed before the last handle to it
* goes out of scope. All a connections sessions can be closed by
* a call to Connection::close().
*/
QPID_MESSAGING_EXTERN void close();
/**
* Commits the sessions transaction.
*
* @exception TransactionAborted if the transaction was rolled back due to an error.
* @exception TransactionUnknown if the connection was lost and the transaction outcome is unknown.
* forcing an automatic rollback.
*/
QPID_MESSAGING_EXTERN void commit();
QPID_MESSAGING_EXTERN void rollback();
/**
* Acknowledges all outstanding messages that have been received
* by the application on this session.
*
* @param sync if true, blocks until the acknowledgement has been
* processed by the server
*/
QPID_MESSAGING_EXTERN void acknowledge(bool sync=false);
/**
* Acknowledges the specified message.
*/
QPID_MESSAGING_EXTERN void acknowledge(Message&, bool sync=false);
/**
* Acknowledges all message up to the specified message.
*/
QPID_MESSAGING_EXTERN void acknowledgeUpTo(Message&, bool sync=false);
/**
* Rejects the specified message. The broker does not redeliver a
* message that has been rejected. Once a message has been
* acknowledged, it can no longer be rejected.
*/
QPID_MESSAGING_EXTERN void reject(Message&);
/**
* Releases the specified message. The broker may redeliver the
* message. Once a message has been acknowledged, it can no longer
* be released.
*/
QPID_MESSAGING_EXTERN void release(Message&);
/**
* Request synchronisation with the server.
*
* @param block if true, this call will block until the server
* confirms completion of all pending operations; if false the
* call will request notification from the server but will return
* before receiving it.
*/
QPID_MESSAGING_EXTERN void sync(bool block=true);
/**
* Returns the total number of messages received and waiting to be
* fetched by all Receivers belonging to this session. This is the
* total number of available messages across all receivers on this
* session.
*/
QPID_MESSAGING_EXTERN uint32_t getReceivable();
/**
* Returns a count of the number of messages received this session
* that have been acknowledged, but for which that acknowledgement
* has not yet been confirmed as processed by the server.
*/
QPID_MESSAGING_EXTERN uint32_t getUnsettledAcks();
/**
* Retrieves the receiver for the next available message. If there
* are no available messages at present the call will block for up
* to the specified timeout waiting for one to arrive. Returns
* true if a message was available at the point of return, in
* which case the passed in receiver reference will be set to the
* receiver for that message or false if no message was available.
*/
QPID_MESSAGING_EXTERN bool nextReceiver(Receiver&, Duration timeout=Duration::FOREVER);
/**
* Returns the receiver for the next available message. If there
* are no available messages at present the call will block for up
* to the specified timeout waiting for one to arrive.
*
* @exception Receiver::NoMessageAvailable if no message became
* available in time.
*/
QPID_MESSAGING_EXTERN Receiver nextReceiver(Duration timeout=Duration::FOREVER);
/**
* Create a new sender through which messages can be sent to the
* specified address.
*
* @exception ResolutionError if there is an error in resolving
* the address
*/
QPID_MESSAGING_EXTERN Sender createSender(const Address& address);
/**
* Create a new sender through which messages can be sent to the
* specified address.
*
* @exception ResolutionError if there is an error in resolving
* the address
*
* @exception MalformedAddress if the syntax of address is not
* valid
*/
QPID_MESSAGING_EXTERN Sender createSender(const std::string& address);
/**
* Create a new receiver through which messages can be received
* from the specified address.
*
* @exception ResolutionError if there is an error in resolving
* the address
*/
QPID_MESSAGING_EXTERN Receiver createReceiver(const Address& address);
/**
* Create a new receiver through which messages can be received
* from the specified address.
*
* @exception ResolutionError if there is an error in resolving
* the address
*
* @exception MalformedAddress if the syntax of address is not
* valid
*/
QPID_MESSAGING_EXTERN Receiver createReceiver(const std::string& address);
/**
* Returns the sender with the specified name.
* @exception KeyError if there is none for that name.
*/
QPID_MESSAGING_EXTERN Sender getSender(const std::string& name) const;
/**
* Returns the receiver with the specified name.
* @exception KeyError if there is none for that name.
*/
QPID_MESSAGING_EXTERN Receiver getReceiver(const std::string& name) const;
/**
* Returns a handle to the connection this session is associated
* with.
*/
QPID_MESSAGING_EXTERN Connection getConnection() const;
/**
* @returns true if the session has been rendered invalid by some
* exception, false if it is valid for use.
*/
QPID_MESSAGING_EXTERN bool hasError();
/**
* If the session has been rendered invalid by some exception,
* this method will result in that exception being thrown on
* calling this method.
*/
QPID_MESSAGING_EXTERN void checkError();
#ifndef SWIG
private:
friend class qpid::messaging::PrivateImplRef<Session>;
#endif
};
}} // namespace qpid::messaging
#endif /*!QPID_MESSAGING_SESSION_H*/
|
