summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorIngo Huerner <ingo.huerner@xse.de>2014-06-05 12:14:14 +0200
committerIngo Huerner <ingo.huerner@xse.de>2014-06-05 12:14:14 +0200
commitec8527409755f1039bd30f821e718320e6a52bc3 (patch)
tree9ea5df11495b771cb41d51da21a953d7ff4d3cdd /include
parentb076c0dadcce0f01e9e0470c6475c88749f3d878 (diff)
downloadpersistence-client-library-ec8527409755f1039bd30f821e718320e6a52bc3.tar.gz
Updated missing header doc; prevent overwriting of notification callback; provide only resource id in notification callback; corrected dlt conmtext variable; removed sync, will now be called by PAS
Diffstat (limited to 'include')
-rw-r--r--include/persistence_client_library.h2
-rw-r--r--include/persistence_client_library_key.h8
2 files changed, 9 insertions, 1 deletions
diff --git a/include/persistence_client_library.h b/include/persistence_client_library.h
index c0735ff..1bd005a 100644
--- a/include/persistence_client_library.h
+++ b/include/persistence_client_library.h
@@ -128,7 +128,7 @@ int pclDeinitLibrary(void);
*
* @return positive value: success;
* On error a negative value will be returned with the following error codes:
- * ::EPERS_COMMON, :.EPERS_MAX_CANCEL_SHUTDOWN, ::EPERS_SHTDWN_NO_PERMIT
+ * ::EPERS_COMMON, ::EPERS_MAX_CANCEL_SHUTDOWN, ::EPERS_SHTDWN_NO_PERMIT
*/
int pclLifecycleSet(int shutdown);
diff --git a/include/persistence_client_library_key.h b/include/persistence_client_library_key.h
index 4111fe3..e0a8889 100644
--- a/include/persistence_client_library_key.h
+++ b/include/persistence_client_library_key.h
@@ -182,6 +182,10 @@ int pclKeyHandleReadData(int key_handle, unsigned char* buffer, int buffer_size)
/**
* @brief register 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 ::pclKeyHandleUnRegisterNotifyOnChange
+ * and then register a callback again.
+ *
* @param key_handle key value handle return by key_handle_open()
* @param callback notification callback
*
@@ -245,6 +249,10 @@ int pclKeyReadData(unsigned int ldbid, const char* resource_id, unsigned int use
/**
* @brief register 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
+ * and then register a callback again.
+ *
* @param ldbid logical database ID of the resource to monitor
* @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