Qpid Proton C++  0.17.0
session.hpp
1 #ifndef PROTON_SESSION_HPP
2 #define PROTON_SESSION_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 "./endpoint.hpp"
28 #include "./receiver.hpp"
29 #include "./sender.hpp"
30 
31 #include <string>
32 
33 struct pn_session_t;
34 
35 namespace proton {
36 
38 class
39 PN_CPP_CLASS_EXTERN session : public internal::object<pn_session_t>, public endpoint {
40  public:
42  PN_CPP_EXTERN session(pn_session_t* s) : internal::object<pn_session_t>(s) {}
44 
45  public:
47  session() : internal::object<pn_session_t>(0) {}
48 
49  PN_CPP_EXTERN bool uninitialized() const;
50  PN_CPP_EXTERN bool active() const;
51  PN_CPP_EXTERN bool closed() const;
52 
53  PN_CPP_EXTERN class error_condition error() const;
54 
58  PN_CPP_EXTERN void open();
59 
61  PN_CPP_EXTERN void open(const session_options &opts);
62 
63  PN_CPP_EXTERN void close();
64  PN_CPP_EXTERN void close(const error_condition&);
65 
67  PN_CPP_EXTERN class container &container() const;
68 
70  PN_CPP_EXTERN class connection connection() const;
71 
73  PN_CPP_EXTERN sender open_sender(const std::string &addr);
74 
76  PN_CPP_EXTERN sender open_sender(const std::string &addr, const sender_options &opts);
77 
79  PN_CPP_EXTERN receiver open_receiver(const std::string &addr);
80 
82  PN_CPP_EXTERN receiver open_receiver(const std::string &addr, const receiver_options &opts);
83 
85  PN_CPP_EXTERN size_t incoming_bytes() const;
86 
88  PN_CPP_EXTERN size_t outgoing_bytes() const;
89 
91  PN_CPP_EXTERN sender_range senders() const;
92 
94  PN_CPP_EXTERN receiver_range receivers() const;
95 
97  friend class internal::factory<session>;
98  friend class session_iterator;
99  friend class thread_safe<session>;
101 };
102 
104 
106 class session_iterator : public internal::iter_base<session, session_iterator> {
107  public:
108  explicit session_iterator(session s = 0) : internal::iter_base<session, session_iterator>(s) {}
109 
111  PN_CPP_EXTERN session_iterator operator++();
112 };
113 
115 typedef internal::iter_range<session_iterator> session_range;
116 
118 
119 } // proton
120 
121 #endif // PROTON_SESSION_HPP
A top-level container of connections, sessions, senders, and receivers.
Definition: container.hpp:50
A channel for sending messages.
Definition: sender.hpp:35
Options for creating a sender.
Definition: sender_options.hpp:54
A connection to a remote AMQP peer.
Definition: connection.hpp:40
The base class for session, connection, and link.
Definition: endpoint.hpp:33
A container of senders and receivers.
Definition: session.hpp:38
session()
Create an empty session.
Definition: session.hpp:47
Options for creating a receiver.
Definition: receiver_options.hpp:52
A channel for receiving messages.
Definition: receiver.hpp:37
Options for creating a session.
Definition: session_options.hpp:38
The main Proton namespace.
Definition: annotation_key.hpp:30
Experimental - A thread-safe object wrapper.
Definition: fwd.hpp:65
Describes an endpoint error state.
Definition: error_condition.hpp:37