Scroll to navigation

kdb::tools::merging::MergingKDB(3elektra) Elektra kdb::tools::merging::MergingKDB(3elektra)

NAME

kdb::tools::merging::MergingKDB - Provides a merging wrapper around a KDB instance.

SYNOPSIS

#include <mergingkdb.hpp>

Inherits kdb::KDB.

Public Member Functions


int get (KeySet &returned, std::string const &keyname) override
Behaves like the KDB get function. int get (KeySet &returned, Key &parentKey) override
Behaves like the KDB get function. virtual int synchronize (KeySet &returned, std::string const &keyname, ThreeWayMerge &merger)
Synchronizes the file with the supplied KeySet. virtual int synchronize (KeySet &returned, Key &parentKey, ThreeWayMerge &merger)
If a conflict occurs during set, the supplied merger is used to resolve the conflict.

Detailed Description

Provides a merging wrapper around a KDB instance.

The wrapper allows to pass a three way merger instance that is used to resolve conflicts during KDB set.

Member Function Documentation

int kdb::tools::merging::MergingKDB::get (KeySet & returned, std::string const & keyname) [override], [virtual]

Behaves like the KDB get function.

See also:

KDB

Reimplemented from kdb::KDB.

int kdb::tools::merging::MergingKDB::get (KeySet & returned, Key & parentKey) [override], [virtual]

Behaves like the KDB get function.

See also:

KDB

Reimplemented from kdb::KDB.

int kdb::tools::merging::MergingKDB::synchronize (KeySet & returned, std::string const & keyname, ThreeWayMerge & merger) [virtual]

Synchronizes the file with the supplied KeySet. If a conflict occurs during set, the supplied merger is used to resolve the conflict. If the conflict cannot be solved, an exception is thrown. If the KeySet was successfully written (either by merging or due the absence of a conflict) the supplied KeySet is updated with the new content of the file.

See also:

KDB

Exceptions:

MergingKDBException

int kdb::tools::merging::MergingKDB::synchronize (KeySet & returned, Key & parentKey, ThreeWayMerge & merger) [virtual]

If a conflict occurs during set, the supplied merger is used to resolve the conflict. If the conflict cannot be solved, an exception is thrown. If the KeySet was successfully written (either by merging or due the absence of a conflict) the supplied KeySet is updated with the new content of the file.

See also:

KDB

Exceptions:

MergingKDBException

Author

Generated automatically by Doxygen for Elektra from the source code.

Mon Jan 15 2018 Version 0.8.20