Qpid Proton C++ API 0.39.0
 
Loading...
Searching...
No Matches
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 "./delivery_mode.hpp"
28#include "./types_fwd.hpp"
29
30#include <map>
31#include <memory>
32#include <string>
33
36
37namespace proton {
38
61 public:
63 PN_CPP_EXTERN sender_options();
64
66 PN_CPP_EXTERN sender_options(const sender_options&);
67
68 PN_CPP_EXTERN ~sender_options();
69
71 PN_CPP_EXTERN sender_options& operator=(const sender_options&);
72
74 PN_CPP_EXTERN void update(const sender_options& other);
75
81
84
89 PN_CPP_EXTERN sender_options& auto_settle(bool);
90
92 PN_CPP_EXTERN sender_options& source(const source_options&);
93
95 PN_CPP_EXTERN sender_options& target(const target_options&);
96
98 PN_CPP_EXTERN sender_options& name(const std::string& name);
99
101 PN_CPP_EXTERN sender_options& properties(const std::map<symbol, value>&);
102
103 private:
104 void apply(sender&) const;
105 const std::string* get_name() const; // Pointer to name if set, else 0
106
107 class impl;
108 std::unique_ptr<impl> impl_;
109
111 friend class sender;
112 friend class session;
114};
115
116} // proton
117
118#endif // PROTON_SENDER_OPTIONS_HPP
Handler for Proton messaging events.
Definition: messaging_handler.hpp:69
Options for creating a sender.
Definition: sender_options.hpp:60
void update(const sender_options &other)
Merge with another option set.
sender_options(const sender_options &)
Copy options.
sender_options & source(const source_options &)
Options for the source node of the sender.
sender_options & properties(const std::map< symbol, value > &)
Unsettled API - Link properties.
sender_options()
Create an empty set of options.
sender_options & operator=(const sender_options &)
Copy options.
sender_options & name(const std::string &name)
Set the link name. If not set a unique name is generated.
sender_options & delivery_mode(delivery_mode)
Set the delivery mode on the sender.
sender_options & target(const target_options &)
Options for the receiver node of the receiver.
sender_options & handler(class messaging_handler &)
Set a messaging_handler for sender events only.
sender_options & auto_settle(bool)
If True (default), automatically settle messages upon receiving a settled disposition for that delive...
A channel for sending messages.
Definition: sender.hpp:40
A container of senders and receivers.
Definition: session.hpp:42
Options for creating a source node for a sender or receiver.
Definition: source_options.hpp:46
Options for creating a target node for a sender or receiver.
Definition: target_options.hpp:46
The message delivery policy to establish when opening a link.
Forward declarations.
The main Proton namespace.
Definition: annotation_key.hpp:33
The message delivery policy to establish when opening a link.
Definition: delivery_mode.hpp:33
Forward declarations for Proton types used to represent AMQP types.