Qpid Proton C++ API  0.34.0
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 "./symbol.hpp"
31 #include "./types_fwd.hpp"
32 
33 #include <proton/type_compat.h>
34 
35 #include <map>
36 #include <vector>
37 #include <string>
38 
41 
42 struct pn_connection_t;
43 struct pn_transport_t;
44 
45 namespace proton {
46 
69  public:
71  PN_CPP_EXTERN connection_options();
72 
74  PN_CPP_EXTERN connection_options(class messaging_handler& h);
75 
77  PN_CPP_EXTERN connection_options(const connection_options&);
78 
79  PN_CPP_EXTERN ~connection_options();
80 
83 
84  // XXX add C++11 move operations - Still relevant, and applies to all options
85 
91 
93  PN_CPP_EXTERN connection_options& max_frame_size(uint32_t max);
94 
96  PN_CPP_EXTERN connection_options& max_sessions(uint16_t max);
97 
105 
107  PN_CPP_EXTERN connection_options& container_id(const std::string& id);
108 
115  PN_CPP_EXTERN connection_options& virtual_host(const std::string& name);
116 
125  PN_CPP_EXTERN connection_options& user(const std::string&);
126 
131  PN_CPP_EXTERN connection_options& password(const std::string&);
132 
135 
138 
140  PN_CPP_EXTERN connection_options& sasl_enabled(bool);
141 
146 
158  PN_CPP_EXTERN connection_options& sasl_allowed_mechs(const std::string&);
159 
161  PN_CPP_EXTERN connection_options& offered_capabilities(const std::vector<symbol>&);
162 
164  PN_CPP_EXTERN connection_options& desired_capabilities(const std::vector<symbol>&);
165 
167  PN_CPP_EXTERN connection_options& properties(const std::map<symbol, value>&);
168 
170  PN_CPP_EXTERN connection_options& sasl_config_name(const std::string&);
171 
173  PN_CPP_EXTERN connection_options& sasl_config_path(const std::string&);
174 
180 
194  PN_CPP_EXTERN connection_options& reconnect_url(const std::string&);
195 
202  PN_CPP_EXTERN connection_options& failover_urls(const std::vector<std::string>&);
203 
205  PN_CPP_EXTERN connection_options& update(const connection_options& other);
206 
207  private:
208  void apply_unbound(connection&) const;
209  void apply_reconnect_urls(pn_connection_t* pnc) const;
210  void apply_unbound_client(pn_transport_t*) const;
211  void apply_unbound_server(pn_transport_t*) const;
212  messaging_handler* handler() const;
213 
214  class impl;
215  internal::pn_unique_ptr<impl> impl_;
216 
218  friend class container;
219  friend class io::connection_driver;
220  friend class connection;
222 };
223 
224 } // proton
225 
226 #endif // PROTON_CONNECTION_OPTIONS_H
proton::connection_options::sasl_enabled
connection_options & sasl_enabled(bool)
Enable or disable SASL.
proton::io::connection_driver
Unsettled API - An AMQP driver for a single connection.
Definition: connection_driver.hpp:94
proton::connection_options::sasl_allow_insecure_mechs
connection_options & sasl_allow_insecure_mechs(bool)
Force the enabling of SASL mechanisms that disclose cleartext passwords over the connection.
symbol.hpp
A string that represents the AMQP symbol type.
proton::connection_options::reconnect_url
connection_options & reconnect_url(const std::string &)
Unsettled API - Set reconnect URL.
proton::connection_options::update
connection_options & update(const connection_options &other)
Update option values from values set in other.
proton::connection_options::password
connection_options & password(const std::string &)
Set the password used to authenticate the connection.
proton::container
A top-level container of connections, sessions, and links.
Definition: container.hpp:50
proton::connection_options::reconnect
connection_options & reconnect(const reconnect_options &)
Unsettled API - Set reconnect timing options.
proton::ssl_client_options
Unsettled API - SSL configuration for outbound connections.
Definition: ssl.hpp:158
fwd.hpp
Forward declarations.
proton::connection_options::max_frame_size
connection_options & max_frame_size(uint32_t max)
Set the maximum frame size. It is unlimited by default.
proton::reconnect_options
Unsettled API - Options for reconnect and failover after connection loss.
Definition: reconnect_options.hpp:49
proton::connection_options::ssl_client_options
connection_options & ssl_client_options(const class ssl_client_options &)
Set SSL client options.
proton::connection
A connection to a remote AMQP peer.
Definition: connection.hpp:47
proton::connection_options::container_id
connection_options & container_id(const std::string &id)
Set the container ID.
proton::connection_options
Options for creating a connection.
Definition: connection_options.hpp:68
proton::connection_options::operator=
connection_options & operator=(const connection_options &)
Copy options.
proton::duration
A span of time in milliseconds.
Definition: duration.hpp:39
proton::connection_options::connection_options
connection_options(class messaging_handler &h)
Shorthand for connection_options().handler(h).
proton::connection_options::user
connection_options & user(const std::string &)
Set the user name used to authenticate the connection.
proton::connection_options::virtual_host
connection_options & virtual_host(const std::string &name)
Set the virtual host name for the connection.
proton::messaging_handler
Handler for Proton messaging events.
Definition: messaging_handler.hpp:69
proton::connection_options::max_sessions
connection_options & max_sessions(uint16_t max)
Set the maximum number of open sessions. The default is 32767.
proton::connection_options::idle_timeout
connection_options & idle_timeout(duration)
Set the idle timeout.
proton::connection_options::desired_capabilities
connection_options & desired_capabilities(const std::vector< symbol > &)
Unsettled API - Extension capabilities desired from the remote peer.
proton::connection_options::handler
connection_options & handler(class messaging_handler &)
Set a connection handler.
proton::connection_options::connection_options
connection_options(const connection_options &)
Copy options.
proton::connection_options::properties
connection_options & properties(const std::map< symbol, value > &)
Unsettled API - Connection properties.
proton::connection_options::sasl_config_path
connection_options & sasl_config_path(const std::string &)
Unsettled API - Set the SASL configuration path.
proton
The main Proton namespace.
Definition: annotation_key.hpp:33
proton::connection_options::ssl_server_options
connection_options & ssl_server_options(const class ssl_server_options &)
Set SSL server options.
proton::connection_options::sasl_allowed_mechs
connection_options & sasl_allowed_mechs(const std::string &)
Specify the SASL mechanisms allowed for this connection.
proton::connection_options::connection_options
connection_options()
Create an empty set of options.
proton::connection_options::offered_capabilities
connection_options & offered_capabilities(const std::vector< symbol > &)
Unsettled API - Extension capabilities offered to the remote peer.
proton::ssl_server_options
Unsettled API - SSL configuration for inbound connections.
Definition: ssl.hpp:128
duration.hpp
A span of time in milliseconds.
types_fwd.hpp
Forward declarations for Proton types used to represent AMQP types.
proton::connection_options::sasl_config_name
connection_options & sasl_config_name(const std::string &)
Unsettled API - Set the SASL configuration name.
proton::connection_options::failover_urls
connection_options & failover_urls(const std::vector< std::string > &)
Unsettled API - Set Fail-over URLs.