atomicOfstreamWrapper.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_BASE_TF_ATOMIC_OFSTREAM_WRAPPER_H
#define PXR_BASE_TF_ATOMIC_OFSTREAM_WRAPPER_H


#include "pxr/pxr.h"
#include "pxr/base/tf/api.h"

#include <boost/noncopyable.hpp>

#include <fstream>
#include <string>

PXR_NAMESPACE_OPEN_SCOPE

class TfAtomicOfstreamWrapper : boost::noncopyable
{
public:
    TF_API explicit TfAtomicOfstreamWrapper(const std::string& filePath);

    TF_API ~TfAtomicOfstreamWrapper();

    TF_API bool Open(std::string* reason = 0);

    TF_API bool Commit(std::string* reason = 0);

    TF_API bool Cancel(std::string* reason = 0);

    std::ofstream& GetStream() { return _stream; }

private:
    std::string _filePath;
    std::string _tmpFilePath;
    std::ofstream _stream;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_BASE_TF_ATOMIC_OFSTREAM_WRAPPER_H