blob: 834a18563a555496751cf9fc50723aae21e40768 [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 "./target.hpp"
#include <string>
/// @file
/// @copybrief proton::target_options
namespace proton {
/// Options for creating a target node for a sender or receiver.
/// Options can be "chained". For more information see @ref
/// proton::connection_options.
/// Normal value semantics: copy or assign creates a separate copy of
/// the options.
class target_options {
/// Create an empty set of options.
PN_CPP_EXTERN target_options();
/// Copy options.
PN_CPP_EXTERN target_options(const target_options&);
PN_CPP_EXTERN ~target_options();
/// Copy options.
PN_CPP_EXTERN target_options& operator=(const target_options&);
/// Set the address for the target. It is unset by default. The
/// address is ignored if dynamic() is true.
PN_CPP_EXTERN target_options& address(const std::string& addr);
/// Request that a node be dynamically created by the remote peer.
/// The default is false. Any specified target address() is
/// ignored if true.
PN_CPP_EXTERN target_options& dynamic(bool);
/// Request an anonymous node on the remote peer.
/// The default is false. Any specified target address() is
/// ignored if true.
PN_CPP_EXTERN target_options& anonymous(bool);
/// Control the persistence of the target node. The default is
/// target::NONDURABLE, meaning non-persistent.
PN_CPP_EXTERN target_options& durability_mode(enum target::durability_mode);
/// The expiry period after which the target is discarded. The
/// default is no timeout.
PN_CPP_EXTERN target_options& timeout(duration);
/// Control when the clock for expiration begins. The default is
/// target::LINK_CLOSE.
PN_CPP_EXTERN target_options& expiry_policy(enum target::expiry_policy);
/// Extension capabilities that are supported/requested
PN_CPP_EXTERN target_options& capabilities(const std::vector<symbol>&);
void apply(target&) const;
class impl;
internal::pn_unique_ptr<impl> impl_;
/// @cond INTERNAL
friend class target;
friend class sender_options;
friend class receiver_options;
/// @endcond
} // proton