blob: d77ddf3e43732ccba11955a633cc3528706f9d35 (
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
|
#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/client/ClientImportExport.h"
#include "qpid/client/Handle.h"
#include "qpid/sys/Time.h"
#include <string>
namespace qpid {
namespace client {
template <class> class PrivateImplRef;
}
namespace messaging {
class Address;
class Message;
class MessageListener;
class Sender;
class Receiver;
class SessionImpl;
class Subscription;
/**
* A session represents a distinct 'conversation' which can involve
* sending and receiving messages from different sources and sinks.
*/
class Session : public qpid::client::Handle<SessionImpl>
{
public:
QPID_CLIENT_EXTERN Session(SessionImpl* impl = 0);
QPID_CLIENT_EXTERN Session(const Session&);
QPID_CLIENT_EXTERN ~Session();
QPID_CLIENT_EXTERN Session& operator=(const Session&);
QPID_CLIENT_EXTERN void close();
QPID_CLIENT_EXTERN void commit();
QPID_CLIENT_EXTERN void rollback();
/**
* Acknowledges all outstanding messages that have been received
* by the application on this session.
*/
QPID_CLIENT_EXTERN void acknowledge();
/**
* Rejects the specified message. This will prevent the message
* being redelivered.
*/
QPID_CLIENT_EXTERN void reject(Message&);
QPID_CLIENT_EXTERN void sync();
QPID_CLIENT_EXTERN void flush();
/**
* Returns the number of messages received and waiting to be
* fetched.
*/
QPID_CLIENT_EXTERN uint32_t available();
/**
* 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_CLIENT_EXTERN uint32_t pendingAck();
QPID_CLIENT_EXTERN bool fetch(Message& message, qpid::sys::Duration timeout=qpid::sys::TIME_INFINITE);
QPID_CLIENT_EXTERN Message fetch(qpid::sys::Duration timeout=qpid::sys::TIME_INFINITE);
QPID_CLIENT_EXTERN bool dispatch(qpid::sys::Duration timeout=qpid::sys::TIME_INFINITE);
QPID_CLIENT_EXTERN bool nextReceiver(Receiver&, qpid::sys::Duration timeout=qpid::sys::TIME_INFINITE);
QPID_CLIENT_EXTERN Receiver nextReceiver(qpid::sys::Duration timeout=qpid::sys::TIME_INFINITE);
QPID_CLIENT_EXTERN Sender createSender(const Address& address);
QPID_CLIENT_EXTERN Sender createSender(const std::string& address);
QPID_CLIENT_EXTERN Receiver createReceiver(const Address& address);
QPID_CLIENT_EXTERN Receiver createReceiver(const std::string& address);
private:
friend class qpid::client::PrivateImplRef<Session>;
};
}} // namespace qpid::messaging
#endif /*!QPID_MESSAGING_SESSION_H*/
|
