All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 TF_ATOMIC_OSTREAM_WRAPPER_H
25 #define TF_ATOMIC_OSTREAM_WRAPPER_H
26 
29 
30 #include "pxr/pxr.h"
31 #include "pxr/base/tf/api.h"
32 
33 #include <boost/noncopyable.hpp>
34 
35 #include <fstream>
36 #include <string>
37 
38 PXR_NAMESPACE_OPEN_SCOPE
39 
79 class TfAtomicOfstreamWrapper : boost::noncopyable
80 {
81 public:
83  TF_API explicit TfAtomicOfstreamWrapper(const std::string& filePath);
84 
86  TF_API ~TfAtomicOfstreamWrapper();
87 
94  TF_API bool Open(std::string* reason = 0);
95 
101  TF_API bool Commit(std::string* reason = 0);
102 
104  TF_API bool Cancel(std::string* reason = 0);
105 
109  std::ofstream& GetStream() { return _stream; }
110 
111 private:
112  std::string _filePath;
113  std::string _tmpFilePath;
114  std::ofstream _stream;
115 };
116 
117 PXR_NAMESPACE_CLOSE_SCOPE
118 
119 #endif // TF_ATOMIC_OSTREAM_WRAPPER_H
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 bool Open(std::string *reason=0)
Opens the temporary file for writing.
TF_API TfAtomicOfstreamWrapper(const std::string &filePath)
Constructor.
std::ofstream & GetStream()
Returns the stream.
A class that wraps a file output stream, providing improved tolerance for write failures.
TF_API bool Cancel(std::string *reason=0)
Closes the temporary file and removes it from disk, if it exists.
TF_API ~TfAtomicOfstreamWrapper()
Destructor. Calls Cancel().