Qpid Proton C++  0.14.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
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 "./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 "./terminus.hpp"
31 
32 #include <vector>
33 #include <string>
34 
35 namespace proton {
36 
37 class proton_handler;
38 class receiver;
39 class source_options;
40 class target_options;
41 
63  public:
65  PN_CPP_EXTERN receiver_options();
66 
68  PN_CPP_EXTERN receiver_options(const receiver_options&);
69 
70  PN_CPP_EXTERN ~receiver_options();
71 
73  PN_CPP_EXTERN receiver_options& operator=(const receiver_options&);
74 
76  PN_CPP_EXTERN void update(const receiver_options& other);
77 
80  PN_CPP_EXTERN receiver_options& handler(class messaging_handler&);
81 
83  PN_CPP_EXTERN receiver_options& delivery_mode(delivery_mode);
84 
87  PN_CPP_EXTERN receiver_options& auto_accept(bool);
88 
90  PN_CPP_EXTERN receiver_options& auto_settle(bool);
91 
93  PN_CPP_EXTERN receiver_options& source(source_options &);
94 
96  PN_CPP_EXTERN receiver_options& target(target_options &);
97 
101  PN_CPP_EXTERN receiver_options& credit_window(int);
102 
104  private:
105  void apply(receiver &) const;
106 
107  class impl;
108  internal::pn_unique_ptr<impl> impl_;
109 
110  friend class receiver;
112 };
113 
114 } // proton
115 
116 #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.
Include the definitions of all proton types used to represent AMQP types.
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:45
Options for creating a receiver.
Definition: receiver_options.hpp:62
A channel for receiving messages.
Definition: receiver.hpp:39
receiver_options & handler(class messaging_handler &)
Set a messaging_handler for receiver events only.
A handler for Proton messaging events.
Definition: messaging_handler.hpp:74
receiver_options & delivery_mode(delivery_mode)
Set the delivery mode on the receiver.
receiver_options()
Create an empty set of options.
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:47