cpr_checkpoint.hpp

Go to the documentation of this file.

#ifndef SAGA_PACKAGES_DATA_CPR_CHECKPOINT_HPP
#define SAGA_PACKAGES_DATA_CPR_CHECKPOINT_HPP

#if defined(__WAVE__)
#pragma wave option(preserve: 2, line: 1, output: "preprocessed/cpr_checkpoint.hpp")
#endif
//  Copyright (c) 2005-2009 Hartmut Kaiser
//  Copyright (c) 2007 Ole Weidner (oweidner@cct.lsu.edu)
//  Copyright (c) 2008 Andre Merzky (andre@merzky.net)
// 
//  Distributed under the Boost Software License, Version 1.0. (See accompanying 
//  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

#if defined(__WAVE__)
#pragma wave option(preserve: 0, output: null)
#endif

#if defined(_MSC_VER) && (_MSC_VER >= 1200)
#pragma once
#endif 

#include <string>
#include <vector>

// include dependent spec sections
#include <saga/saga/util.hpp>
#include <saga/saga/base.hpp>
#include <saga/saga/types.hpp>
#include <saga/saga/session.hpp>
#include <saga/saga/call.hpp>
#include <saga/saga/filesystem.hpp>
#include <saga/saga/detail/attribute.hpp>

#include <saga/saga/packages/namespace/namespace_entry.hpp>
#include <saga/saga/packages/cpr/config.hpp>

// suppress warnings about dependent classes not being exported from the dll
#if defined(BOOST_MSVC)
#pragma warning(push)
#pragma warning(disable: 4251 4231 4275 4660 4244)
#endif

#ifdef SAGA_DEBUG
#include <saga/saga/packages/cpr/preprocessed/cpr_checkpoint.hpp>
#else

#if defined(__WAVE__)
#pragma wave option(preserve: 2, line: 1, output: "preprocessed/cpr_checkpoint.hpp")
#endif

namespace saga
{
    namespace cpr 
    {
        
        namespace metrics 
        {
            //  metric names for a advert entries
            char const* const checkpoint_modified = "checkpoint.Modified";
            char const* const checkpoint_deleted  = "checkpoint.Deleted";
        }
        
        
        enum flags 
        {
            // Unknown         = /*  -1, */  saga::name_space::Unknown       ,
            None            = /*   0, */  saga::name_space::None          ,
            Overwrite       = /*   1, */  saga::name_space::Overwrite     ,
            Recursive       = /*   2, */  saga::name_space::Recursive     ,
            Dereference     = /*   4, */  saga::name_space::Dereference,
            Create          = /*   8, */  saga::name_space::Create        ,
            Exclusive       = /*  16, */  saga::name_space::Exclusive     ,
            Lock            = /*  32, */  saga::name_space::Lock          ,
            CreateParents   = /*  64, */  saga::name_space::CreateParents ,
            Truncate        =    128,
            Append          =    256, 
            Read            =    512,
            Write           =   1024,
            ReadWrite       =   Read | Write
            // Binary          =   2048      // reserved
        };             
        
        namespace attributes 
        {
            char const* const cpr_time             = "Time";

            char const* const cpr_nfliles          = "NFiles";

            char const* const cpr_mode             = "Mode";

            char const* const cpr_mode_full        = "Full";
            char const* const cpr_mode_incremental = "Incremental";

            char const* const cpr_parent           = "Parent";

            char const* const cpr_children         = "Children";
        }

        class SAGA_CPR_PACKAGE_EXPORT checkpoint 
        : public saga::name_space::entry,
        public saga::detail::attribute<checkpoint>
        {
        protected:

            friend class saga::impl::cpr_checkpoint;
            friend struct saga::detail::attribute<checkpoint>;  // needs to access get_impl()
            typedef saga::detail::attribute<checkpoint> attribute_base;
            typedef saga::name_space::entry::monitorable_base monitorable_base;
            
        private:
            // factory
            SAGA_CALL_CREATE_PRIV_3(session const&, saga::url, int)

            
            SAGA_CALL_PRIV_2 (set_parent,  saga::url, int)
            SAGA_CALL_PRIV_1 (get_parent,  int)
            SAGA_CALL_PRIV_0 (get_file_num)
            SAGA_CALL_PRIV_0 (list_files)
            SAGA_CALL_PRIV_1 (add_file,    saga::url)
            SAGA_CALL_PRIV_1 (get_file,    int)
            SAGA_CALL_PRIV_2 (open_file,   int,       int)
            SAGA_CALL_PRIV_2 (open_file,   saga::url, int)
            SAGA_CALL_PRIV_1 (remove_file, int)
            SAGA_CALL_PRIV_1 (remove_file, saga::url)
            SAGA_CALL_PRIV_2 (update_file, int,       saga::url)
            SAGA_CALL_PRIV_2 (update_file, saga::url, saga::url)
            SAGA_CALL_PRIV_2 (stage_file,  int,       saga::url)
            SAGA_CALL_PRIV_2 (stage_file,  saga::url, saga::url)
            SAGA_CALL_PRIV_1 (stage_file,  saga::url)

        protected:

            TR1::shared_ptr <saga::impl::cpr_checkpoint> get_impl_sp(void) const;
            saga::impl::cpr_checkpoint* get_impl (void) const;
            explicit checkpoint(saga::impl::cpr_checkpoint *impl);

        public:
            checkpoint (session const& s, saga::url url, int mode = Read);

            explicit checkpoint (saga::url url, int mode = Read);

            explicit checkpoint (saga::object const& o);

            checkpoint (void);

            ~checkpoint (void);

            static checkpoint create(session const& s, saga::url url, 
                int mode = Read)
            {
                return checkpoint(s, url, mode);
            }
            SAGA_CALL_CREATE_3_DEF_1(session const&, saga::url, int, Read)

            
            static checkpoint create(saga::url url, int mode = Read)
            {
                return checkpoint(url, mode);
            }
            template <typename Tag>
            static saga::task create(saga::url url, int mode = Read)
            {
                return create<Tag>(detail::get_the_session(), url, mode);
            }

            checkpoint& operator=(saga::object const& o);
            
            void set_parent (saga::url url, int generation = 1) 
            {
                saga::task t = set_parentpriv(url, generation, saga::task_base::Sync()); 
                t.get_result ();
            }
            SAGA_CALL_PUB_2_DEF_1 (set_parent, saga::url, int, 1)
            
            
            saga::url get_parent (int generation = 1) 
            {
                saga::task t = get_parentpriv(generation, saga::task_base::Sync()); 
                return t.get_result <saga::url> ();
            }
            SAGA_CALL_PUB_1_DEF_1 (get_parent, int, 1)
            
            
            
            std::vector <saga::url> list_files (void) 
            {
                saga::task t = list_filespriv (saga::task_base::Sync()); 
                return t.get_result <std::vector <saga::url> > ();
            }
            SAGA_CALL_PUB_0_DEF_0 (list_files)
            
            
            int add_file (saga::url url) 
            {
                saga::task t = add_filepriv(url, saga::task_base::Sync()); 
                return t.get_result <int> ();
            }
            SAGA_CALL_PUB_1_DEF_0 (add_file, saga::url)
            
            
            
            saga::url get_file (int id) 
            {
                saga::task t = get_filepriv(id, saga::task_base::Sync()); 
                return t.get_result <saga::url> ();
            }
            SAGA_CALL_PUB_1_DEF_0 (get_file, int)
            
            
            
            saga::filesystem::file open_file (int id, 
                                              int flags = CreateParents | Lock | ReadWrite) 
            {
                saga::task t = open_filepriv(id, flags, saga::task_base::Sync()); 
                return t.get_result <saga::filesystem::file> ();
            }
            SAGA_CALL_PUB_2_DEF_1 (open_file, int, int, CreateParents | Lock | ReadWrite )
            
            
            saga::filesystem::file open_file (saga::url url, 
                                              int flags = CreateParents | Lock | ReadWrite) 
            {
                saga::task t = open_filepriv(url, flags, saga::task_base::Sync()); 
                return t.get_result <saga::filesystem::file> ();
            }
            SAGA_CALL_PUB_2_DEF_1 (open_file, saga::url, int, CreateParents | Lock | ReadWrite)
            
            
            
            void remove_file (int id)
            {
                saga::task t = remove_filepriv(id, saga::task_base::Sync()); 
                t.get_result ();
            }
            SAGA_CALL_PUB_1_DEF_0 (remove_file, int)
            
            
            void remove_file (saga::url url)
            {
                saga::task t = remove_filepriv(url, saga::task_base::Sync()); 
                t.get_result ();
            }
            SAGA_CALL_PUB_1_DEF_0 (remove_file, saga::url)
            
            
            
            void update_file (int id, saga::url new_url)
            {
                saga::task t = update_filepriv(id, new_url, saga::task_base::Sync()); 
                t.get_result ();
            }
            SAGA_CALL_PUB_2_DEF_0 (update_file, int, saga::url)
            
            
            void update_file (saga::url old_url, saga::url new_url)
            {
                saga::task t = update_filepriv(old_url, new_url, saga::task_base::Sync()); 
                t.get_result ();
            }
            SAGA_CALL_PUB_2_DEF_0 (update_file, saga::url, saga::url)
            
            
            
            void stage_file (int id, saga::url new_url)
            {
                saga::task t = stage_filepriv(id, new_url, saga::task_base::Sync()); 
                t.get_result ();
            }
            SAGA_CALL_PUB_2_DEF_0 (stage_file, int, saga::url)
            
            
            void stage_file (saga::url old_url, saga::url new_url)
            {
                saga::task t = stage_filepriv(old_url, new_url, saga::task_base::Sync()); 
                t.get_result ();
            }
            SAGA_CALL_PUB_2_DEF_0 (stage_file, saga::url, saga::url)
            
            
            void stage_file (saga::url new_url)
            {
                saga::task t = stage_filepriv(new_url, saga::task_base::Sync()); 
                t.get_result ();
            }
            SAGA_CALL_PUB_1_DEF_0 (stage_file, saga::url)
        }; 
        
    }}   

#if defined(__WAVE__)
#pragma wave option(output: null)
#endif

#endif // !defined(SAGA_DEBUG)

// re-enable warnings about dependent classes not being exported from the dll
#if defined(BOOST_MSVC)
#pragma warning(pop)
#endif

#endif // !defined(SAGA_PACKAGES_DATA_CPR_CHECKPOINT_HPP)