sysio::pending_snapshot Class Reference

Collaboration diagram for sysio::pending_snapshot:

Public Types
using	next_t = producer_plugin::next_function<producer_plugin::snapshot_information>

Public Member Functions
	pending_snapshot (const block_id_type &block_id, next_t &next, std::string pending_path, std::string final_path)
uint32_t	get_height () const
producer_plugin::snapshot_information	finalize (const chain::controller &chain) const

Static Public Member Functions
static bfs::path	get_final_path (const block_id_type &block_id, const bfs::path &snapshots_dir)
static bfs::path	get_pending_path (const block_id_type &block_id, const bfs::path &snapshots_dir)
static bfs::path	get_temp_path (const block_id_type &block_id, const bfs::path &snapshots_dir)

Public Attributes
block_id_type	block_id
next_t	next
std::string	pending_path
std::string	final_path

Detailed Description

Definition at line 122 of file producer_plugin.cpp.

Member Typedef Documentation

next_t

using sysio::pending_snapshot::next_t = producer_plugin::next_function<producer_plugin::snapshot_information>

Definition at line 124 of file producer_plugin.cpp.

Constructor & Destructor Documentation

pending_snapshot()

sysio::pending_snapshot::pending_snapshot ( const block_id_type & block_id, next_t & next, std::string pending_path, std::string final_path )

inline

Definition at line 126 of file producer_plugin.cpp.

   : block_id(block_id)
   , next(next)
   , pending_path(pending_path)
   , final_path(final_path)
   {}

Member Function Documentation

finalize()

producer_plugin::snapshot_information sysio::pending_snapshot::finalize ( const chain::controller & chain ) const

inline

Definition at line 149 of file producer_plugin.cpp.

                                                                                      {
      auto block_ptr = chain.fetch_block_by_id( block_id );
      auto in_chain = (bool)block_ptr;
      boost::system::error_code ec;
 
      if (!in_chain) {
         bfs::remove(bfs::path(pending_path), ec);
         SYS_THROW(snapshot_finalization_exception,
                   "Snapshotted block was forked out of the chain.  ID: ${block_id}",
                   ("block_id", block_id));
      }
 
      bfs::rename(bfs::path(pending_path), bfs::path(final_path), ec);
      SYS_ASSERT(!ec, snapshot_finalization_exception,
                 "Unable to finalize valid snapshot of block number ${bn}: [code: ${ec}] ${message}",
                 ("bn", get_height())
                 ("ec", ec.value())
                 ("message", ec.message()));
 
      return {block_id, block_ptr->block_num(), block_ptr->timestamp, chain_snapshot_header::current_version, final_path};
   }

Here is the call graph for this function:

get_final_path()

static bfs::path sysio::pending_snapshot::get_final_path ( const block_id_type & block_id, const bfs::path & snapshots_dir )

inlinestatic

Definition at line 137 of file producer_plugin.cpp.

                                                                                              {
      return snapshots_dir / fc::format_string("snapshot-${id}.bin", fc::mutable_variant_object()("id", block_id));
   }

Here is the call graph for this function:

Here is the caller graph for this function:

get_height()

uint32_t sysio::pending_snapshot::get_height ( ) const

inline

Definition at line 133 of file producer_plugin.cpp.

                               {
      return block_header::num_from_id(block_id);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

get_pending_path()

static bfs::path sysio::pending_snapshot::get_pending_path ( const block_id_type & block_id, const bfs::path & snapshots_dir )

inlinestatic

Definition at line 141 of file producer_plugin.cpp.

                                                                                                {
      return snapshots_dir / fc::format_string(".pending-snapshot-${id}.bin", fc::mutable_variant_object()("id", block_id));
   }

Here is the call graph for this function:

Here is the caller graph for this function:

get_temp_path()

static bfs::path sysio::pending_snapshot::get_temp_path ( const block_id_type & block_id, const bfs::path & snapshots_dir )

inlinestatic

Definition at line 145 of file producer_plugin.cpp.

                                                                                             {
      return snapshots_dir / fc::format_string(".incomplete-snapshot-${id}.bin", fc::mutable_variant_object()("id", block_id));
   }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

block_id

block_id_type sysio::pending_snapshot::block_id

Definition at line 171 of file producer_plugin.cpp.

final_path

std::string sysio::pending_snapshot::final_path

Definition at line 174 of file producer_plugin.cpp.

next

next_t sysio::pending_snapshot::next

Definition at line 172 of file producer_plugin.cpp.

pending_path

std::string sysio::pending_snapshot::pending_path

Definition at line 173 of file producer_plugin.cpp.

---

The documentation for this class was generated from the following file:

• plugins/producer_plugin/producer_plugin.cpp