iceoryx_utils/internal/cxx/reference_counter.hpp

Namespaces

Name
iox building block to easily create free function for logging in a library context
iox::cxx

Classes

	Name
class	iox::cxx::ReferenceCounter reference counter abstraction for the usage in constructs like a shared_ptr. A pointer to a memory position where the reference counter is stored is put into the constructor and then this object performs reference counting on it.

Source code

// Copyright (c) 2019 by Robert Bosch GmbH. All rights reserved.
//
// Licensed 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.
//
// SPDX-License-Identifier: Apache-2.0
#ifndef IOX_UTILS_CXX_REFERENCE_COUNTER_HPP
#define IOX_UTILS_CXX_REFERENCE_COUNTER_HPP

namespace iox
{
namespace cxx
{
template <typename T>
class ReferenceCounter
{
  public:
    ReferenceCounter(T* const referenceCounter) noexcept;

    ReferenceCounter(const ReferenceCounter& rhs) noexcept;

    ReferenceCounter(ReferenceCounter&& f_rhs) noexcept;

    ~ReferenceCounter() noexcept;

    ReferenceCounter& operator=(const ReferenceCounter& rhs) noexcept;

    ReferenceCounter& operator=(ReferenceCounter&& rhs) noexcept;

    T getValue() const noexcept;

  private:
    void incrementReferenceCounter() noexcept;
    void decrementReferenceCounter() noexcept;

  private:
    T* m_referenceCounter;
};
} // namespace cxx
} // namespace iox

#include "iceoryx_utils/internal/cxx/reference_counter.inl"

#endif // IOX_UTILS_CXX_REFERENCE_COUNTER_HPP

---

Updated on 31 May 2022 at 15:29:15 CEST