Qpid Proton C++ API  0.18.1
session.hpp
Go to the documentation of this file.
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 
35 
36 struct pn_session_t;
37 
38 namespace proton {
39 
41 class
42 PN_CPP_CLASS_EXTERN session : public internal::object<pn_session_t>, public endpoint {
43  public:
45  PN_CPP_EXTERN session(pn_session_t* s) : internal::object<pn_session_t>(s) {}
47 
48  public:
50  session() : internal::object<pn_session_t>(0) {}
51 
52  PN_CPP_EXTERN bool uninitialized() const;
53  PN_CPP_EXTERN bool active() const;
54  PN_CPP_EXTERN bool closed() const;
55 
56  PN_CPP_EXTERN class error_condition error() const;
57 
61  PN_CPP_EXTERN void open();
62 
64  PN_CPP_EXTERN void open(const session_options &opts);
65 
66  PN_CPP_EXTERN void close();
67  PN_CPP_EXTERN void close(const error_condition&);
68 
70  PN_CPP_EXTERN class container &container() const;
71 
73  PN_CPP_EXTERN class work_queue& work_queue() const;
74 
76  PN_CPP_EXTERN class connection connection() const;
77 
79  PN_CPP_EXTERN sender open_sender(const std::string &addr);
80 
82  PN_CPP_EXTERN sender open_sender(const std::string &addr, const sender_options &opts);
83 
85  PN_CPP_EXTERN receiver open_receiver(const std::string &addr);
86 
88  PN_CPP_EXTERN receiver open_receiver(const std::string &addr, const receiver_options &opts);
89 
91  PN_CPP_EXTERN size_t incoming_bytes() const;
92 
94  PN_CPP_EXTERN size_t outgoing_bytes() const;
95 
97  PN_CPP_EXTERN sender_range senders() const;
98 
100  PN_CPP_EXTERN receiver_range receivers() const;
101 
103  friend class internal::factory<session>;
104  friend class session_iterator;
106 };
107 
109 
111 class session_iterator : public internal::iter_base<session, session_iterator> {
112  public:
113  explicit session_iterator(session s = 0) : internal::iter_base<session, session_iterator>(s) {}
114 
116  PN_CPP_EXTERN session_iterator operator++();
117 };
118 
120 typedef internal::iter_range<session_iterator> session_range;
121 
123 
124 } // proton
125 
126 #endif // PROTON_SESSION_HPP
A top-level container of connections, sessions, and links.
Definition: container.hpp:55
A channel for sending messages.
A channel for sending messages.
Definition: sender.hpp:39
Options for creating a sender.
Definition: sender_options.hpp:56
Forward declarations.
A connection to a remote AMQP peer.
Definition: connection.hpp:43
The base class for session, connection, and link.
Definition: endpoint.hpp:36
A container of senders and receivers.
Definition: session.hpp:41
session()
Create an empty session.
Definition: session.hpp:50
A channel for receiving messages.
Options for creating a receiver.
Definition: receiver_options.hpp:55
A channel for receiving messages.
Definition: receiver.hpp:40
Unsettled API - A context for thread-safe execution of work.
Definition: work_queue.hpp:339
Options for creating a session.
Definition: session_options.hpp:40
The main Proton namespace.
Definition: annotation_key.hpp:33
The base class for session, connection, and link.
Describes an endpoint error state.
Definition: error_condition.hpp:40