1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
|
#ifndef PROTON_RETURNED_HPP
#define PROTON_RETURNED_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 "./internal/export.hpp"
#include "./internal/object.hpp"
#include "./connection.hpp"
#include "./receiver.hpp"
#include "./sender.hpp"
/// @file
/// @copybrief proton::returned
namespace proton {
namespace internal {
class returned_factory;
}
/// A return type for container methods.
///
/// **Thread safety** - Container method return values are
/// *thread-unsafe*. A single-threaded application can safely assign
/// the `returned<T>` value to a plain `T`. A multithreaded
/// application *must* ignore the returned value because it may
/// already be invalid by the time the function returns.
/// Multithreaded applications can safely access the value inside @ref
/// messaging_handler functions.
template <class T>
class PN_CPP_CLASS_EXTERN returned {
public:
/// Copy operator required to return a value
PN_CPP_EXTERN returned(const returned<T>&);
/// Convert to the proton::object
///
/// @note **Thread-unsafe** - Do not use in a multithreaded application.
PN_CPP_EXTERN operator T() const;
private:
typename T::pn_type* ptr_;
returned(typename T::pn_type*);
returned& operator=(const returned&) = delete;
friend class internal::returned_factory;
};
} // proton
#endif /*!PROTON_RETURNED_HPP*/
|