blob: e938f23189dfbaccf460b06632ccf1a31617508f (
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
105
106
107
108
109
110
111
112
113
114
|
#ifndef QPID_MESSAGING_CONNECTION_H
#define QPID_MESSAGING_CONNECTION_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/Handle.h"
#include "qpid/messaging/exceptions.h"
#include "qpid/types/Variant.h"
#include <string>
namespace qpid {
namespace messaging {
#ifndef SWIG
template <class> class PrivateImplRef;
#endif
class ConnectionImpl;
class Session;
/** \ingroup messaging
* A connection represents a network connection to a remote endpoint.
*/
class QPID_MESSAGING_CLASS_EXTERN Connection : public qpid::messaging::Handle<ConnectionImpl>
{
public:
QPID_MESSAGING_EXTERN Connection(ConnectionImpl* impl);
QPID_MESSAGING_EXTERN Connection(const Connection&);
QPID_MESSAGING_EXTERN Connection();
/**
* Current implementation supports the following options:
*
* username
* password
* heartbeat
* tcp-nodelay
* sasl-mechanism
* sasl-service
* sasl-min-ssf
* sasl-max-ssf
* transport
*
* Reconnect behaviour can be controlled through the following options:
*
* reconnect: true/false (enables/disables reconnect entirely)
* reconnect-timeout: number of seconds (give up and report failure after specified time)
* reconnect-limit: n (give up and report failure after specified number of attempts)
* reconnect-interval-min: number of seconds (initial delay between failed reconnection attempts)
* reconnect-interval-max: number of seconds (maximum delay between failed reconnection attempts)
* reconnect-interval: shorthand for setting the same reconnect_interval_min/max
* reconnect-urls: list of alternate urls to try when connecting
*
* The reconnect-interval is the time that the client waits
* for after a failed attempt to reconnect before retrying. It
* starts at the value of the min-retry-interval and is
* doubled every failure until the value of max-retry-interval
* is reached.
*/
QPID_MESSAGING_EXTERN Connection(const std::string& url, const qpid::types::Variant::Map& options = qpid::types::Variant::Map());
/**
* Creates a connection using an option string of the form
* {name:value,name2:value2...}, see above for options supported.
*
* @exception InvalidOptionString if the string does not match the correct syntax
*/
QPID_MESSAGING_EXTERN Connection(const std::string& url, const std::string& options);
QPID_MESSAGING_EXTERN ~Connection();
QPID_MESSAGING_EXTERN Connection& operator=(const Connection&);
QPID_MESSAGING_EXTERN void setOption(const std::string& name, const qpid::types::Variant& value);
QPID_MESSAGING_EXTERN void open();
QPID_MESSAGING_EXTERN bool isOpen();
QPID_MESSAGING_EXTERN bool isOpen() const;
/**
* Closes a connection and all sessions associated with it. An
* opened connection must be closed before the last handle is
* allowed to go out of scope.
*/
QPID_MESSAGING_EXTERN void close();
QPID_MESSAGING_EXTERN Session createTransactionalSession(const std::string& name = std::string());
QPID_MESSAGING_EXTERN Session createSession(const std::string& name = std::string());
QPID_MESSAGING_EXTERN Session getSession(const std::string& name) const;
QPID_MESSAGING_EXTERN std::string getAuthenticatedUsername();
#ifndef SWIG
private:
friend class qpid::messaging::PrivateImplRef<Connection>;
#endif
};
}} // namespace qpid::messaging
#endif /*!QPID_MESSAGING_CONNECTION_H*/
|
