Qpid Proton C++ API  0.37.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 #include "./value.hpp"
32 
33 #include <proton/type_compat.h>
34 
35 #include <map>
36 #include <string>
37 
40 
41 struct pn_connection_t;
42 
43 namespace proton {
44 
46 class
47 PN_CPP_CLASS_EXTERN connection : public internal::object<pn_connection_t>, public endpoint {
49  PN_CPP_EXTERN connection(pn_connection_t* c) : internal::object<pn_connection_t>(c) {}
51 
52  public:
54  connection() : internal::object<pn_connection_t>(0) {}
55 
56  PN_CPP_EXTERN ~connection();
57 
58  PN_CPP_EXTERN bool uninitialized() const;
59  PN_CPP_EXTERN bool active() const;
60  PN_CPP_EXTERN bool closed() const;
61 
62  PN_CPP_EXTERN class error_condition error() const;
63 
68  PN_CPP_EXTERN class container& container() const;
69 
71  PN_CPP_EXTERN class work_queue& work_queue() const;
72 
74  PN_CPP_EXTERN class transport transport() const;
75 
77  PN_CPP_EXTERN std::string virtual_host() const;
78 
80  PN_CPP_EXTERN std::string container_id() const;
81 
84  PN_CPP_EXTERN std::string user() const;
85 
88  PN_CPP_EXTERN void open();
89 
91  PN_CPP_EXTERN void open(const connection_options&);
92 
95  PN_CPP_EXTERN void close();
96 
98  PN_CPP_EXTERN void close(const error_condition&);
99 
101  PN_CPP_EXTERN session open_session();
102 
104  PN_CPP_EXTERN session open_session(const session_options&);
105 
108  PN_CPP_EXTERN session default_session();
109 
111  PN_CPP_EXTERN sender open_sender(const std::string& addr);
112 
114  PN_CPP_EXTERN sender open_sender(const std::string& addr, const sender_options&);
115 
117  PN_CPP_EXTERN receiver open_receiver(const std::string& addr);
118 
120  PN_CPP_EXTERN receiver open_receiver(const std::string& addr,
121  const receiver_options&);
122 
124  PN_CPP_EXTERN class sender_options sender_options() const;
125 
127  PN_CPP_EXTERN class receiver_options receiver_options() const;
128 
130  PN_CPP_EXTERN session_range sessions() const;
131 
133  PN_CPP_EXTERN receiver_range receivers() const;
134 
136  PN_CPP_EXTERN sender_range senders() const;
137 
141  PN_CPP_EXTERN uint32_t max_frame_size() const;
142 
147  PN_CPP_EXTERN uint16_t max_sessions() const;
148 
150  PN_CPP_EXTERN std::vector<symbol> offered_capabilities() const;
151 
153  PN_CPP_EXTERN std::vector<symbol> desired_capabilities() const;
154 
156  PN_CPP_EXTERN std::map<symbol, value> properties() const;
157 
161  PN_CPP_EXTERN uint32_t idle_timeout() const;
162 
181  PN_CPP_EXTERN void wake() const;
182 
187  PN_CPP_EXTERN bool reconnected() const;
188 
200  PN_CPP_EXTERN void update_options(const connection_options&);
201 
203  friend class internal::factory<connection>;
204  friend class container;
206 };
207 
208 } // proton
209 
210 #endif // PROTON_CONNECTION_HPP
Options for creating a connection.
Definition: connection_options.hpp:67
A connection to a remote AMQP peer.
Definition: connection.hpp:47
uint16_t max_sessions() const
Get the maximum number of open sessions allowed by the remote peer.
session default_session()
Get the default session.
std::vector< symbol > offered_capabilities() const
Unsettled API - Extension capabilities offered by the remote peer.
sender_range senders() const
Return all senders on this connection.
class container & container() const
Get the container.
session open_session()
Open a new session.
void wake() const
Unsettled API - Trigger an event from another thread.
uint32_t max_frame_size() const
Get the maximum frame size allowed by the remote peer.
session_range sessions() const
Return all sessions on this connection.
std::string virtual_host() const
Return the remote AMQP hostname attribute for the connection.
void close()
Close the connection.
receiver_range receivers() const
Return all receivers on this connection.
std::vector< symbol > desired_capabilities() const
Unsettled API - Extension capabilities desired by the remote peer.
connection()
Create an empty connection.
Definition: connection.hpp:54
void close(const error_condition &)
Close the connection.
void open(const connection_options &)
Open the connection.
std::map< symbol, value > properties() const
Unsettled API - Connection properties
std::string user() const
Return authenticated user for the connection Note: The value returned is not stable until the on_tran...
uint32_t idle_timeout() const
Get the idle timeout set by the remote peer.
bool reconnected() const
Unsettled API - True if this connection has been automatically re-connected.
void open()
Open the connection.
void update_options(const connection_options &)
Unsettled API - Update the connection options for this connection
receiver open_receiver(const std::string &addr)
Open a receiver for addr on default_session().
bool uninitialized() const
True if the local end is uninitialized.
receiver open_receiver(const std::string &addr, const receiver_options &)
Open a receiver for addr on default_session().
std::string container_id() const
Return the remote container ID for the connection.
bool active() const
True if the local end is active.
sender open_sender(const std::string &addr, const sender_options &)
Open a sender for addr on default_session().
bool closed() const
True if the local and remote ends are closed.
sender open_sender(const std::string &addr)
Open a sender for addr on default_session().
session open_session(const session_options &)
Open a new session.
A top-level container of connections, sessions, and links.
Definition: container.hpp:49
The base class for session, connection, and link.
Definition: endpoint.hpp:36
Describes an endpoint error state.
Definition: error_condition.hpp:39
Options for creating a receiver.
Definition: receiver_options.hpp:59
A channel for receiving messages.
Definition: receiver.hpp:41
Options for creating a sender.
Definition: sender_options.hpp:60
A channel for sending messages.
Definition: sender.hpp:40
Options for creating a session.
Definition: session_options.hpp:41
A container of senders and receivers.
Definition: session.hpp:42
A network channel supporting an AMQP connection.
Definition: transport.hpp:37
Unsettled API - A context for thread-safe execution of work.
Definition: work_queue.hpp:327
The base class for session, connection, and link.
Forward declarations.
The main Proton namespace.
Definition: annotation_key.hpp:33
A container of senders and receivers.
The base Proton error.
Definition: error.hpp:40
A string that represents the AMQP symbol type.
A holder for any AMQP value, simple or complex.