reference_count_atomic.hpp

Go to the documentation of this file.

/*!
 * \file reference_count_atomic.hpp
 * \brief file reference_count_atomic.hpp
 *
 * Copyright 2016 by Intel.
 *
 * Contact: kevin.rogovin@gmail.com
 *
 * This Source Code Form is subject to the
 * terms of the Mozilla Public License, v. 2.0.
 * If a copy of the MPL was not distributed with
 * this file, You can obtain one at
 * http://mozilla.org/MPL/2.0/.
 *
 * \author Kevin Rogovin <kevin.rogovin@gmail.com>
 *
 */


#ifndef FASTUIDRAW_REFERENCE_COUNT_ATOMIC_HPP
#define FASTUIDRAW_REFERENCE_COUNT_ATOMIC_HPP

#include <fastuidraw/util/util.hpp>

namespace fastuidraw
{
/*!\addtogroup Utility
 * @{
 */

  /*!
   * \brief
   * Reference counter that is thread safe by
   * having increment and decrement operations
   * by atomic operations, this is usually faster
   * (and much faster) than reference_count_mutex.
   */
  class reference_count_atomic:noncopyable
  {
  public:
    /*!
     * Initializes the counter as zero.
     */
    reference_count_atomic(void);

    ~reference_count_atomic();

    /*!
     * Increment reference counter by 1.
     */
    void
    add_reference(void);

    /*!
     * Decrements the counter by 1 and returns status of if the counter
     * is 0 after the decrement operation.
     */
    bool
    remove_reference(void);

  private:
    void *m_d;
  };

/*! @} */
}

#endif