XrdCl::ResponseHandler Class Reference

Handle an async response. More...

#include <XrdClXRootDResponses.hh>

Inheritance diagram for XrdCl::ResponseHandler:

Collaboration diagram for XrdCl::ResponseHandler:

Public Member Functions
virtual	~ResponseHandler ()
virtual void	HandleResponse (XRootDStatus *status, AnyObject *response)
virtual void	HandleResponseWithHosts (XRootDStatus *status, AnyObject *response, HostList *hostList)

Static Public Member Functions
static ResponseHandler *	Wrap (std::function< void(XRootDStatus &, AnyObject &)> func)
static ResponseHandler *	Wrap (std::function< void(XRootDStatus *, AnyObject *)> func)

Detailed Description

Handle an async response.

Definition at line 1126 of file XrdClXRootDResponses.hh.

Constructor & Destructor Documentation

~ResponseHandler()

virtual XrdCl::ResponseHandler::~ResponseHandler ( )

inlinevirtual

Definition at line 1129 of file XrdClXRootDResponses.hh.

{}

Member Function Documentation

HandleResponse()

virtual void XrdCl::ResponseHandler::HandleResponse ( XRootDStatus *  status, AnyObject *  response  )

inlinevirtual

Called when a response to associated request arrives or an error occurs

Parameters

status	status of the request
response	an object associated with the response (request dependent)

Reimplemented in XrdCl::ChunkHandler, XrdCl::PipelineHandler, XrdCl::FutureWrapper< void >, XrdCl::FutureWrapper< Response >, XrdCl::TaskWrapper< void, Return >, XrdCl::TaskWrapper< Response, Return >, XrdCl::UnpackXAttr, XrdCl::UnpackXAttrStatus, XrdCl::MetalinkReadHandler, XrdCl::SyncResponseHandler, XrdCl::EcPgReadResponseHandler, XrdCl::ZipListHandler, XrdPosixFile, XrdSsiEvent, XrdPosixFileRH, and XrdCl::PgReadSubstitutionHandler.

Definition at line 1156 of file XrdClXRootDResponses.hh.

      {
        (void)status; (void)response;
      }

Referenced by XrdCl::EcHandler::Close(), XrdCl::HttpFilePlugIn::Close(), XrdCl::ZipArchive::CloseArchive(), XrdCl::HttpFileSystemPlugIn::DirList(), XrdCl::PgReadSubstitutionHandler::HandleResponse(), XrdCl::ZipListHandler::HandleResponse(), XrdCl::EcPgReadResponseHandler::HandleResponse(), XrdCl::MetalinkReadHandler::HandleResponse(), XrdCl::UnpackXAttrStatus::HandleResponse(), XrdCl::UnpackXAttr::HandleResponse(), HandleResponseWithHosts(), XrdCl::HttpFileSystemPlugIn::MkDir(), XrdCl::HttpFileSystemPlugIn::Mv(), XrdCl::HttpFilePlugIn::Open(), XrdEc::Reader::Open(), XrdCl::ZipArchive::OpenArchive(), XrdCl::FileStateHandler::PgWrite(), XrdCl::HttpFilePlugIn::Read(), XrdCl::HttpFileSystemPlugIn::Rm(), XrdCl::HttpFileSystemPlugIn::RmDir(), XrdEc::ResponseJob::Run(), XrdCl::HttpFilePlugIn::Stat(), XrdCl::HttpFileSystemPlugIn::Stat(), XrdCl::HttpFilePlugIn::VectorRead(), XrdEc::Reader::VectorRead(), Wrap(), and XrdCl::HttpFilePlugIn::Write().

Here is the caller graph for this function:

HandleResponseWithHosts()

virtual void XrdCl::ResponseHandler::HandleResponseWithHosts ( XRootDStatus *  status, AnyObject *  response, HostList *  hostList  )

inlinevirtual

Called when a response to associated request arrives or an error occurs

Parameters

status	status of the request
response	an object associated with the response (request dependent)
hostList	list of hosts the request was redirected to

Reimplemented in XrdCl::PipelineHandler, XrdCl::RawWrapper, XrdCl::ExOpenFuncWrapper, XrdCl::FunctionWrapper< void >, XrdCl::FunctionWrapper< Response >, XrdCl::MetalinkOpenHandler, XrdCl::AssignLastURLHandler, XrdCl::AssignLBHandler, and XrdCl::NullResponseHandler.

Definition at line 1140 of file XrdClXRootDResponses.hh.

      {
        delete hostList;
        HandleResponse( status, response );
      }

References HandleResponse().

Referenced by XrdCl::AssignLBHandler::HandleResponseWithHosts(), XrdCl::AssignLastURLHandler::HandleResponseWithHosts(), XrdCl::MetalinkOpenHandler::HandleResponseWithHosts(), XrdCl::RawWrapper::HandleResponseWithHosts(), XrdCl::LocalFileTask::Run(), XrdCl::ResponseJob::Run(), and XrdCl::FileStateHandler::Stat().

Here is the call graph for this function:

Here is the caller graph for this function:

Wrap() [1/2]

ResponseHandler * XrdCl::ResponseHandler::Wrap ( std::function< void(XRootDStatus &, AnyObject &)>  func )

static

Factory function for generating handler objects from lambdas

Parameters

func	: the callback, must not throw

Returns

: ResponseHandler wrapper with the user callback

Definition at line 760 of file XrdClXRootDResponses.cc.

  {
    struct FuncHandler : public ResponseHandler
    {
      FuncHandler( std::function<void(XRootDStatus&, AnyObject&)> func ) : func( std::move( func ) )
      {
      }
 
      void HandleResponse( XRootDStatus *status, AnyObject *response )
      {
        // make sure the arguments will be released
        std::unique_ptr<XRootDStatus> stptr( status );
        std::unique_ptr<AnyObject> rspptr( response );
        // if there is no response provide a null reference placeholder
        static AnyObject nullref;
        if( response == nullptr )
          response = &nullref;
        // call the user completion handler
        func( *status, *response );
        // check if this is a final respons
        bool finalrsp = !( status->IsOK() && status->code == suContinue );
        // deallocate the wrapper if final
        if( finalrsp )
          delete this;
      }
 
      std::function<void(XRootDStatus&, AnyObject&)> func;
    };
 
    return new FuncHandler( func );
  }

References XrdCl::Status::code, HandleResponse(), XrdCl::Status::IsOK(), and XrdCl::suContinue.

Referenced by XrdCl::EcHandler::Close(), and XrdCl::FileStateHandler::PgWrite().

Here is the call graph for this function:

Here is the caller graph for this function:

Wrap() [2/2]

ResponseHandler * XrdCl::ResponseHandler::Wrap ( std::function< void(XRootDStatus *, AnyObject *)>  func )

static

Factory function for generating handler objects from lambdas

Parameters

func	: the callback, must not throw

Returns

: ResponseHandler wrapper with the user callback

Definition at line 792 of file XrdClXRootDResponses.cc.

  {
    struct FuncHandler : public ResponseHandler
    {
      FuncHandler( std::function<void(XRootDStatus*, AnyObject*)> func ) : func( std::move( func ) )
      {
      }
 
      void HandleResponse( XRootDStatus *status, AnyObject *response )
      {
        // check if this is a final respons
        bool finalrsp = !( status->IsOK() && status->code == suContinue );
        // call the user completion handler
        func( status, response );
        // deallocate the wrapper if final
        if( finalrsp )
          delete this;
      }
 
      std::function<void(XRootDStatus*, AnyObject*)> func;
    };
 
    return new FuncHandler( func );
  }

References XrdCl::Status::code, HandleResponse(), XrdCl::Status::IsOK(), and XrdCl::suContinue.

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• XrdClXRootDResponses.hh
• XrdClXRootDResponses.cc