diff options
author | Ingo Huerner <ingo.huerner@xse.de> | 2015-01-27 16:18:37 +0100 |
---|---|---|
committer | Ingo Huerner <ingo.huerner@xse.de> | 2015-01-27 16:18:37 +0100 |
commit | d6a46c9081969523256423f69c81e6d398238817 (patch) | |
tree | f3487d8510bdd40c1aa5d8232a0ef1cb036ba7ed /include | |
parent | 66e2d647c5df4fda121f460f6b086a7bc57cbec4 (diff) | |
download | persistence-client-library-d6a46c9081969523256423f69c81e6d398238817.tar.gz |
Changed DLT log level (info to debug)
Diffstat (limited to 'include')
-rw-r--r-- | include/persistence_client_library_file.h | 13 | ||||
-rw-r--r-- | include/persistence_client_library_key.h | 5 |
2 files changed, 12 insertions, 6 deletions
diff --git a/include/persistence_client_library_file.h b/include/persistence_client_library_file.h index e116dd6..76a0b95 100644 --- a/include/persistence_client_library_file.h +++ b/include/persistence_client_library_file.h @@ -196,10 +196,15 @@ int pclFileWriteData(int fd, const void * buffer, int buffer_size); * * @note the allocated memory for the path string will be freed in pclFileReleasePath * - * @return positive value (0 or greater) on success, which must be used when pclFileReleasePath will be called - * On error a negative value will be returned with th following error codes: - * ::EPERS_LOCKFS or ::EPERS_COMMON - * If ::EPERS_COMMON will be returned errno will be set. + * @return positive value (0 or greater) on success a path to a file corresponding to the storage resource addressed + * by the given ldbid/resource_id/user_no/seat_no. + * This function can be used to a legacy program or other program that needs direct file storage (e.g. sqlite) + * while still giving that program the benefit from the persistence layer and cause the program to use the + * storage settings that have been configured for the given resource_id. + * This way of access should only be used as a last resort if using the given key-value or file API is not feasible. + * On error a negative value will be returned with th following error codes: + * ::EPERS_LOCKFS or ::EPERS_COMMON + * If ::EPERS_COMMON will be returned errno will be set. */ int pclFileCreatePath(unsigned int ldbid, const char* resource_id, unsigned int user_no, unsigned int seat_no, char** path, unsigned int* size); diff --git a/include/persistence_client_library_key.h b/include/persistence_client_library_key.h index 04f5a68..37de33e 100644 --- a/include/persistence_client_library_key.h +++ b/include/persistence_client_library_key.h @@ -247,7 +247,7 @@ int pclKeyReadData(unsigned int ldbid, const char* resource_id, unsigned int use /** - * @brief register a change notification for persistent data + * @brief register for a change notification for persistent data * * @warning It is only possible to register one callback at the time, not multiple ones. * If you need to change the callback, call ::pclKeyUnRegisterNotifyOnChange @@ -257,7 +257,8 @@ int pclKeyReadData(unsigned int ldbid, const char* resource_id, unsigned int use * @param resource_id the resource ID * @param user_no the user ID; user_no=0 can not be used as user-ID because ‘0’ is defined as System/node * @param seat_no the seat number - * @param callback notification callback + * @param callback notification callback: after the content of the given resource_id has been changed, + * the passed function callback will be called. * * @return positive value (0 or greater): registration OK; * On error a negative value will be returned with the following error codes: |