Qpid Proton C++  0.17.0
receiver_options.hpp
1 #ifndef PROTON_RECEIVER_OPTIONS_HPP
2 #define PROTON_RECEIVER_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 "./fwd.hpp"
26 #include "./internal/export.hpp"
27 #include "./internal/pn_unique_ptr.hpp"
28 #include "./delivery_mode.hpp"
29 
30 namespace proton {
31 
53  public:
55  PN_CPP_EXTERN receiver_options();
56 
58  PN_CPP_EXTERN receiver_options(const receiver_options&);
59 
60  PN_CPP_EXTERN ~receiver_options();
61 
63  PN_CPP_EXTERN receiver_options& operator=(const receiver_options&);
64 
66  PN_CPP_EXTERN void update(const receiver_options& other);
67 
70  PN_CPP_EXTERN receiver_options& handler(class messaging_handler&);
71 
73  PN_CPP_EXTERN receiver_options& delivery_mode(delivery_mode);
74 
77  PN_CPP_EXTERN receiver_options& auto_accept(bool);
78 
80  PN_CPP_EXTERN receiver_options& auto_settle(bool);
81 
83  PN_CPP_EXTERN receiver_options& source(source_options &);
84 
86  PN_CPP_EXTERN receiver_options& target(target_options &);
87 
91  PN_CPP_EXTERN receiver_options& credit_window(int);
92 
94  private:
95  void apply(receiver &) const;
96 
97  class impl;
98  internal::pn_unique_ptr<impl> impl_;
99 
100  friend class receiver;
102 };
103 
104 } // proton
105 
106 #endif // PROTON_RECEIVER_OPTIONS_HPP
receiver_options & target(target_options &)
Options for the target node of the receiver.
receiver_options & auto_settle(bool)
Automatically settle messages (default is true).
receiver_options & operator=(const receiver_options &)
Copy options.
receiver_options & credit_window(int)
Set automated flow control to pre-fetch this many messages (default is 10).
void update(const receiver_options &other)
Merge with another option set.
The message delivery policy to establish when opening a link.
Definition: delivery_mode.hpp:30
receiver_options & auto_accept(bool)
Automatically accept inbound messages that aren&#39;t otherwise released, rejected, or modified (default ...
Options for creating a source node for a sender or receiver.
Definition: source_options.hpp:40
Options for creating a receiver.
Definition: receiver_options.hpp:52
A channel for receiving messages.
Definition: receiver.hpp:37
receiver_options & handler(class messaging_handler &)
Set a messaging_handler for receiver events only.
A handler for Proton messaging events.
Definition: messaging_handler.hpp:59
receiver_options & delivery_mode(delivery_mode)
Set the delivery mode on the receiver.
receiver_options()
Create an empty set of options.
The main Proton namespace.
Definition: annotation_key.hpp:30
receiver_options & source(source_options &)
Options for the source node of the receiver.
Options for creating a target node for a sender or receiver.
Definition: target_options.hpp:40