Merge pull request #655 from jgrewe/flush

add flush method to File

LGTM

Author: gicmo

backend/fs/FileFS.hpp

@@ -31,6 +31,9 @@ class FileFS : public base::IFile, public DirectoryWithAttributes, public std::e
     FileFS(const std::string &name, const FileMode mode = FileMode::ReadWrite);
 
 
+    bool flush() { return true; };
+
+
     ndsize_t blockCount() const;
 
 

backend/hdf5/FileHDF5.cpp

@@ -39,7 +39,6 @@ static unsigned int map_file_mode(FileMode mode) {
         default:
             return H5F_ACC_DEFAULT;
     }
-
 }
 
 
@@ -84,6 +83,12 @@ FileHDF5::FileHDF5(const string &name, FileMode mode)
     setUpdatedAt();
 }
 
+
+bool FileHDF5::flush() {
+    HErr err = H5Fflush(hid, H5F_SCOPE_GLOBAL);
+    return !err.isError();
+}        
+
 //--------------------------------------------------
 // Methods concerning blocks
 //--------------------------------------------------

backend/hdf5/FileHDF5.hpp

@@ -48,6 +48,8 @@ class FileHDF5 : public H5Object, public base::IFile, public std::enable_shared_
     // Methods concerning blocks
     //--------------------------------------------------
 
+    bool flush();
+    
 
     ndsize_t blockCount() const;
 

include/nix/File.hpp

@@ -90,6 +90,13 @@ class NIXAPI File : public base::ImplContainer<base::IFile> {
     static File open(const std::string &name, FileMode mode=FileMode::ReadWrite,
                      const std::string &impl="hdf5");
 
+    /**
+     * @brief Persists all cached changes to the backend.
+     *
+     */
+    bool flush();
+
+    
     /**
      * @brief Get the number of blocks in in the file.
      *

include/nix/base/IFile.hpp

@@ -44,6 +44,9 @@ class NIXAPI IFile {
 
 public:
 
+    virtual bool flush() = 0;
+
+
     virtual ndsize_t blockCount() const = 0;
 
 

src/File.cpp

@@ -39,6 +39,11 @@ File File::open(const std::string &name, FileMode mode, const std::string &impl)
 }
 
 
+bool File::flush() {
+    return backend()->flush();
+}
+
+    
 Block File::createBlock(const std::string &name, const std::string &type) {
     util::checkEntityNameAndType(name, type);
     if (backend()->hasBlock(name)) {

test/BaseTestFile.cpp

@@ -24,6 +24,14 @@ void BaseTestFile::testOpen() {
 }
 
 
+void BaseTestFile::testFlush() {
+    CPPUNIT_ASSERT(file_open.flush());
+    for (int i = 0; i < 10; ++i) {
+        file_open.createBlock("test_" + nix::util::numToStr(i), "test");
+        CPPUNIT_ASSERT(file_open.flush());
+    }
+}
+
 void BaseTestFile::testValidate() {
     valid::Result result = validate(file_open);
     CPPUNIT_ASSERT(result.getErrors().size() == 0);

test/BaseTestFile.hpp

@@ -35,6 +35,7 @@ class BaseTestFile : public CPPUNIT_NS::TestFixture {
 public:
 
     void testOpen();
+    void testFlush();
     void testValidate();
     void testFormat();
     virtual void testLocation() = 0;

test/fs/TestFileFS.hpp

@@ -14,6 +14,7 @@ class TestFileFS: public BaseTestFile {
 
     CPPUNIT_TEST_SUITE(TestFileFS);
     CPPUNIT_TEST(testOpen);
+    CPPUNIT_TEST(testFlush);
     CPPUNIT_TEST(testValidate);
     CPPUNIT_TEST(testFormat);
     CPPUNIT_TEST(testLocation);

test/hdf5/TestFileHDF5.hpp

@@ -11,6 +11,7 @@ class TestFileHDF5: public BaseTestFile {
 
     CPPUNIT_TEST_SUITE(TestFileHDF5);
     CPPUNIT_TEST(testOpen);
+    CPPUNIT_TEST(testFlush);
     CPPUNIT_TEST(testValidate);
     CPPUNIT_TEST(testFormat);
     CPPUNIT_TEST(testLocation);