[irods#7979] Deprecate dataObjLock and dataObjUnlock

korydraughn · Dec 17, 2024 · 5e6e775 · 5e6e775
1 parent 0ea2698
commit 5e6e775
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 0 deletions.
diff --git a/lib/api/include/irods/apiNumberData.h b/lib/api/include/irods/apiNumberData.h
@@ -99,6 +99,7 @@ API_NUMBER(OPEN_COLLECTION_AN,                      678)
 API_NUMBER(RM_COLL_AN,                              679)
 API_NUMBER(MOD_COLL_AN,                             680)
 API_NUMBER(COLL_CREATE_AN,                          681)
+// DEPRECATED: rcDataObjUnlock is deprecated. Logical locking now manages access to data objects.
 API_NUMBER(DATA_OBJ_UNLOCK_AN,                      682)
 API_NUMBER(REG_COLL_AN,                             683)
 API_NUMBER(PHY_BUNDLE_COLL_AN,                      684)
@@ -116,6 +117,7 @@ API_NUMBER(DATA_OBJ_REPL_AN,                        695)
 API_NUMBER(DATA_OBJ_COPY_AN,                        696)
 API_NUMBER(DATA_OBJ_PHYMV_AN,                       697)
 API_NUMBER(DATA_OBJ_FSYNC_AN,                       698)
+// DEPRECATED: rcDataObjLock is deprecated. Logical locking now manages access to data objects.
 API_NUMBER(DATA_OBJ_LOCK_AN,                        699) // JMC - backport 4599
 
 /* 700 - 799 - Metadata API calls */

diff --git a/lib/api/include/irods/apiTable.hpp b/lib/api/include/irods/apiTable.hpp
@@ -872,6 +872,8 @@ static irods::apidef_t client_api_table_inp[] = {
         "api_get_host_for_get", clearDataObjInp, irods::clearOutStruct_noop,
         (funcPtr)CALL_DATAOBJINP_CHAROUT
     },
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
     {
         DATA_OBJ_LOCK_AN, RODS_API_VERSION, REMOTE_USER_AUTH, REMOTE_PRIV_USER_AUTH,
         "DataObjInp_PI", 0, NULL, 0,
@@ -886,6 +888,7 @@ static irods::apidef_t client_api_table_inp[] = {
         "api_data_obj_unlock", clearDataObjInp, irods::clearOutStruct_noop,
         (funcPtr)CALL_DATAOBJINP
     },
+#pragma GCC diagnostic pop
     {
         SUB_STRUCT_FILE_CREATE_AN, RODS_API_VERSION, REMOTE_USER_AUTH, REMOTE_PRIV_USER_AUTH,
         "SubFile_PI", 0, NULL, 0,

diff --git a/lib/api/include/irods/dataObjLock.h b/lib/api/include/irods/dataObjLock.h
@@ -29,10 +29,12 @@
 #ifdef __cplusplus
 extern "C"
 #endif
+__attribute__((deprecated("Logical locking now manages access to data objects.")))
 int rcDataObjLock( rcComm_t *conn, dataObjInp_t *dataObjInp );
 #ifdef __cplusplus
 extern "C"
 #endif
+__attribute__((deprecated("Logical locking now manages access to data objects.")))
 int rcDataObjUnlock( rcComm_t *conn, dataObjInp_t *dataObjInp );
 
 

diff --git a/lib/api/src/rcDataObjLock.cpp b/lib/api/src/rcDataObjLock.cpp
@@ -57,6 +57,8 @@
  * \pre none
  * \post none
  * \sa none
+ *
+ * \deprecated Deprecated in 4.3.4. Logical locking now manages access to data objects.
 **/
 
 int

diff --git a/server/api/include/irods/rsDataObjLock.hpp b/server/api/include/irods/rsDataObjLock.hpp
@@ -5,7 +5,9 @@
 #include "irods/objInfo.h"
 #include "irods/dataObjInpOut.h"
 
+[[deprecated("Logical locking now manages access to data objects.")]]
 int rsDataObjLock( rsComm_t *rsComm, dataObjInp_t *dataObjInp );
+[[deprecated("Logical locking now manages access to data objects.")]]
 int rsDataObjUnlock( rsComm_t *rsComm, dataObjInp_t *dataObjInp );
 
 #endif