summaryrefslogtreecommitdiff
path: root/qpid/cpp/include/qpid/messaging/Connection.h
blob: b5eeeb29802fd790ff17af84dd471b0bfd5538a3 (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
#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 <string>
#include "qpid/messaging/ImportExport.h"
#include "qpid/messaging/Handle.h"
#include "qpid/messaging/Variant.h"

namespace qpid {
namespace messaging {

template <class> class PrivateImplRef;
class ConnectionImpl;
class Session;

struct InvalidOptionString : public qpid::Exception 
{
    InvalidOptionString(const std::string& msg);
};

class Connection : public qpid::messaging::Handle<ConnectionImpl>
{
  public:
    QPID_CLIENT_EXTERN Connection(ConnectionImpl* impl);
    QPID_CLIENT_EXTERN Connection(const Connection&);
    /**
     * Current implementation supports the following options:
     * 
     *     username
     *     password
     *     heartbeat
     *     tcp-nodelay
     *     sasl-mechanism
     *     sasl-min-ssf
     *     sasl-max-ssf
     *     protocol
     *     urls
     * 
     * (note also bounds, locale, max-channels and max-framesize, but
     * not sure whether those should be documented here)
     * 
     * 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
     *
     *     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_CLIENT_EXTERN Connection(const Variant::Map& options = Variant::Map());
    QPID_CLIENT_EXTERN Connection(const std::string& options);
    QPID_CLIENT_EXTERN ~Connection();
    QPID_CLIENT_EXTERN Connection& operator=(const Connection&);
    QPID_CLIENT_EXTERN void setOption(const std::string& name, const Variant& value);
    QPID_CLIENT_EXTERN void open(const std::string& url);
    /**
     * 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_CLIENT_EXTERN void close();
    QPID_CLIENT_EXTERN Session newSession(bool transactional, const std::string& name = std::string());
    QPID_CLIENT_EXTERN Session newSession(const std::string& name = std::string());
    QPID_CLIENT_EXTERN Session newSession(const char* name);

    QPID_CLIENT_EXTERN Session getSession(const std::string& name) const;
  private:
  friend class qpid::messaging::PrivateImplRef<Connection>;

};

}} // namespace qpid::messaging

#endif  /*!QPID_MESSAGING_CONNECTION_H*/