Qpid Proton C++ API  0.18.1
link.hpp
Go to the documentation of this file.
1 #ifndef PROTON_LINK_HPP
2 #define PROTON_LINK_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 "./internal/object.hpp"
29 
30 #include <string>
31 
34 
35 struct pn_link_t;
36 
37 namespace proton {
38 
41 class
42 PN_CPP_CLASS_EXTERN link : public internal::object<pn_link_t> , public endpoint {
44  link(pn_link_t* l) : internal::object<pn_link_t>(l) {}
46 
47  public:
49  link() : internal::object<pn_link_t>(0) {}
50 
51  PN_CPP_EXTERN bool uninitialized() const;
52  PN_CPP_EXTERN bool active() const;
53  PN_CPP_EXTERN bool closed() const;
54 
55  PN_CPP_EXTERN class error_condition error() const;
56 
57  PN_CPP_EXTERN void close();
58  PN_CPP_EXTERN void close(const error_condition&);
59 
64  // XXX Should take error condition
65  PN_CPP_EXTERN void detach();
66 
68  PN_CPP_EXTERN int credit() const;
69 
76  PN_CPP_EXTERN bool draining();
77 
79  PN_CPP_EXTERN std::string name() const;
80 
82  PN_CPP_EXTERN class container &container() const;
83 
85  PN_CPP_EXTERN class work_queue& work_queue() const;
86 
88  PN_CPP_EXTERN class connection connection() const;
89 
91  PN_CPP_EXTERN class session session() const;
92 
93  protected:
95 
96  // Initiate the AMQP attach frame.
97  void attach();
98 
99  friend class internal::factory<link>;
100 
102 };
103 
104 }
105 
106 #endif // PROTON_LINK_HPP
A top-level container of connections, sessions, and links.
Definition: container.hpp:55
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
Unsettled API - A context for thread-safe execution of work.
Definition: work_queue.hpp:339
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