Qpid Proton C++ API  0.19.0
receiver_options.hpp
Go to the documentation of this file.
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 #include <string>
30 
33 
34 namespace proton {
35 
57  public:
59  PN_CPP_EXTERN receiver_options();
60 
62  PN_CPP_EXTERN receiver_options(const receiver_options&);
63 
64  PN_CPP_EXTERN ~receiver_options();
65 
67  PN_CPP_EXTERN receiver_options& operator=(const receiver_options&);
68 
70  PN_CPP_EXTERN void update(const receiver_options& other);
71 
75  PN_CPP_EXTERN receiver_options& handler(class messaging_handler&);
76 
79  PN_CPP_EXTERN receiver_options& delivery_mode(delivery_mode);
80 
84  PN_CPP_EXTERN receiver_options& auto_accept(bool);
85 
87  PN_CPP_EXTERN receiver_options& auto_settle(bool);
88 
90  PN_CPP_EXTERN receiver_options& source(source_options&);
91 
93  PN_CPP_EXTERN receiver_options& target(target_options&);
94 
98  PN_CPP_EXTERN receiver_options& credit_window(int count);
99 
101  PN_CPP_EXTERN receiver_options& name(const std::string& name);
102 
103 
104  private:
105  void apply(receiver &) const;
106  const std::string* get_name() const; // Pointer to name if set, else 0
107 
108  class impl;
109  internal::pn_unique_ptr<impl> impl_;
110 
112  friend class receiver;
113  friend class session;
115 };
116 
117 } // proton
118 
119 #endif // PROTON_RECEIVER_OPTIONS_HPP
receiver_options & target(target_options &)
Options for the target node of the receiver.
receiver_options & auto_settle(bool)
Forward declarations.
receiver_options & credit_window(int count)
Automatically replenish credit for flow control up to count messages.
receiver_options & operator=(const receiver_options &)
Copy options.
A container of senders and receivers.
Definition: session.hpp:41
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:33
receiver_options & auto_accept(bool)
Enable or disable automatic acceptance of messages that aren&#39;t otherwise released, rejected, or modified.
Options for creating a source node for a sender or receiver.
Definition: source_options.hpp:44
Options for creating a receiver.
Definition: receiver_options.hpp:56
A channel for receiving messages.
Definition: receiver.hpp:40
receiver_options & handler(class messaging_handler &)
Set a messaging_handler for receiver events only.
A handler for Proton messaging events.
Definition: messaging_handler.hpp:62
receiver_options & delivery_mode(delivery_mode)
Set the delivery mode on the receiver.
receiver_options & name(const std::string &name)
Set the link name. If not set a unique name is generated.
receiver_options()
Create an empty set of options.
The main Proton namespace.
Definition: annotation_key.hpp:33
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:44
The message delivery policy to establish when opening a link.