blob: fab9fb8a88f89a22675849a854a8b18438d9810f [file] [log] [blame]
* 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
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
#include "./internal/export.hpp"
#include "./internal/pn_unique_ptr.hpp"
#include "./duration.hpp"
#include "./source.hpp"
#include <string>
#include <vector>
/// @file
/// @copybrief proton::reconnect_options
namespace proton {
/// **Unsettled API** - Options for reconnect and failover after
/// connection loss.
/// These options determine a series of delays to coordinate
/// reconnection attempts. They may be open-ended or limited in time.
/// They may be evenly spaced or increasing at an exponential rate.
/// Normal value semantics: copy or assign creates a separate copy of
/// the options.
/// @see messaging_handler, connection_options::reconnect()
class reconnect_options {
/// Create an empty set of options.
PN_CPP_EXTERN reconnect_options();
/// Copy options.
PN_CPP_EXTERN reconnect_options(const reconnect_options&);
PN_CPP_EXTERN ~reconnect_options();
/// Copy options.
PN_CPP_EXTERN reconnect_options& operator=(const reconnect_options&);
/// The base value for recurring delays. The default is 10
/// milliseconds.
PN_CPP_EXTERN reconnect_options& delay(duration);
/// The scaling multiplier for successive reconnect delays. The
/// default is 2.0.
PN_CPP_EXTERN reconnect_options& delay_multiplier(float);
/// The maximum delay between successive connect attempts. The
/// default duration::FOREVER, meaning no limit.
PN_CPP_EXTERN reconnect_options& max_delay(duration);
/// The maximum number of reconnect attempts. The default is 0,
/// meaning no limit.
PN_CPP_EXTERN reconnect_options& max_attempts(int);
/// Deprecated - use connection_options::failover_urls
/// Alternative connection URLs used for failover. There are none
/// by default.
PN_CPP_DEPRECATED("use connection_options::failover_urls()")
PN_CPP_EXTERN reconnect_options& failover_urls(const std::vector<std::string>& conn_urls);
class impl;
internal::pn_unique_ptr<impl> impl_;
/// @cond INTERNAL
friend class connection_options;
friend class container;
/// @endcond
} // proton