Qpid Proton C++ API  0.18.1
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 "./internal/pn_unique_ptr.hpp"
27 #include "./duration.hpp"
28 #include "./target.hpp"
29 
30 #include <string>
31 
34 
35 namespace proton {
36 
45  public:
47  PN_CPP_EXTERN target_options();
48 
50  PN_CPP_EXTERN target_options(const target_options&);
51 
52  PN_CPP_EXTERN ~target_options();
53 
55  PN_CPP_EXTERN target_options& operator=(const target_options&);
56 
59  PN_CPP_EXTERN target_options& address(const std::string& addr);
60 
64  PN_CPP_EXTERN target_options& dynamic(bool);
65 
68  PN_CPP_EXTERN target_options& durability_mode(enum target::durability_mode);
69 
72  PN_CPP_EXTERN target_options& timeout(duration);
73 
76  PN_CPP_EXTERN target_options& expiry_policy(enum target::expiry_policy);
77 
78  private:
79  void apply(target&) const;
80 
81  class impl;
82  internal::pn_unique_ptr<impl> impl_;
83 
85  friend class target;
86  friend class sender_options;
87  friend class receiver_options;
89 };
90 
91 } // proton
92 
93 #endif // PROTON_TARGET_OPTIONS_HPP
A destination for messages.
Options for creating a sender.
Definition: sender_options.hpp:56
A span of time in milliseconds.
Definition: duration.hpp:39
target_options & dynamic(bool)
Request that a node be dynamically created by the remote peer.
durability_mode
The persistence mode of the source or target.
Definition: terminus.hpp:59
expiry_policy
When expiration of the source or target begins.
Definition: terminus.hpp:69
A span of time in milliseconds.
target_options & timeout(duration)
The expiry period after which the target is discarded.
target_options()
Create an empty set of options.
target_options & address(const std::string &addr)
Set the address for the target.
target_options & durability_mode(enum target::durability_mode)
Control the persistence of the target node.
Options for creating a receiver.
Definition: receiver_options.hpp:55
target_options & operator=(const target_options &)
Copy options.
A destination for messages.
Definition: target.hpp:45
target_options & expiry_policy(enum target::expiry_policy)
Control when the clock for expiration begins.
The main Proton namespace.
Definition: annotation_key.hpp:33
Options for creating a target node for a sender or receiver.
Definition: target_options.hpp:44