Qpid Proton C++ API  0.18.1
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() {}
48 
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 
61  PN_CPP_EXTERN class source source() const;
62 
64  PN_CPP_EXTERN class target target() const;
65 
72  PN_CPP_EXTERN void return_credit();
73 
75  friend class internal::factory<sender>;
76  friend class sender_iterator;
78 };
79 
81 
83 class sender_iterator : public internal::iter_base<sender, sender_iterator> {
84  sender_iterator(sender snd, pn_session_t* s = 0) :
85  internal::iter_base<sender, sender_iterator>(snd), session_(s) {}
86 
87  public:
89  sender_iterator() :
90  internal::iter_base<sender, sender_iterator>(0), session_(0) {}
92  PN_CPP_EXTERN sender_iterator operator++();
93 
94  private:
95  pn_session_t* session_;
96 
97  friend class connection;
98  friend class session;
99 };
100 
102 typedef internal::iter_range<sender_iterator> sender_range;
103 
105 
106 }
107 
108 #endif // PROTON_SENDER_HPP
An AMQP message.
Definition: message.hpp:50
A channel for sending messages.
Definition: sender.hpp:39
sender()
Create an empty sender.
Definition: sender.hpp:47
Options for creating a sender.
Definition: sender_options.hpp:56
Forward declarations.
A connection to a remote AMQP peer.
Definition: connection.hpp:43
A point of origin for messages.
Definition: source.hpp:44
A container of senders and receivers.
Definition: session.hpp:41
A tracker for a sent message.
Definition: tracker.hpp:40
A tracker for a sent message.
A destination for messages.
Definition: target.hpp:45
The main Proton namespace.
Definition: annotation_key.hpp:33