Loading...
Searching...
No Matches
atomicOfstreamWrapper.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the Apache License, Version 2.0 (the "Apache License")
5// with the following modification; you may not use this file except in
6// compliance with the Apache License and the following modification to it:
7// Section 6. Trademarks. is deleted and replaced with:
8//
9// 6. Trademarks. This License does not grant permission to use the trade
10// names, trademarks, service marks, or product names of the Licensor
11// and its affiliates, except as required to comply with Section 4(c) of
12// the License and to reproduce the content of the NOTICE file.
13//
14// You may obtain a copy of the Apache License at
15//
16// http://www.apache.org/licenses/LICENSE-2.0
17//
18// Unless required by applicable law or agreed to in writing, software
19// distributed under the Apache License with the above modification is
20// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21// KIND, either express or implied. See the Apache License for the specific
22// language governing permissions and limitations under the Apache License.
23//
24#ifndef PXR_BASE_TF_ATOMIC_OFSTREAM_WRAPPER_H
25#define PXR_BASE_TF_ATOMIC_OFSTREAM_WRAPPER_H
26
29
30#include "pxr/pxr.h"
31#include "pxr/base/tf/api.h"
32
33#include <fstream>
34#include <string>
35
36PXR_NAMESPACE_OPEN_SCOPE
37
78{
80 TfAtomicOfstreamWrapper& operator=(
81 const TfAtomicOfstreamWrapper&) = delete;
82public:
84 TF_API explicit TfAtomicOfstreamWrapper(const std::string& filePath);
85
88
95 TF_API bool Open(std::string* reason = 0);
96
102 TF_API bool Commit(std::string* reason = 0);
103
105 TF_API bool Cancel(std::string* reason = 0);
106
110 std::ofstream& GetStream() { return _stream; }
111
112private:
113 std::string _filePath;
114 std::string _tmpFilePath;
115 std::ofstream _stream;
116};
117
118PXR_NAMESPACE_CLOSE_SCOPE
119
120#endif // PXR_BASE_TF_ATOMIC_OFSTREAM_WRAPPER_H
A class that wraps a file output stream, providing improved tolerance for write failures.
TF_API bool Commit(std::string *reason=0)
Synchronizes the temporary file contents to disk, and renames the temporary file into the file path p...
TF_API ~TfAtomicOfstreamWrapper()
Destructor. Calls Cancel().
TF_API bool Cancel(std::string *reason=0)
Closes the temporary file and removes it from disk, if it exists.
TF_API TfAtomicOfstreamWrapper(const std::string &filePath)
Constructor.
std::ofstream & GetStream()
Returns the stream.
TF_API bool Open(std::string *reason=0)
Opens the temporary file for writing.