Qpid Proton C++  0.17.0
connection_options.hpp
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 "./fwd.hpp"
26 #include "./types_fwd.hpp"
27 #include "./internal/config.hpp"
28 #include "./internal/export.hpp"
29 #include "./internal/pn_unique_ptr.hpp"
30 #include "./duration.hpp"
31 
32 #include <proton/type_compat.h>
33 
34 #include <vector>
35 #include <string>
36 
37 struct pn_connection_t;
38 
39 namespace proton {
40 
63  public:
65  PN_CPP_EXTERN connection_options();
66 
68  PN_CPP_EXTERN connection_options(class messaging_handler& h);
69 
71  PN_CPP_EXTERN connection_options(const connection_options&);
72 
73  PN_CPP_EXTERN ~connection_options();
74 
76  PN_CPP_EXTERN connection_options& operator=(const connection_options&);
77 
78  // XXX add C++11 move operations - Still relevant, and applies to all options
79 
83  PN_CPP_EXTERN connection_options& handler(class messaging_handler&);
84 
86  PN_CPP_EXTERN connection_options& max_frame_size(uint32_t max);
87 
89  PN_CPP_EXTERN connection_options& max_sessions(uint16_t max);
90 
91  // XXX document relationship to heartbeat interval
93  PN_CPP_EXTERN connection_options& idle_timeout(duration);
94 
96  PN_CPP_EXTERN connection_options& container_id(const std::string &id);
97 
104  PN_CPP_EXTERN connection_options& virtual_host(const std::string &name);
105 
112  PN_CPP_EXTERN connection_options& user(const std::string& user);
113 
115  PN_CPP_EXTERN connection_options& password(const std::string& pass);
116 
118  // XXX settle questions about reconnect_timer - consider simply
119  // reconnect_options and making reconnect_timer internal
121  PN_CPP_EXTERN connection_options& reconnect(const reconnect_timer &);
123 
125  PN_CPP_EXTERN connection_options& ssl_client_options(const class ssl_client_options &);
126 
128  PN_CPP_EXTERN connection_options& ssl_server_options(const class ssl_server_options &);
129 
131  PN_CPP_EXTERN connection_options& sasl_enabled(bool);
132 
136  PN_CPP_EXTERN connection_options& sasl_allow_insecure_mechs(bool);
137 
139  PN_CPP_EXTERN connection_options& sasl_allowed_mechs(const std::string &);
140 
142  PN_CPP_EXTERN connection_options& sasl_config_name(const std::string &);
143 
145  PN_CPP_EXTERN connection_options& sasl_config_path(const std::string &);
146 
148  PN_CPP_EXTERN connection_options& update(const connection_options& other);
149 
150  private:
151  void apply_unbound(connection&) const;
152  void apply_bound(connection&) const;
153  messaging_handler* handler() const;
154 
155  class impl;
156  internal::pn_unique_ptr<impl> impl_;
157 
159  friend class container;
160  friend class io::connection_driver;
161  friend class connection;
163 };
164 
165 } // proton
166 
167 #endif // PROTON_CONNECTION_OPTIONS_H
Experimental - SSL configuration for inbound connections.
Definition: ssl.hpp:145
A top-level container of connections, sessions, senders, and receivers.
Definition: container.hpp:50
connection_options & user(const std::string &user)
Set the user name used to authenticate the connection.
connection_options & max_sessions(uint16_t max)
Set the maximum number of open sessions.
connection_options & update(const connection_options &other)
Update option values from values set in other.
A span of time in milliseconds.
Definition: duration.hpp:36
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 &)
Experimental - Set the SASL configuration path.
A connection to a remote AMQP peer.
Definition: connection.hpp:40
Options for creating a connection.
Definition: connection_options.hpp:62
connection_options()
Create an empty set of options.
connection_options & ssl_server_options(const class ssl_server_options &)
Set SSL server options.
Experimental - SSL configuration for outbound connections.
Definition: ssl.hpp:172
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 all the C++ types used by Proton to represent AMQP types.
connection_options & sasl_allow_insecure_mechs(bool)
Force the enabling of SASL mechanisms that disclose clear text passwords over the connection...
connection_options & password(const std::string &pass)
Set the password used to authenticate the connection.
connection_options & idle_timeout(duration)
Set the idle timeout.
connection_options & operator=(const connection_options &)
Copy options.
A handler for Proton messaging events.
Definition: messaging_handler.hpp:59
connection_options & max_frame_size(uint32_t max)
Set the maximum frame size.
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 &)
Experimental - Set the SASL configuration name.
Experimental - An AMQP driver for a single connection.
Definition: connection_driver.hpp:94
The main Proton namespace.
Definition: annotation_key.hpp:30