Qpid Proton C++ API 0.40.0
 
Loading...
Searching...
No Matches
source_options.hpp
Go to the documentation of this file.
1#ifndef PROTON_SOURCE_OPTIONS_HPP
2#define PROTON_SOURCE_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 "./source.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 source_options();
50
52 PN_CPP_EXTERN source_options(const source_options&);
53
54 PN_CPP_EXTERN ~source_options();
55
57 PN_CPP_EXTERN source_options& operator=(const source_options&);
58
61 PN_CPP_EXTERN source_options& address(const std::string&);
62
66 PN_CPP_EXTERN source_options& dynamic(bool);
67
71 PN_CPP_EXTERN source_options& anonymous(bool);
72
76
80
84
88
93
95 PN_CPP_EXTERN source_options& capabilities(const std::vector<symbol>&);
96
99
100 private:
101 void apply(source&) const;
102
103 class impl;
104 std::unique_ptr<impl> impl_;
105
107 friend class source;
108 friend class sender_options;
109 friend class receiver_options;
111};
112
113} // proton
114
115#endif // PROTON_SOURCE_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 source node for a sender or receiver.
Definition source_options.hpp:46
source_options & capabilities(const std::vector< symbol > &)
Unsettled API Extension capabilities that are supported/requested
source_options & dynamic_properties(const source::dynamic_property_map &)
Unsettled API Set the dynamic node properties.
source_options(const source_options &)
Copy options.
source_options & operator=(const source_options &)
Copy options.
source_options & filters(const source::filter_map &)
Unsettled API - Specify a filter mechanism on the source that restricts message flow to a subset of t...
source_options & distribution_mode(enum source::distribution_mode)
Control whether messages are browsed or consumed.
source_options & durability_mode(enum source::durability_mode)
Control the persistence of the source node.
source_options & anonymous(bool)
Request an anonymous node on the remote peer.
source_options & expiry_policy(enum source::expiry_policy)
Control when the clock for expiration begins.
source_options & timeout(duration)
The expiry period after which the source is discarded.
source_options & address(const std::string &)
Set the address for the source.
source_options()
Create an empty set of options.
source_options & dynamic(bool)
Request that a node be dynamically created by the remote peer.
A point of origin for messages.
Definition source.hpp:44
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
distribution_mode
The policy for distributing messages.
Definition source.hpp:54
A span of time in milliseconds.
The main Proton namespace.
Definition annotation_key.hpp:33
A point of origin for messages.