Qpid Proton C++ API 0.39.0
 
Loading...
Searching...
No Matches
target_options.hpp
Go to the documentation of this file.
1#ifndef PROTON_TARGET_OPTIONS_HPP
2#define PROTON_TARGET_OPTIONS_HPP
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 "./internal/export.hpp"
26#include "./duration.hpp"
27#include "./target.hpp"
28
29#include <map>
30#include <memory>
31#include <string>
32#include <vector>
33
36
37namespace proton {
38
47 public:
49 PN_CPP_EXTERN target_options();
50
52 PN_CPP_EXTERN target_options(const target_options&);
53
54 PN_CPP_EXTERN ~target_options();
55
57 PN_CPP_EXTERN target_options& operator=(const target_options&);
58
61 PN_CPP_EXTERN target_options& address(const std::string& addr);
62
66 PN_CPP_EXTERN target_options& dynamic(bool);
67
71 PN_CPP_EXTERN target_options& anonymous(bool);
72
76
80
84
86 PN_CPP_EXTERN target_options& capabilities(const std::vector<symbol>&);
87
90
91 private:
92 void apply(target&) const;
93
94 class impl;
95 std::unique_ptr<impl> impl_;
96
98 friend class target;
99 friend class sender_options;
100 friend class receiver_options;
102};
103
104} // proton
105
106#endif // PROTON_TARGET_OPTIONS_HPP
A span of time in milliseconds.
Definition: duration.hpp:39
Options for creating a receiver.
Definition: receiver_options.hpp:59
Options for creating a sender.
Definition: sender_options.hpp:60
Options for creating a target node for a sender or receiver.
Definition: target_options.hpp:46
target_options & anonymous(bool)
Request an anonymous node on the remote peer.
target_options & dynamic(bool)
Request that a node be dynamically created by the remote peer.
target_options(const target_options &)
Copy options.
target_options & timeout(duration)
The expiry period after which the target is discarded.
target_options & capabilities(const std::vector< symbol > &)
Unsettled API Extension capabilities that are supported/requested
target_options & dynamic_properties(const target::dynamic_property_map &)
Unsettled API Set the dynamic node properties.
target_options & durability_mode(enum target::durability_mode)
Control the persistence of the target node.
target_options & operator=(const target_options &)
Copy options.
target_options & address(const std::string &addr)
Set the address for the target.
target_options & expiry_policy(enum target::expiry_policy)
Control when the clock for expiration begins.
target_options()
Create an empty set of options.
A destination for messages.
Definition: target.hpp:45
expiry_policy
When expiration of the source or target begins.
Definition: terminus.hpp:74
durability_mode
The persistence mode of the source or target.
Definition: terminus.hpp:64
A span of time in milliseconds.
The main Proton namespace.
Definition: annotation_key.hpp:33
A destination for messages.