proton-c/bindings/cpp/include/proton/condition.hpp

#ifndef PROTON_CPP_CONDITION_H
#define PROTON_CPP_CONDITION_H

/*
 *
 * 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 "proton/export.hpp"
#include "proton/value.hpp"

#include <string>

struct pn_condition_t;

namespace proton {

/// Describes an endpoint error state.
class condition {
  public:
    /// @cond INTERNAL
    condition(pn_condition_t* c) : condition_(c) {}
    /// @endcond

    /// @cond INTERNAL
    /// XXX want to discuss
    /// Assert no condition set.
    PN_CPP_EXPORT bool operator!() const;
    /// @endcond

    /// Condition name.
    PN_CPP_EXPORT std::string name() const;

    /// Descriptive string for condition.
    PN_CPP_EXPORT std::string description() const;

    /// Extra information for condition n*/
    PN_CPP_EXPORT value info() const;

    /// Simple printable string for condition.
    PN_CPP_EXPORT std::string str() const;

  private:
    pn_condition_t* condition_;
};

}

#endif // PROTON_CPP_CONDITION_H