Qpid Proton C++  0.13.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
target_options.hpp
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/config.hpp"
26 #include "./internal/export.hpp"
27 #include "./internal/pn_unique_ptr.hpp"
28 #include "./types.hpp"
29 #include "./delivery_mode.hpp"
30 #include "./target.hpp"
31 #include "./terminus.hpp"
32 
33 #include <vector>
34 #include <string>
35 
36 namespace proton {
37 
38 class proton_handler;
39 class target;
40 
48  public:
50  PN_CPP_EXTERN target_options();
51 
53  PN_CPP_EXTERN target_options(const target_options&);
54 
55  PN_CPP_EXTERN ~target_options();
56 
58  PN_CPP_EXTERN target_options& operator=(const target_options&);
59 
61  PN_CPP_EXTERN target_options& address(const std::string& addr);
62 
65  PN_CPP_EXTERN target_options& dynamic(bool);
66 
68  PN_CPP_EXTERN target_options& durability_mode(enum target::durability_mode);
69 
71  PN_CPP_EXTERN target_options& timeout(duration);
72 
74  PN_CPP_EXTERN target_options& expiry_policy(enum target::expiry_policy);
75 
76  private:
77  void apply(target&) const;
78 
79  class impl;
80  internal::pn_unique_ptr<impl> impl_;
81 
83  friend class target;
84  friend class sender_options;
85  friend class receiver_options;
87 };
88 
89 } // proton
90 
91 #endif // PROTON_TARGET_OPTIONS_HPP
Options for creating a sender.
Definition: sender_options.hpp:64
A span of time in milliseconds.
Definition: duration.hpp:34
target_options & dynamic(bool)
Request a dynamically created node to be created by the peer.
durability_mode
The persistence mode of the source or target.
Definition: terminus.hpp:49
Include the definitions of all proton types used to represent AMQP types.
expiry_policy
When expiration of the source or target begins.
Definition: terminus.hpp:59
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. Ignored if dynamic is true.
target_options & durability_mode(enum target::durability_mode)
Control the persistence of target state.
Options for creating a receiver.
Definition: receiver_options.hpp:62
target_options & operator=(const target_options &)
Copy options.
A destination for messages.
Definition: target.hpp:40
target_options & expiry_policy(enum target::expiry_policy)
Control when the clock for expiration begins.
Options for creating a target node for a sender or receiver.
Definition: target_options.hpp:47