Qpid Proton C++  0.24.0
connection.hpp
Go to the documentation of this file.
1 #ifndef PROTON_CONNECTION_HPP
2 #define PROTON_CONNECTION_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 "./internal/object.hpp"
28 #include "./endpoint.hpp"
29 #include "./session.hpp"
30 #include "./symbol.hpp"
31 
32 #include <proton/type_compat.h>
33 
34 #include <string>
35 
38 
39 struct pn_connection_t;
40 
41 namespace proton {
42 
44 class
45 PN_CPP_CLASS_EXTERN connection : public internal::object<pn_connection_t>, public endpoint {
47  PN_CPP_EXTERN connection(pn_connection_t* c) : internal::object<pn_connection_t>(c) {}
49 
50  public:
52  connection() : internal::object<pn_connection_t>(0) {}
53 
54  PN_CPP_EXTERN bool uninitialized() const;
55  PN_CPP_EXTERN bool active() const;
56  PN_CPP_EXTERN bool closed() const;
57 
58  PN_CPP_EXTERN class error_condition error() const;
59 
64  PN_CPP_EXTERN class container& container() const;
65 
67  PN_CPP_EXTERN class work_queue& work_queue() const;
68 
70  PN_CPP_EXTERN class transport transport() const;
71 
73  PN_CPP_EXTERN std::string virtual_host() const;
74 
76  PN_CPP_EXTERN std::string container_id() const;
77 
80  PN_CPP_EXTERN std::string user() const;
81 
85  PN_CPP_EXTERN void open();
86 
88  PN_CPP_EXTERN void open(const connection_options&);
89 
90  PN_CPP_EXTERN void close();
91  PN_CPP_EXTERN void close(const error_condition&);
92 
94  PN_CPP_EXTERN session open_session();
95 
97  PN_CPP_EXTERN session open_session(const session_options&);
98 
101  PN_CPP_EXTERN session default_session();
102 
104  PN_CPP_EXTERN sender open_sender(const std::string& addr);
105 
107  PN_CPP_EXTERN sender open_sender(const std::string& addr, const sender_options&);
108 
110  PN_CPP_EXTERN receiver open_receiver(const std::string& addr);
111 
113  PN_CPP_EXTERN receiver open_receiver(const std::string& addr,
114  const receiver_options&);
115 
117  PN_CPP_EXTERN class sender_options sender_options() const;
118 
120  PN_CPP_EXTERN class receiver_options receiver_options() const;
121 
123  PN_CPP_EXTERN session_range sessions() const;
124 
126  PN_CPP_EXTERN receiver_range receivers() const;
127 
129  PN_CPP_EXTERN sender_range senders() const;
130 
134  PN_CPP_EXTERN uint32_t max_frame_size() const;
135 
140  PN_CPP_EXTERN uint16_t max_sessions() const;
141 
143  PN_CPP_EXTERN std::vector<symbol> offered_capabilities() const;
144 
146  PN_CPP_EXTERN std::vector<symbol> desired_capabilities() const;
147 
151  PN_CPP_EXTERN uint32_t idle_timeout() const;
152 
171  PN_CPP_EXTERN void wake() const;
172 
174  friend class internal::factory<connection>;
175  friend class container;
177 };
178 
179 } // proton
180 
181 #endif // PROTON_CONNECTION_HPP
A top-level container of connections, sessions, and links.
Definition: container.hpp:50
A channel for sending messages.
Definition: sender.hpp:39
Options for creating a sender.
Definition: sender_options.hpp:57
Forward declarations.
A connection to a remote AMQP peer.
Definition: connection.hpp:44
Options for creating a connection.
Definition: connection_options.hpp:67
The base class for session, connection, and link.
Definition: endpoint.hpp:36
A container of senders and receivers.
Definition: session.hpp:41
A string that represents the AMQP symbol type.
Options for creating a receiver.
Definition: receiver_options.hpp:56
A channel for receiving messages.
Definition: receiver.hpp:40
Unsettled API - A context for thread-safe execution of work.
Definition: work_queue.hpp:339
connection()
Create an empty connection.
Definition: connection.hpp:52
A container of senders and receivers.
A network channel supporting an AMQP connection.
Definition: transport.hpp:37
The base Proton error.
Definition: error.hpp:40
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