BookmarksKeeper(3)

Library Functions Manual

BookmarksKeeper(3)

NAME

BookmarksKeeper - The BookmarksKeeper class.

SYNOPSIS

#include <BookmarksKeeper.h>

Inherits UDBase.

Public Member Functions

BookmarksKeeper (const std::shared_ptr< MLBookProc > &mlbp)
BookmarksKeeper constructor. void loadBookmarksBase (const std::filesystem::path &bookmarks_base_path)
void addToBookmarks (const UDBElement &book_search_result)
void removeBookmark (const UDBElement &bookmark)
std::shared_mutex * getRawMutex ()

Detailed Description

The BookmarksKeeper class.

This class contains bookmarks database and methods to work with it. See also LibUDB documentation.

Constructor & Destructor Documentation

BookmarksKeeper::BookmarksKeeper (const std::shared_ptr< MLBookProc > & mlbp)

BookmarksKeeper constructor.

Parameters

mlbp Smart pointer to MLBookProc object.

Member Function Documentation

void BookmarksKeeper::addToBookmarks (const UDBElement & book_search_result)

Adds book to bookmarks.

Parameters

book_search_result UDBElement of BaseID::BookSearchResult type.

std::shared_mutex * BookmarksKeeper::getRawMutex ()

Returns pointer to internal mutex used to block bookmarks database calls.

Returns

Pointer to std::shared_mutex object.

void BookmarksKeeper::loadBookmarksBase (const std::filesystem::path & bookmarks_base_path)

Loads bookmarks database to memory.

Note

This method can throw std::exception in case of errors.

Parameters

bookmarks_base_path Path to bookmarks database.

void BookmarksKeeper::removeBookmark (const UDBElement & bookmark)

Removes bookmark from database.

Parameters

bookmark UDBElement of BaseID::BookMark type.

Author

Generated automatically by Doxygen for MLBookProc from the source code.

Version 2.1

MLBookProc