Qpid Proton C++  0.17.0
connection.hpp
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 
31 #include <proton/type_compat.h>
32 
33 #include <string>
34 
35 struct pn_connection_t;
36 
37 namespace proton {
38 
40 class
41 PN_CPP_CLASS_EXTERN connection : public internal::object<pn_connection_t>, public endpoint {
43  PN_CPP_EXTERN connection(pn_connection_t* c) : internal::object<pn_connection_t>(c) {}
45 
46  public:
48  connection() : internal::object<pn_connection_t>(0) {}
49 
50  PN_CPP_EXTERN bool uninitialized() const;
51  PN_CPP_EXTERN bool active() const;
52  PN_CPP_EXTERN bool closed() const;
53 
54  PN_CPP_EXTERN class error_condition error() const;
55 
60  PN_CPP_EXTERN class container &container() const;
61 
63  PN_CPP_EXTERN class transport transport() const;
64 
66  PN_CPP_EXTERN std::string virtual_host() const;
67 
69  PN_CPP_EXTERN std::string container_id() const;
70 
73  PN_CPP_EXTERN std::string user() const;
74 
78  PN_CPP_EXTERN void open();
79 
81  PN_CPP_EXTERN void open(const connection_options &);
82 
83  PN_CPP_EXTERN void close();
84  PN_CPP_EXTERN void close(const error_condition&);
85 
87  PN_CPP_EXTERN session open_session();
88 
90  PN_CPP_EXTERN session open_session(const session_options &);
91 
94  PN_CPP_EXTERN session default_session();
95 
97  PN_CPP_EXTERN sender open_sender(const std::string &addr);
98 
100  PN_CPP_EXTERN sender open_sender(const std::string &addr, const sender_options &);
101 
103  PN_CPP_EXTERN receiver open_receiver(const std::string &addr);
104 
106  PN_CPP_EXTERN receiver open_receiver(const std::string &addr,
107  const receiver_options &);
108 
110  PN_CPP_EXTERN session_range sessions() const;
111 
113  PN_CPP_EXTERN receiver_range receivers() const;
114 
116  PN_CPP_EXTERN sender_range senders() const;
117 
121  PN_CPP_EXTERN uint32_t max_frame_size() const;
122 
126  PN_CPP_EXTERN uint16_t max_sessions() const;
127 
131  PN_CPP_EXTERN uint32_t idle_timeout() const;
132 
134  friend class internal::factory<connection>;
135  friend class container;
136  friend class proton::thread_safe<connection>;
138 };
139 
140 } // proton
141 
142 #endif // PROTON_CONNECTION_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
Options for creating a connection.
Definition: connection_options.hpp:62
The base class for session, connection, and link.
Definition: endpoint.hpp:33
A container of senders and receivers.
Definition: session.hpp:38
Options for creating a receiver.
Definition: receiver_options.hpp:52
A channel for receiving messages.
Definition: receiver.hpp:37
connection()
Create an empty connection.
Definition: connection.hpp:48
A network channel supporting an AMQP connection.
Definition: transport.hpp:34
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