Libdap-chain-global-db-python

From wiki.cellframe.net
Jump to navigation Jump to search

libdap-chain-global-db-python

Эта библиотека является обёрткой над библиотекой libdap-chain-global-db. И соответственно предоставляет доступ к библиотеки libdap-chain-global-db к структурам и функциям.

Предоставляемые типы объектов

ChainGlobalDB

Объект типа ChainGlobalDB представляет собой обёртку над структурой dap_global_db_obj_t и предоставляет следующие функции:

  • flush - Данная функция, на вход не принимает аргументов, является статической. Возвращает числовое значение. Вызывает сброс данных из БД на диск. Данная функция является обёрткой над функцией dap_chain_global_db_flush.
  • addHistoryGroupPrefix - Данная функция, принимает на вход один аргумент: строку - префикс. Возвращает всегда ноль. Функция добавляет в историческую группу префикс. Данная функция является обёрткой над функцией dap_chain_global_db_add_history_group_prefix.
  • addHistoryCallbackNotify - Данная функция на вход принимает три аргумента: строку - префикс группы, функцию обратного вызова, объект типа bytes. Функция создаёт уведомления при событии для определённой группы, определяемой префиксом, вызывается указанная функция, с указанными аргументами. Данная функция является обёрткой над функцией dap_chain_global_db_add_history_callback_notify.
  • grGet - Данная функция на вход принимает три аргумента: строку - ключ, список размеров, строку - группу. Функция возвращает строку. Данная функция получает данные из группы. Данная функция является обёрткой над функцией dap_chain_global_db_gr_get.
  • grSet - Данная функция на вход принимает три аргумента: строку - ключ, объект типа bytes, строку - группу. Функция возвращает логическое значение. Функция добавляет в группу данные принятые из второго параметра. Данная функция является обёрткой над функцией dap_chain_global_db_gr_set.
  • grDel - Данная функция на вход принимает два аргумента: строка - ключ, строка - группа. Функция удаляет объекты группы. Функция возвращает логическое значение. Функция является обёрткой над функцией dap_chain_global_db_gr_del.

Так же объект типа ChainGlobalDB конструктором и деструктором. Деструктор является обёрткой над функцией dap_chain_global_db_obj_delete.