Qpid Proton C++  0.12.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
connection_options Class Reference

Options for creating a connection. More...

#include <connection_options.hpp>

Public Member Functions

 connection_options ()
 Create an empty set of options.
 
 connection_options (const connection_options &)
 Copy options.
 
connection_optionsoperator= (const connection_options &)
 Copy options.
 
void override (const connection_options &other)
 Override with options from other.
 
connection_optionshandler (class handler *)
 Set a handler for the connection.
 
connection_optionsmax_frame_size (uint32_t max)
 Set the maximum frame size.
 
connection_optionsmax_channels (uint16_t max)
 Set the maximum channels.
 
connection_optionsidle_timeout (duration)
 Set the idle timeout.
 
connection_optionscontainer_id (const std::string &id)
 Set the container ID.
 
connection_optionsssl_client_options (const class ssl_client_options &)
 Set SSL client options.
 
connection_optionsssl_server_options (const class ssl_server_options &)
 Set SSL server options.
 
connection_optionssasl_enabled (bool)
 Enable or disable SASL.
 
connection_optionssasl_config_name (const std::string &)
 Set the SASL configuration name.
 
connection_optionssasl_config_path (const std::string &)
 Set the SASL configuration path.
 

Detailed Description

Options for creating a connection.

Options can be "chained" like this:

* c = container.connect(url, connection_options().handler(h).max_frame_size(1234));
*

You can also create an options object with common settings and use it as a base for different connections that have mostly the same settings:

* opts.idle_timeout(1000).max_frame_size(10000);
* c1 = container.connect(url1, opts.handler(h1));
* c2 = container.connect(url2, opts.handler(h2));
*

Normal value semantics: copy or assign creates a separate copy of the options.


The documentation for this class was generated from the following file: