BufferedValue.h

// This file is a part of the OpenSurgSim project.
// Copyright 2013, SimQuest Solutions Inc.
//
// 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.

#ifndef SURGSIM_DATASTRUCTURES_BUFFEREDVALUE_H
#define SURGSIM_DATASTRUCTURES_BUFFEREDVALUE_H

#include <memory>
#include <utility>
#include <boost/thread.hpp>
#include "SurgSim/Framework/Assert.h"

namespace SurgSim
{
namespace DataStructures
{

template <class T>
class BufferedValue
{
public:

    // Default Constructor
    BufferedValue();

    // Constructor
    explicit BufferedValue(const T& value);

    ~BufferedValue();

    void publish();

    T& unsafeGet();

    std::shared_ptr<const T> safeGet() const;

private:
    typedef boost::shared_lock<boost::shared_mutex> SharedLock;
    typedef boost::unique_lock<boost::shared_mutex> UniqueLock;

    T m_value;

    std::shared_ptr<const T> m_safeValue;

    mutable boost::shared_mutex m_mutex;

};

} // DataStructures
} // SurgSim

#include "SurgSim/DataStructures/BufferedValue-inl.h"

#endif