Qpid Proton C++ API  0.37.0
sender.hpp
Go to the documentation of this file.
1 #ifndef PROTON_SENDER_HPP
2 #define PROTON_SENDER_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 "./link.hpp"
28 #include "./tracker.hpp"
29 
32 
33 struct pn_link_t;
34 struct pn_session_t;
35 
36 namespace proton {
37 
39 class
40 PN_CPP_CLASS_EXTERN sender : public link {
42  PN_CPP_EXTERN sender(pn_link_t* s);
44 
45  public:
47  sender() = default;
48 
49  PN_CPP_EXTERN ~sender();
50 
52  PN_CPP_EXTERN void open();
53 
55  PN_CPP_EXTERN void open(const sender_options &opts);
56 
58  PN_CPP_EXTERN tracker send(const message &m);
59  PN_CPP_EXTERN tracker send(const message &m, const binary &tag);
60 
62  PN_CPP_EXTERN class source source() const;
63 
65  PN_CPP_EXTERN class target target() const;
66 
73  PN_CPP_EXTERN void return_credit();
74 
76  friend class internal::factory<sender>;
77  friend class sender_iterator;
79 
80  private:
82  uint64_t tag_counter = 0;
84 };
85 
87 
89 class sender_iterator : public internal::iter_base<sender, sender_iterator> {
90  sender_iterator(sender snd, pn_session_t* s = 0) :
91  internal::iter_base<sender, sender_iterator>(snd), session_(s) {}
92 
93  public:
95  sender_iterator() :
96  internal::iter_base<sender, sender_iterator>(0), session_(0) {}
98  PN_CPP_EXTERN sender_iterator operator++();
99 
100  private:
101  pn_session_t* session_;
102 
103  friend class connection;
104  friend class session;
105 };
106 
108 typedef internal::iter_range<sender_iterator> sender_range;
109 
111 
112 }
113 
114 #endif // PROTON_SENDER_HPP
Arbitrary binary data.
Definition: binary.hpp:40
An AMQP message.
Definition: message.hpp:48
Options for creating a sender.
Definition: sender_options.hpp:60
A channel for sending messages.
Definition: sender.hpp:40
void open(const sender_options &opts)
Open the sender.
tracker send(const message &m)
Send a message on the sender.
void open()
Open the sender.
void return_credit()
Unsettled API - Return all unused credit to the receiver in response to a drain request.
sender()=default
Create an empty sender.
A point of origin for messages.
Definition: source.hpp:44
A destination for messages.
Definition: target.hpp:45
A tracker for a sent message.
Definition: tracker.hpp:41
Forward declarations.
The main Proton namespace.
Definition: annotation_key.hpp:33
A tracker for a sent message.