Qpid Proton C++ API  0.18.1
connection_options.hpp
Go to the documentation of this file.
1 #ifndef PROTON_CONNECTION_OPTIONS_H
2 #define PROTON_CONNECTION_OPTIONS_H
3 
4 /*
5  *
6  * Licensed to the Apache Software Foundation (ASF) under one
7  * or more contributor license agreements. See the NOTICE file
8  * distributed with this work for additional information
9  * regarding copyright ownership. The ASF licenses this file
10  * to you under the Apache License, Version 2.0 (the
11  * "License"); you may not use this file except in compliance
12  * with the License. You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing,
17  * software distributed under the License is distributed on an
18  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19  * KIND, either express or implied. See the License for the
20  * specific language governing permissions and limitations
21  * under the License.
22  *
23  */
24 
25 #include "./duration.hpp"
26 #include "./fwd.hpp"
27 #include "./internal/config.hpp"
28 #include "./internal/export.hpp"
29 #include "./internal/pn_unique_ptr.hpp"
30 #include "./types_fwd.hpp"
31 
32 #include <proton/type_compat.h>
33 
34 #include <vector>
35 #include <string>
36 
39 
40 struct pn_connection_t;
41 
42 namespace proton {
43 
66  public:
68  PN_CPP_EXTERN connection_options();
69 
71  PN_CPP_EXTERN connection_options(class messaging_handler& h);
72 
74  PN_CPP_EXTERN connection_options(const connection_options&);
75 
76  PN_CPP_EXTERN ~connection_options();
77 
79  PN_CPP_EXTERN connection_options& operator=(const connection_options&);
80 
81  // XXX add C++11 move operations - Still relevant, and applies to all options
82 
87  PN_CPP_EXTERN connection_options& handler(class messaging_handler&);
88 
90  PN_CPP_EXTERN connection_options& max_frame_size(uint32_t max);
91 
93  PN_CPP_EXTERN connection_options& max_sessions(uint16_t max);
94 
101  PN_CPP_EXTERN connection_options& idle_timeout(duration);
102 
104  PN_CPP_EXTERN connection_options& container_id(const std::string& id);
105 
112  PN_CPP_EXTERN connection_options& virtual_host(const std::string& name);
113 
122  PN_CPP_EXTERN connection_options& user(const std::string&);
123 
128  PN_CPP_EXTERN connection_options& password(const std::string&);
129 
131  PN_CPP_EXTERN connection_options& ssl_client_options(const class ssl_client_options&);
132 
134  PN_CPP_EXTERN connection_options& ssl_server_options(const class ssl_server_options&);
135 
137  PN_CPP_EXTERN connection_options& sasl_enabled(bool);
138 
142  PN_CPP_EXTERN connection_options& sasl_allow_insecure_mechs(bool);
143 
145  PN_CPP_EXTERN connection_options& sasl_allowed_mechs(const std::string&);
146 
148  PN_CPP_EXTERN connection_options& sasl_config_name(const std::string&);
149 
151  PN_CPP_EXTERN connection_options& sasl_config_path(const std::string&);
152 
154  PN_CPP_EXTERN connection_options& reconnect(reconnect_options &);
155 
157  PN_CPP_EXTERN connection_options& update(const connection_options& other);
158 
159  private:
160  void apply_unbound(connection&) const;
161  void apply_bound(connection&) const;
162  messaging_handler* handler() const;
163 
164  class impl;
165  internal::pn_unique_ptr<impl> impl_;
166 
168  friend class container;
169  friend class io::connection_driver;
170  friend class connection;
172 };
173 
174 } // proton
175 
176 #endif // PROTON_CONNECTION_OPTIONS_H
Unsettled API - SSL configuration for inbound connections.
Definition: ssl.hpp:149
A top-level container of connections, sessions, and links.
Definition: container.hpp:55
Unsettled API - Options for reconnect and failover after connection loss.
Definition: reconnect_options.hpp:49
connection_options & max_sessions(uint16_t max)
Set the maximum number of open sessions. The default is 32767.
connection_options & update(const connection_options &other)
Update option values from values set in other.
A span of time in milliseconds.
Definition: duration.hpp:39
Forward declarations.
connection_options & sasl_allowed_mechs(const std::string &)
Specify the allowed mechanisms for use on the connection.
connection_options & sasl_config_path(const std::string &)
Unsettled API - Set the SASL configuration path.
connection_options & reconnect(reconnect_options &)
Unsettled API - Set reconnect and failover options.
A connection to a remote AMQP peer.
Definition: connection.hpp:43
Options for creating a connection.
Definition: connection_options.hpp:65
connection_options()
Create an empty set of options.
connection_options & ssl_server_options(const class ssl_server_options &)
Set SSL server options.
A span of time in milliseconds.
Unsettled API - SSL configuration for outbound connections.
Definition: ssl.hpp:176
connection_options & handler(class messaging_handler &)
Set a connection handler.
connection_options & sasl_enabled(bool)
Enable or disable SASL.
connection_options & ssl_client_options(const class ssl_client_options &)
Set SSL client options.
Forward declarations for Proton types used to represent AMQP types.
connection_options & sasl_allow_insecure_mechs(bool)
Force the enabling of SASL mechanisms that disclose cleartext passwords over the connection.
connection_options & idle_timeout(duration)
Set the idle timeout.
connection_options & password(const std::string &)
Set the password used to authenticate the connection.
connection_options & user(const std::string &)
Set the user name used to authenticate the connection.
connection_options & operator=(const connection_options &)
Copy options.
A handler for Proton messaging events.
Definition: messaging_handler.hpp:62
connection_options & max_frame_size(uint32_t max)
Set the maximum frame size. It is unlimited by default.
connection_options & virtual_host(const std::string &name)
Set the virtual host name for the connection.
connection_options & container_id(const std::string &id)
Set the container ID.
connection_options & sasl_config_name(const std::string &)
Unsettled API - Set the SASL configuration name.
Unsettled API - An AMQP driver for a single connection.
Definition: connection_driver.hpp:93
The main Proton namespace.
Definition: annotation_key.hpp:33