link.hpp

Go to the documentation of this file.

#ifndef PROTON_LINK_HPP
#define PROTON_LINK_HPP
 
/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */
 
#include "./fwd.hpp"
#include "./internal/export.hpp"
#include "./endpoint.hpp"
#include "./internal/object.hpp"
 
#include <map>
#include <string>
 
 
struct pn_link_t;
 
namespace proton {
 
class
PN_CPP_CLASS_EXTERN link : public internal::object<pn_link_t> , public endpoint {
    link(pn_link_t* l) : internal::object<pn_link_t>(l) {}
 
  public:
    link() : internal::object<pn_link_t>(0) {}
 
    PN_CPP_EXTERN bool uninitialized() const;
    PN_CPP_EXTERN bool active() const;
    PN_CPP_EXTERN bool closed() const;
 
    PN_CPP_EXTERN class error_condition error() const;
 
    PN_CPP_EXTERN void close();
    PN_CPP_EXTERN void close(const error_condition&);
 
    // XXX Should take error condition
    PN_CPP_EXTERN void detach();
 
    PN_CPP_EXTERN int credit() const;
 
    PN_CPP_EXTERN bool draining();
 
    PN_CPP_EXTERN std::string name() const;
 
    PN_CPP_EXTERN class container &container() const;
 
    PN_CPP_EXTERN class work_queue& work_queue() const;
 
    PN_CPP_EXTERN class connection connection() const;
 
    PN_CPP_EXTERN class session session() const;
 
    PN_CPP_EXTERN std::map<symbol, value> properties() const;
 
    PN_CPP_EXTERN void user_data(void* user_data) const;
 
    PN_CPP_EXTERN void* user_data() const;
 
  protected:
    
    // Initiate the AMQP attach frame.
    void attach();
 
  friend class internal::factory<link>;
 
};
 
}
 
#endif // PROTON_LINK_HPP