session.hpp

Go to the documentation of this file.

#ifndef PROTON_SESSION_HPP
#define PROTON_SESSION_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 "./receiver.hpp"
#include "./sender.hpp"
 
#include <string>

 
struct pn_session_t;
 
namespace proton {

class
PN_CPP_CLASS_EXTERN session : public internal::object<pn_session_t>, public endpoint {
  public:
    PN_CPP_EXTERN session(pn_session_t* s) : internal::object<pn_session_t>(s) {}
 
  public:
    session() : internal::object<pn_session_t>(0) {}
 
    PN_CPP_EXTERN ~session();
 
    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 open();

    PN_CPP_EXTERN void open(const session_options &opts);
 
    PN_CPP_EXTERN void close();
    PN_CPP_EXTERN void close(const error_condition&);

    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 sender open_sender(const std::string &addr);

    PN_CPP_EXTERN sender open_sender(const std::string &addr, const sender_options &opts);

    PN_CPP_EXTERN receiver open_receiver(const std::string &addr);

    PN_CPP_EXTERN receiver open_receiver(const std::string &addr, const receiver_options &opts);

    PN_CPP_EXTERN size_t incoming_bytes() const;

    PN_CPP_EXTERN size_t outgoing_bytes() const;

    PN_CPP_EXTERN sender_range senders() const;

    PN_CPP_EXTERN receiver_range receivers() const;

    PN_CPP_EXTERN void user_data(void* user_data) const;

    PN_CPP_EXTERN void* user_data() const;

    PN_CPP_EXTERN void transaction_declare();

    PN_CPP_EXTERN void transaction_declare(const transaction_options& opts);

    PN_CPP_EXTERN void transaction_commit();

    PN_CPP_EXTERN void transaction_abort();

    PN_CPP_EXTERN bool transaction_is_declared() const;

    PN_CPP_EXTERN binary transaction_id() const;

    PN_CPP_EXTERN error_condition transaction_error() const;

    friend class internal::factory<session>;
    friend class sender;
    friend class session_iterator;
};


class session_iterator : public internal::iter_base<session, session_iterator> {
  public:
    explicit session_iterator(session s = nullptr) : internal::iter_base<session, session_iterator>(s) {}

    PN_CPP_EXTERN session_iterator operator++();
};

typedef internal::iter_range<session_iterator> session_range;

 
} // proton
 
#endif // PROTON_SESSION_HPP