Qpid Proton C++ API  0.21.0
sender_options.hpp
Go to the documentation of this file.
1 #ifndef PROTON_SENDER_OPTIONS_HPP
2 #define PROTON_SENDER_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 
58  public:
60  PN_CPP_EXTERN sender_options();
61 
63  PN_CPP_EXTERN sender_options(const sender_options&);
64 
65  PN_CPP_EXTERN ~sender_options();
66 
68  PN_CPP_EXTERN sender_options& operator=(const sender_options&);
69 
71  PN_CPP_EXTERN void update(const sender_options& other);
72 
77  PN_CPP_EXTERN sender_options& handler(class messaging_handler&);
78 
80  PN_CPP_EXTERN sender_options& delivery_mode(delivery_mode);
81 
83  PN_CPP_EXTERN sender_options& auto_settle(bool);
84 
86  PN_CPP_EXTERN sender_options& source(const source_options&);
87 
89  PN_CPP_EXTERN sender_options& target(const target_options&);
90 
92  PN_CPP_EXTERN sender_options& name(const std::string& name);
93 
94  private:
95  void apply(sender&) const;
96  const std::string* get_name() const; // Pointer to name if set, else 0
97 
98  class impl;
99  internal::pn_unique_ptr<impl> impl_;
100 
102  friend class sender;
103  friend class session;
105 };
106 
107 } // proton
108 
109 #endif // PROTON_SENDER_OPTIONS_HPP
void update(const sender_options &other)
Merge with another option set.
sender_options & handler(class messaging_handler &)
Set a messaging_handler for sender events only.
sender_options()
Create an empty set of options.
A channel for sending messages.
Definition: sender.hpp:39
Options for creating a sender.
Definition: sender_options.hpp:57
Forward declarations.
sender_options & delivery_mode(delivery_mode)
Set the delivery mode on the sender.
A container of senders and receivers.
Definition: session.hpp:41
sender_options & operator=(const sender_options &)
Copy options.
The message delivery policy to establish when opening a link.
Definition: delivery_mode.hpp:33
Options for creating a source node for a sender or receiver.
Definition: source_options.hpp:44
sender_options & source(const source_options &)
Options for the source node of the sender.
sender_options & name(const std::string &name)
Set the link name. If not set a unique name is generated.
sender_options & target(const target_options &)
Options for the receiver node of the receiver.
A handler for Proton messaging events.
Definition: messaging_handler.hpp:62
sender_options & auto_settle(bool)
Automatically settle messages (default is true).
The main Proton namespace.
Definition: annotation_key.hpp:33
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.