Database external interface. More...

#include <database_iface.h>

Inheritance diagram for pstsdk::db_context:

Collaboration diagram for pstsdk::db_context:

Public Member Functions
virtual	~db_context ()

Lookup functions
virtual node	lookup_node (node_id nid)=0
	Open a node.

virtual node_info	lookup_node_info (node_id nid)=0
	Lookup information about a node.

virtual block_info	lookup_block_info (block_id bid)=0
	Lookup information about a block.

Page factory functions
virtual std::shared_ptr< bbt_page >	read_bbt_root ()=0
	Get the root of the BBT of this context.

virtual std::shared_ptr< nbt_page >	read_nbt_root ()=0
	Get the root of the NBT of this context.

virtual std::shared_ptr< bbt_page >	read_bbt_page (const page_info &pi)=0
	Open a BBT page.

virtual std::shared_ptr< nbt_page >	read_nbt_page (const page_info &pi)=0
	Open a NBT page.

virtual std::shared_ptr< nbt_leaf_page >	read_nbt_leaf_page (const page_info &pi)=0
	Open a NBT leaf page.

virtual std::shared_ptr< bbt_leaf_page >	read_bbt_leaf_page (const page_info &pi)=0
	Open a BBT leaf page.

virtual std::shared_ptr< nbt_nonleaf_page >	read_nbt_nonleaf_page (const page_info &pi)=0
	Open a NBT nonleaf page.

virtual std::shared_ptr< bbt_nonleaf_page >	read_bbt_nonleaf_page (const page_info &pi)=0
	Open a BBT nonleaf page.

Block factory functions
std::shared_ptr< block >	read_block (block_id bid)
	Open a block in this context.

std::shared_ptr< data_block >	read_data_block (block_id bid)
	Open a data_block in this context.

std::shared_ptr< extended_block >	read_extended_block (block_id bid)
	Open a extended_block in this context.

std::shared_ptr< external_block >	read_external_block (block_id bid)
	Open a external_block in this context.

std::shared_ptr< subnode_block >	read_subnode_block (block_id bid)
	Open a subnode_block in this context.

std::shared_ptr< subnode_leaf_block >	read_subnode_leaf_block (block_id bid)
	Open a subnode_leaf_block in this context.

std::shared_ptr< subnode_nonleaf_block >	read_subnode_nonleaf_block (block_id bid)
	Open a subnode_nonleaf_block in this context.

virtual std::shared_ptr< block >	read_block (const shared_db_ptr &parent, block_id bid)=0
	Open a block in the specified context.

virtual std::shared_ptr< data_block >	read_data_block (const shared_db_ptr &parent, block_id bid)=0
	Open a data_block in the specified context.

virtual std::shared_ptr< extended_block >	read_extended_block (const shared_db_ptr &parent, block_id bid)=0
	Open an extended_block in the specified context.

virtual std::shared_ptr< external_block >	read_external_block (const shared_db_ptr &parent, block_id bid)=0
	Open a external_block in the specified context.

virtual std::shared_ptr< subnode_block >	read_subnode_block (const shared_db_ptr &parent, block_id bid)=0
	Open a subnode_block in the specified context.

virtual std::shared_ptr< subnode_leaf_block >	read_subnode_leaf_block (const shared_db_ptr &parent, block_id bid)=0
	Open a subnode_leaf_block in the specified context.

virtual std::shared_ptr< subnode_nonleaf_block >	read_subnode_nonleaf_block (const shared_db_ptr &parent, block_id bid)=0
	Open a subnode_nonleaf_block in the specified context.

std::shared_ptr< block >	read_block (const block_info &bi)
	Open a block in this context.

std::shared_ptr< data_block >	read_data_block (const block_info &bi)
	Open a data_block in this context.

std::shared_ptr< extended_block >	read_extended_block (const block_info &bi)
	Open a extended_block in this context.

std::shared_ptr< external_block >	read_external_block (const block_info &bi)
	Open a block in this context.

std::shared_ptr< subnode_block >	read_subnode_block (const block_info &bi)
	Open a subnode_block in this context.

std::shared_ptr< subnode_leaf_block >	read_subnode_leaf_block (const block_info &bi)
	Open a subnode_leaf_block in this context.

std::shared_ptr< subnode_nonleaf_block >	read_subnode_nonleaf_block (const block_info &bi)
	Open a subnode_nonleaf_block in this context.

virtual std::shared_ptr< block >	read_block (const shared_db_ptr &parent, const block_info &bi)=0
	Open a block in the specified context.

virtual std::shared_ptr< data_block >	read_data_block (const shared_db_ptr &parent, const block_info &bi)=0
	Open a data_block in the specified context.

virtual std::shared_ptr< extended_block >	read_extended_block (const shared_db_ptr &parent, const block_info &bi)=0
	Open a extended_block in the specified context.

virtual std::shared_ptr< external_block >	read_external_block (const shared_db_ptr &parent, const block_info &bi)=0
	Open a external_block in the specified context.

virtual std::shared_ptr< subnode_block >	read_subnode_block (const shared_db_ptr &parent, const block_info &bi)=0
	Open a subnode_block in the specified context.

virtual std::shared_ptr< subnode_leaf_block >	read_subnode_leaf_block (const shared_db_ptr &parent, const block_info &bi)=0
	Open a subnode_leaf_block in the specified context.

virtual std::shared_ptr< subnode_nonleaf_block >	read_subnode_nonleaf_block (const shared_db_ptr &parent, const block_info &bi)=0
	Open a subnode_nonleaf_block in the specified context.

Detailed Description

Database external interface.

The db_context is the iterface which all components, NDB Layer and up, use to access the PST file. It is basically an object factory; given an address (or other relative context to help locate the physical piece of data) a db_context will produce an in memory version of that data structure, with all the Unicode vs. ANSI differences abstracted away.

Definition at line 115 of file database_iface.h.

Constructor & Destructor Documentation

◆ ~db_context()

virtual pstsdk::db_context::~db_context ( )

inlinevirtual

Definition at line 118 of file database_iface.h.

Member Function Documentation

◆ lookup_block_info()

virtual block_info pstsdk::db_context::lookup_block_info ( block_id bid )

pure virtual

Lookup information about a block.

Exceptions

key_not_found<block_id> if the specified block was not found

Parameters

[in] bid The id of the block to lookup

Returns: Information about the specified block

Implemented in pstsdk::database_impl< T >.

◆ lookup_node()

virtual node pstsdk::db_context::lookup_node ( node_id nid )

pure virtual

Open a node.

Exceptions

key_not_found<node_id> if the specified node was not found

Parameters

[in] nid The id of the node to lookup

Returns: A node instance

Implemented in pstsdk::database_impl< T >.

◆ lookup_node_info()

virtual node_info pstsdk::db_context::lookup_node_info ( node_id nid )

pure virtual

Lookup information about a node.

Exceptions

key_not_found<node_id> if the specified node was not found

Parameters

[in] nid The id of the node to lookup

Returns: Information about the specified node

Implemented in pstsdk::database_impl< T >.

◆ read_bbt_leaf_page()

virtual std::shared_ptr< bbt_leaf_page > pstsdk::db_context::read_bbt_leaf_page ( const page_info & pi )

pure virtual

Open a BBT leaf page.

Parameters

[in] pi Information about the page to open

Exceptions

unexpected_page	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the page appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's signature appears incorrect
database_corrupt	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's ptypeRepeat != ptype
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the page's CRC doesn't match the trailer

Returns: The requested page

Implemented in pstsdk::database_impl< T >.

◆ read_bbt_nonleaf_page()

virtual std::shared_ptr< bbt_nonleaf_page > pstsdk::db_context::read_bbt_nonleaf_page ( const page_info & pi )

pure virtual

Open a BBT nonleaf page.

Parameters

[in] pi Information about the page to open

Exceptions

unexpected_page	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the page appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's signature appears incorrect
database_corrupt	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's ptypeRepeat != ptype
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the page's CRC doesn't match the trailer

Returns: The requested page

Implemented in pstsdk::database_impl< T >.

◆ read_bbt_page()

virtual std::shared_ptr< bbt_page > pstsdk::db_context::read_bbt_page ( const page_info & pi )

pure virtual

Open a BBT page.

Exceptions

unexpected_page	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the page appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's signature appears incorrect
database_corrupt	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's ptypeRepeat != ptype
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the page's CRC doesn't match the trailer

Returns: The requested page

Implemented in pstsdk::database_impl< T >.

◆ read_bbt_root()

virtual std::shared_ptr< bbt_page > pstsdk::db_context::read_bbt_root ( )

pure virtual

Get the root of the BBT of this context.

Exceptions

unexpected_page	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the page appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's signature appears incorrect
database_corrupt	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's ptypeRepeat != ptype
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the page's CRC doesn't match the trailer

Returns: The requested page

Implemented in pstsdk::database_impl< T >.

◆ read_block() [1/4]

std::shared_ptr< block > pstsdk::db_context::read_block ( block_id bid )

inline

Open a block in this context.

Parameters

[in] bid The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 212 of file database_iface.h.

◆ read_block() [2/4]

std::shared_ptr< block > pstsdk::db_context::read_block ( const block_info & bi )

inline

Open a block in this context.

Parameters

[in] bi Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 318 of file database_iface.h.

◆ read_block() [3/4]

virtual std::shared_ptr< block > pstsdk::db_context::read_block	(	const shared_db_ptr &	parent,
		block_id	bid
	)

pure virtual

Open a block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bid	The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

◆ read_block() [4/4]

virtual std::shared_ptr< block > pstsdk::db_context::read_block	(	const shared_db_ptr &	parent,
		const block_info &	bi
	)

pure virtual

Open a block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bi	Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

◆ read_data_block() [1/4]

std::shared_ptr< data_block > pstsdk::db_context::read_data_block ( block_id bid )

inline

Open a data_block in this context.

Parameters

[in] bid The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 219 of file database_iface.h.

◆ read_data_block() [2/4]

std::shared_ptr< data_block > pstsdk::db_context::read_data_block ( const block_info & bi )

inline

Open a data_block in this context.

Parameters

[in] bi Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 325 of file database_iface.h.

◆ read_data_block() [3/4]

virtual std::shared_ptr< data_block > pstsdk::db_context::read_data_block	(	const shared_db_ptr &	parent,
		block_id	bid
	)

pure virtual

Open a data_block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bid	The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

◆ read_data_block() [4/4]

virtual std::shared_ptr< data_block > pstsdk::db_context::read_data_block	(	const shared_db_ptr &	parent,
		const block_info &	bi
	)

pure virtual

Open a data_block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bi	Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

◆ read_extended_block() [1/4]

std::shared_ptr< extended_block > pstsdk::db_context::read_extended_block ( block_id bid )

inline

Open a extended_block in this context.

Parameters

[in] bid The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 226 of file database_iface.h.

◆ read_extended_block() [2/4]

std::shared_ptr< extended_block > pstsdk::db_context::read_extended_block ( const block_info & bi )

inline

Open a extended_block in this context.

Parameters

[in] bi Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 332 of file database_iface.h.

◆ read_extended_block() [3/4]

virtual std::shared_ptr< extended_block > pstsdk::db_context::read_extended_block	(	const shared_db_ptr &	parent,
		block_id	bid
	)

pure virtual

Open an extended_block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bid	The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

◆ read_extended_block() [4/4]

virtual std::shared_ptr< extended_block > pstsdk::db_context::read_extended_block	(	const shared_db_ptr &	parent,
		const block_info &	bi
	)

pure virtual

Open a extended_block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bi	Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

◆ read_external_block() [1/4]

std::shared_ptr< external_block > pstsdk::db_context::read_external_block ( block_id bid )

inline

Open a external_block in this context.

Parameters

[in] bid The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 233 of file database_iface.h.

◆ read_external_block() [2/4]

std::shared_ptr< external_block > pstsdk::db_context::read_external_block ( const block_info & bi )

inline

Open a block in this context.

Parameters

[in] bi Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 339 of file database_iface.h.

◆ read_external_block() [3/4]

virtual std::shared_ptr< external_block > pstsdk::db_context::read_external_block	(	const shared_db_ptr &	parent,
		block_id	bid
	)

pure virtual

Open a external_block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bid	The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

◆ read_external_block() [4/4]

virtual std::shared_ptr< external_block > pstsdk::db_context::read_external_block	(	const shared_db_ptr &	parent,
		const block_info &	bi
	)

pure virtual

Open a external_block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bi	Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

◆ read_nbt_leaf_page()

virtual std::shared_ptr< nbt_leaf_page > pstsdk::db_context::read_nbt_leaf_page ( const page_info & pi )

pure virtual

Open a NBT leaf page.

Parameters

[in] pi Information about the page to open

Exceptions

unexpected_page	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the page appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's signature appears incorrect
database_corrupt	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's ptypeRepeat != ptype
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the page's CRC doesn't match the trailer

Returns: The requested page

Implemented in pstsdk::database_impl< T >.

◆ read_nbt_nonleaf_page()

virtual std::shared_ptr< nbt_nonleaf_page > pstsdk::db_context::read_nbt_nonleaf_page ( const page_info & pi )

pure virtual

Open a NBT nonleaf page.

Parameters

[in] pi Information about the page to open

Exceptions

unexpected_page	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the page appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's signature appears incorrect
database_corrupt	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's ptypeRepeat != ptype
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the page's CRC doesn't match the trailer

Returns: The requested page

Implemented in pstsdk::database_impl< T >.

◆ read_nbt_page()

virtual std::shared_ptr< nbt_page > pstsdk::db_context::read_nbt_page ( const page_info & pi )

pure virtual

Open a NBT page.

Parameters

[in] pi Information about the page to open

Exceptions

unexpected_page	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the page appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's signature appears incorrect
database_corrupt	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's ptypeRepeat != ptype
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the page's CRC doesn't match the trailer

Returns: The requested page

Implemented in pstsdk::database_impl< T >.

◆ read_nbt_root()

virtual std::shared_ptr< nbt_page > pstsdk::db_context::read_nbt_root ( )

pure virtual

Get the root of the NBT of this context.

Exceptions

unexpected_page	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the page appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's signature appears incorrect
database_corrupt	(PSTSDK_VALIDATION_LEVEL_WEAK) If the page trailer's ptypeRepeat != ptype
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the page's CRC doesn't match the trailer

Returns: The requested page

Implemented in pstsdk::database_impl< T >.

◆ read_subnode_block() [1/4]

std::shared_ptr< subnode_block > pstsdk::db_context::read_subnode_block ( block_id bid )

inline

Open a subnode_block in this context.

Parameters

[in] bid The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 240 of file database_iface.h.

◆ read_subnode_block() [2/4]

std::shared_ptr< subnode_block > pstsdk::db_context::read_subnode_block ( const block_info & bi )

inline

Open a subnode_block in this context.

Parameters

[in] bi Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 346 of file database_iface.h.

◆ read_subnode_block() [3/4]

virtual std::shared_ptr< subnode_block > pstsdk::db_context::read_subnode_block	(	const shared_db_ptr &	parent,
		block_id	bid
	)

pure virtual

Open a subnode_block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bid	The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

◆ read_subnode_block() [4/4]

virtual std::shared_ptr< subnode_block > pstsdk::db_context::read_subnode_block	(	const shared_db_ptr &	parent,
		const block_info &	bi
	)

pure virtual

Open a subnode_block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bi	Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

◆ read_subnode_leaf_block() [1/4]

std::shared_ptr< subnode_leaf_block > pstsdk::db_context::read_subnode_leaf_block ( block_id bid )

inline

Open a subnode_leaf_block in this context.

Parameters

[in] bid The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 247 of file database_iface.h.

◆ read_subnode_leaf_block() [2/4]

std::shared_ptr< subnode_leaf_block > pstsdk::db_context::read_subnode_leaf_block ( const block_info & bi )

inline

Open a subnode_leaf_block in this context.

Parameters

[in] bi Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 353 of file database_iface.h.

◆ read_subnode_leaf_block() [3/4]

virtual std::shared_ptr< subnode_leaf_block > pstsdk::db_context::read_subnode_leaf_block	(	const shared_db_ptr &	parent,
		block_id	bid
	)

pure virtual

Open a subnode_leaf_block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bid	The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

◆ read_subnode_leaf_block() [4/4]

virtual std::shared_ptr< subnode_leaf_block > pstsdk::db_context::read_subnode_leaf_block	(	const shared_db_ptr &	parent,
		const block_info &	bi
	)

pure virtual

Open a subnode_leaf_block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bi	Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

◆ read_subnode_nonleaf_block() [1/4]

std::shared_ptr< subnode_nonleaf_block > pstsdk::db_context::read_subnode_nonleaf_block ( block_id bid )

inline

Open a subnode_nonleaf_block in this context.

Parameters

[in] bid The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 254 of file database_iface.h.

◆ read_subnode_nonleaf_block() [2/4]

std::shared_ptr< subnode_nonleaf_block > pstsdk::db_context::read_subnode_nonleaf_block ( const block_info & bi )

inline

Open a subnode_nonleaf_block in this context.

Parameters

[in] bi Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Definition at line 360 of file database_iface.h.

◆ read_subnode_nonleaf_block() [3/4]

virtual std::shared_ptr< subnode_nonleaf_block > pstsdk::db_context::read_subnode_nonleaf_block	(	const shared_db_ptr &	parent,
		block_id	bid
	)

pure virtual

Open a subnode_nonleaf_block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bid	The id of the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

◆ read_subnode_nonleaf_block() [4/4]

virtual std::shared_ptr< subnode_nonleaf_block > pstsdk::db_context::read_subnode_nonleaf_block	(	const shared_db_ptr &	parent,
		const block_info &	bi
	)

pure virtual

Open a subnode_nonleaf_block in the specified context.

Parameters

[in]	parent	The context to open this block in. It must be either this context or a child context of this context.
[in]	bi	Information about the block to open

Exceptions

unexpected_block	(PSTSDK_VALIDATION_LEVEL_WEAK) If the parameters of the block appear incorrect
sig_mismatch	(PSTSDK_VALIDATION_LEVEL_WEAK) If the block trailer's signature appears incorrect
crc_fail	(PSTSDK_VALIDATION_LEVEL_FULL) If the block's CRC doesn't match the trailer

Returns: The requested block

Implemented in pstsdk::database_impl< T >.

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

pstsdk/ndb/database_iface.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~db_context()

Member Function Documentation

◆ lookup_block_info()

◆ lookup_node()

◆ lookup_node_info()

◆ read_bbt_leaf_page()

◆ read_bbt_nonleaf_page()

◆ read_bbt_page()

◆ read_bbt_root()

◆ read_block() [1/4]

◆ read_block() [2/4]

◆ read_block() [3/4]

◆ read_block() [4/4]

◆ read_data_block() [1/4]

◆ read_data_block() [2/4]

◆ read_data_block() [3/4]

◆ read_data_block() [4/4]

◆ read_extended_block() [1/4]

◆ read_extended_block() [2/4]

◆ read_extended_block() [3/4]

◆ read_extended_block() [4/4]

◆ read_external_block() [1/4]

◆ read_external_block() [2/4]

◆ read_external_block() [3/4]

◆ read_external_block() [4/4]

◆ read_nbt_leaf_page()

◆ read_nbt_nonleaf_page()

◆ read_nbt_page()

◆ read_nbt_root()

◆ read_subnode_block() [1/4]

◆ read_subnode_block() [2/4]

◆ read_subnode_block() [3/4]

◆ read_subnode_block() [4/4]

◆ read_subnode_leaf_block() [1/4]

◆ read_subnode_leaf_block() [2/4]

◆ read_subnode_leaf_block() [3/4]

◆ read_subnode_leaf_block() [4/4]

◆ read_subnode_nonleaf_block() [1/4]

◆ read_subnode_nonleaf_block() [2/4]

◆ read_subnode_nonleaf_block() [3/4]

◆ read_subnode_nonleaf_block() [4/4]