XrdApps::JCache make dir listing an asynchronous function with a handler

Author: apeters1971

src/XrdApps.cmake

@@ -230,6 +230,7 @@ add_library(
   XrdApps/XrdClJCachePlugin/system/XrdClJCacheSystem.cc
   XrdApps/XrdClJCachePlugin/vector/XrdClVectorCache.cc
   XrdApps/XrdClJCachePlugin/vector/XrdClVectorCache.hh
+  XrdApps/XrdClJCachePlugin/handler/XrdClJCacheDirListHandler.cc
   XrdApps/XrdClJCachePlugin/handler/XrdClJCacheOpenHandler.cc
   XrdApps/XrdClJCachePlugin/handler/XrdClJCacheOpenHandler.hh
   XrdApps/XrdClJCachePlugin/handler/XrdClJCacheReadHandler.hh

src/XrdApps/XrdClJCachePlugin/handler/XrdClJCacheDirListHandler.cc

@@ -0,0 +1,53 @@
+//------------------------------------------------------------------------------
+// Copyright (c) 2024 by European Organization for Nuclear Research (CERN)
+// Author: Andreas-Joachim Peters <[email protected]>
+//------------------------------------------------------------------------------
+// This file is part of the XRootD software suite.
+//
+// XRootD is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Lesser General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// XRootD is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
+//
+// In applying this licence, CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+/*----------------------------------------------------------------------------*/
+
+/*----------------------------------------------------------------------------*/
+#include "handler/XrdClJCacheDirListHandler.hh"
+#include "file/XrdClJCacheFile.hh"
+#include "system/XrdClJCacheSystem.hh"
+#include <iostream>
+/*----------------------------------------------------------------------------*/
+
+namespace XrdCl {
+// ---------------------------------------------------------------------- //
+void JCacheDirListHandler::HandleResponse(XrdCl::XRootDStatus *pStatus, XrdCl::AnyObject *pResponse) {
+  std::cerr << "Handling DirList Response ..." << mPath << std::endl;
+  if (pStatus->IsOK()) {
+    if (pResponse) {
+      // save the listing
+      std::cerr << "Saving DirList: " << mPath << std::endl;
+      XrdCl::DirectoryList* lList;
+      pResponse->Get(lList);
+      pSystem->SaveDirList(mPath, lList);
+    } else {
+      std::cerr << "Failed Listing: " << mPath << std::endl;
+    }
+  } else {
+    std::cerr << "Failed Listing: " << mPath << std::endl;
+  }
+  mHandler->HandleResponse(pStatus, pResponse);
+}
+
+} // namespace XrdCl

src/XrdApps/XrdClJCachePlugin/handler/XrdClJCacheDirListHandler.hh

@@ -0,0 +1,56 @@
+//------------------------------------------------------------------------------
+// Copyright (c) 2024 by European Organization for Nuclear Research (CERN)
+// Author: Andreas-Joachim Peters <[email protected]>
+//------------------------------------------------------------------------------
+// This file is part of the XRootD software suite.
+//
+// XRootD is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Lesser General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// XRootD is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
+//
+// In applying this licence, CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+#pragma once
+/*----------------------------------------------------------------------------*/
+#include "XrdCl/XrdClFile.hh"
+#include "XrdCl/XrdClXRootDResponses.hh"
+/*----------------------------------------------------------------------------*/
+
+/*----------------------------------------------------------------------------*/
+
+namespace XrdCl {
+
+class JCacheSystem;
+
+class JCacheDirListHandler : public XrdCl::ResponseHandler
+// ---------------------------------------------------------------------- //
+{
+public:
+  JCacheDirListHandler() {}
+  JCacheDirListHandler(XrdCl::ResponseHandler *handler, JCacheSystem *system,
+                       const std::string &path)
+      : mHandler(handler), pSystem(system), mPath(path) {}
+
+  virtual ~JCacheDirListHandler() {}
+
+  void HandleResponse(XrdCl::XRootDStatus *pStatus,
+                      XrdCl::AnyObject *pResponse);
+
+private:
+  XrdCl::ResponseHandler *mHandler;
+  JCacheSystem *pSystem;
+  std::string mPath;
+};
+
+} // namespace XrdCl

src/XrdApps/XrdClJCachePlugin/system/XrdClJCacheSystem.cc

@@ -24,6 +24,7 @@
 #include "system/XrdClJCacheSystem.hh"
 #include "file/Hierarchy.hh"
 #include "file/XrdClJCacheFile.hh"
+#include "handler/XrdClJCacheDirListHandler.hh"
 
 #include <sys/stat.h>
 #include <sys/types.h>
@@ -80,26 +81,15 @@ XRootDStatus JCacheSystem::DirList(const std::string &path,
   }
   // get the listing
 
-  XrdCl::DirectoryList *response = nullptr;
-  AnyObject *obj = new AnyObject();
+  auto lhandler = new JCacheDirListHandler(handler, this, ListingPath);
 
-  SyncResponseHandler lhandler;
-  XRootDStatus st = pSystem->DirList(path, flags, &lhandler, timeout);
+  std::cerr << "Creating handler for path: " << path << std::endl;
+  XRootDStatus st = pSystem->DirList(path, flags, lhandler, timeout);
+  std::cerr << "Command sumbitted" << std::endl;
   if (!st.IsOK()) {
     std::cerr << "error: unable to get listing: " << path << std::endl;
-    return st;
   }
 
-  st = MessageUtils::WaitForResponse(&lhandler, response);
-  if (!st.IsOK())
-    return st;
-
-  // save the listing
-  SaveDirList(ListingPath, response);
-
-  obj->Set(response);
-  XRootDStatus *ret_st = new XRootDStatus(XRootDStatus(stOK, 0));
-  handler->HandleResponse(ret_st, obj);
   return st;
 }
 

src/XrdApps/XrdClJCachePlugin/system/XrdClJCacheSystem.hh

@@ -223,15 +223,20 @@ public:
     return pSystem->GetProperty(name, value);
   }
 
+  XrdCl::FileSystem *System() { return pSystem; }
+
+  bool SaveDirList(const std::string &path, DirectoryList *dirList);
+
 private:
   XrdCl::FileSystem *pSystem;
   std::string mUrl;
 
-  DirectoryList* LoadDirList(const std::string& path);
-  bool SaveDirList(const std::string& path, DirectoryList* dirList);
+  DirectoryList *LoadDirList(const std::string &path);
 
-  std::string Serialize(const std::string& hostaddress, const std::string& name, XrdCl::StatInfo* stat);
-  std::tuple<std::string, std::string, XrdCl::StatInfo*> Deserialize(const std::string& data);
+  std::string Serialize(const std::string &hostaddress, const std::string &name,
+                        XrdCl::StatInfo *stat);
+  std::tuple<std::string, std::string, XrdCl::StatInfo *>
+  Deserialize(const std::string &data);
 };
 
-}
+} // namespace XrdCl