diff options
author | Ingo Huerner <ingo.huerner@xse.de> | 2015-01-22 11:24:12 +0100 |
---|---|---|
committer | Ingo Huerner <ingo.huerner@xse.de> | 2015-01-22 11:24:12 +0100 |
commit | b596d8b27f952ab1bbc049b384c465d2e139e135 (patch) | |
tree | 75aaef2b3229939929eaf55b449b7b387ac83d23 /include | |
parent | ddccbec6d938dd3b7b8a644d5a191d1f673173a0 (diff) | |
download | persistence-client-library-b596d8b27f952ab1bbc049b384c465d2e139e135.tar.gz |
Minor changes after code review; replaced static arrays for handles by a tree
Diffstat (limited to 'include')
-rw-r--r-- | include/persistence_client_custom.h | 94 |
1 files changed, 0 insertions, 94 deletions
diff --git a/include/persistence_client_custom.h b/include/persistence_client_custom.h index b0f9cfe..d0cd0e0 100644 --- a/include/persistence_client_custom.h +++ b/include/persistence_client_custom.h @@ -19,7 +19,6 @@ * Library provides an plugin API to extend persistence client library * @par change history * Date Author Version Description - * - 2015.01.16 ihuerner 1.7.0.0 Added function prototypes for function loaded from persistence common object * - 2015.01.14 ihuerner 1.6.0.0 Extended header documentation for function plugin_init_async. * - 2014.01.20 iieremie 1.6.0.0 multiple extensions: * - error codes @@ -99,99 +98,6 @@ The lower significant byte is equal 0 for released version only * \{ */ - - -/** - * \brief Obtain a handler to DB indicated by dbPathname - * \note : DB is created if it does not exist and (bForceCreationIfNotPresent != 0) - * - * \param dbPathname [in] absolute path to database (length limited to \ref PERS_ORG_MAX_LENGTH_PATH_FILENAME) - * \param bForceCreationIfNotPresent [in] if !=0x0, the database is created if it does not exist - * - * \return >= 0 for valid handler, negative value for error (\ref PERS_COM_ERROR_CODES_DEFINES) - */ -signed int persComDbOpen(char const * dbPathname, unsigned char bForceCreationIfNotPresent) ; - -/** - * \brief Close handler to DB - * - * \param handlerDB [in] handler obtained with persComDbOpen - * - * \return 0 for success, negative value for error (\ref PERS_COM_ERROR_CODES_DEFINES) - */ -signed int persComDbClose(signed int handlerDB) ; - -/** - * \brief write a key-value pair into local/shared database - * - * \param handlerDB [in] handler obtained with persComDbOpen - * \param key [in] key's name (length limited to \ref PERS_DB_MAX_LENGTH_KEY_NAME) - * \param data [in] buffer with key's data - * \param dataSize [in] size of key's data (max allowed \ref PERS_DB_MAX_SIZE_KEY_DATA) - * - * \return 0 for success, negative value otherwise (\ref PERS_COM_ERROR_CODES_DEFINES) - */ -signed int persComDbWriteKey(signed int handlerDB, char const * key, char const * data, signed int dataSize) ; - - -/** - * \brief read a key's value from local/shared database - * - * \param handlerDB [in] handler obtained with persComDbOpen - * \param key [in] key's name (length limited to \ref PERS_DB_MAX_LENGTH_KEY_NAME) - * \param dataBuffer_out [out]buffer where to return the read data - * \param dataBufferSize [in] size of dataBuffer_out - * - * \return read size, or negative value in case of error (\ref PERS_COM_ERROR_CODES_DEFINES) - */ -signed int persComDbReadKey(signed int handlerDB, char const * key, char* dataBuffer_out, signed int dataBufferSize) ; - -/** - * \brief read a key's value from local/shared database - * - * \param handlerDB [in] handler obtained with persComDbOpen - * \param key [in] key's name (length limited to \ref PERS_DB_MAX_LENGTH_KEY_NAME) - * - * \return key's size, or negative value in case of error (\ref PERS_COM_ERROR_CODES_DEFINES) - */ -signed int persComDbGetKeySize(signed int handlerDB, char const * key) ; - -/** - * \brief delete key from local/shared database - * - * \param handlerDB [in] handler obtained with persComDbOpen - * \param key [in] key's name (length limited to \ref PERS_DB_MAX_LENGTH_KEY_NAME) - * - * \return 0 for success, negative value otherwise (\ref PERS_COM_ERROR_CODES_DEFINES) - */ -signed int persComDbDeleteKey(signed int handlerDB, char const * key) ; - - -/** - * \brief Find the buffer's size needed to accomodate the list of keys' names in local/shared database - * - * \param handlerDB [in] handler obtained with persComDbOpen - * - * \return needed size, or negative value in case of error (\ref PERS_COM_ERROR_CODES_DEFINES) - */ -signed int persComDbGetSizeKeysList(signed int handlerDB) ; - - -/** - * \brief Obtain the list of the keys' names in local/shared database - * \note : keys in the list are separated by '\0' - * - * \param handlerDB [in] handler obtained with persComDbOpen - * \param listBuffer_out [out]buffer where to return the list of keys - * \param listBufferSize [in] size of listingBuffer_out - * \return >=0 for size of the list, or negative value in case of error (\ref PERS_COM_ERROR_CODES_DEFINES) - */ -signed int persComDbGetKeysList(signed int handlerDB, char* listBuffer_out, signed int listBufferSize) ; - - - - - /** * @brief typdef of callback function prototype for asynchronous init/deinit * |