Loading...
Searching...
No Matches
target_options.hpp
Go to the documentation of this file.
#ifndef PROTON_TARGET_OPTIONS_HPP
#define PROTON_TARGET_OPTIONS_HPP
/*
*
* 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
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
#include "./internal/export.hpp"
#include "./duration.hpp"
#include "./target.hpp"
#include <map>
#include <memory>
#include <string>
#include <vector>
namespace proton {
class target_options {
public:
PN_CPP_EXTERN target_options();
PN_CPP_EXTERN target_options(const target_options&);
PN_CPP_EXTERN ~target_options();
PN_CPP_EXTERN target_options& operator=(const target_options&);
PN_CPP_EXTERN target_options& address(const std::string& addr);
PN_CPP_EXTERN target_options& dynamic(bool);
PN_CPP_EXTERN target_options& anonymous(bool);
PN_CPP_EXTERN target_options& durability_mode(enum target::durability_mode);
PN_CPP_EXTERN target_options& timeout(duration);
PN_CPP_EXTERN target_options& expiry_policy(enum target::expiry_policy);
PN_CPP_EXTERN target_options& capabilities(const std::vector<symbol>&);
PN_CPP_EXTERN target_options& dynamic_properties(const target::dynamic_property_map&);
private:
void apply(target&) const;
class impl;
std::unique_ptr<impl> impl_;
friend class target;
friend class sender_options;
friend class receiver_options;
};
} // proton
#endif // PROTON_TARGET_OPTIONS_HPP
proton::duration
A span of time in milliseconds.
Definition duration.hpp:39
proton::map
A collection of key-value pairs.
Definition map.hpp:69
proton::receiver_options
Options for creating a receiver.
Definition receiver_options.hpp:59
proton::sender_options
Options for creating a sender.
Definition sender_options.hpp:60
proton::target_options
Options for creating a target node for a sender or receiver.
Definition target_options.hpp:46
proton::target_options::anonymous
target_options & anonymous(bool)
Request an anonymous node on the remote peer.
proton::target_options::dynamic
target_options & dynamic(bool)
Request that a node be dynamically created by the remote peer.
proton::target_options::target_options
target_options(const target_options &)
Copy options.
proton::target_options::timeout
target_options & timeout(duration)
The expiry period after which the target is discarded.
proton::target_options::capabilities
target_options & capabilities(const std::vector< symbol > &)
Unsettled API Extension capabilities that are supported/requested
proton::target_options::dynamic_properties
target_options & dynamic_properties(const target::dynamic_property_map &)
Unsettled API Set the dynamic node properties.
proton::target_options::durability_mode
target_options & durability_mode(enum target::durability_mode)
Control the persistence of the target node.
proton::target_options::operator=
target_options & operator=(const target_options &)
Copy options.
proton::target_options::address
target_options & address(const std::string &addr)
Set the address for the target.
proton::target_options::expiry_policy
target_options & expiry_policy(enum target::expiry_policy)
Control when the clock for expiration begins.
proton::target_options::target_options
target_options()
Create an empty set of options.
proton::target
A destination for messages.
Definition target.hpp:45
proton::target::expiry_policy
expiry_policy
When expiration of the source or target begins.
Definition terminus.hpp:74
proton::target::durability_mode
durability_mode
The persistence mode of the source or target.
Definition terminus.hpp:64
duration.hpp
A span of time in milliseconds.
proton
The main Proton namespace.
Definition annotation_key.hpp:33
target.hpp
A destination for messages.