XrdAdaptor::ClientRequest Class Reference

#include <XrdRequest.h>

Inheritance diagram for XrdAdaptor::ClientRequest:

Public Member Functions
	ClientRequest (const ClientRequest &)=delete
	ClientRequest (RequestManager &manager, std::shared_ptr< std::vector< IOPosBuffer >> iolist, IOSize size=0)
	ClientRequest (RequestManager &manager, void *into, IOSize size, IOOffset off)
std::future< IOSize >	get_future ()
size_t	getCount () const
std::shared_ptr< Source > &	getCurrentSource ()
std::shared_ptr< Source const >	getCurrentSource () const
IOSize	getSize () const
void	HandleResponse (XrdCl::XRootDStatus *status, XrdCl::AnyObject *response) override
ClientRequest &	operator= (const ClientRequest &)=delete
void	setStatistics (std::shared_ptr< XrdReadStatistics > stats)
	~ClientRequest () override

Private Member Functions
std::shared_ptr< ClientRequest > &	self_reference ()
std::shared_ptr< ClientRequest const >	self_reference () const

Private Attributes
unsigned	m_failure_count
void *	m_into
edm::propagate_const< std::shared_ptr< std::vector< IOPosBuffer > > >	m_iolist
RequestManager &	m_manager
IOOffset	m_off
std::promise< IOSize >	m_promise
QualityMetricWatch	m_qmw
edm::propagate_const< std::shared_ptr< ClientRequest > >	m_self_reference
IOSize	m_size
edm::propagate_const< std::shared_ptr< Source > >	m_source
edm::propagate_const< std::shared_ptr< XrdReadStatistics > >	m_stats

Friends
class	Source

Detailed Description

Definition at line 22 of file XrdRequest.h.

Constructor & Destructor Documentation

ClientRequest() [1/3]

XrdAdaptor::ClientRequest::ClientRequest ( const ClientRequest &  )

delete

ClientRequest() [2/3]

XrdAdaptor::ClientRequest::ClientRequest ( RequestManager &  manager, void *  into, IOSize  size, IOOffset  off  )

inline

Definition at line 29 of file XrdRequest.h.

        : m_failure_count(0), m_into(into), m_size(size), m_off(off), m_iolist(nullptr), m_manager(manager) {}

ClientRequest() [3/3]

XrdAdaptor::ClientRequest::ClientRequest ( RequestManager &  manager, std::shared_ptr< std::vector< IOPosBuffer >>  iolist, IOSize  size = 0  )

inline

Definition at line 32 of file XrdRequest.h.

        : m_failure_count(0), m_into(nullptr), m_size(size), m_off(0), m_iolist(iolist), m_manager(manager) {
      if (!m_iolist->empty() && !m_size) {
        for (IOPosBuffer const &buf : *m_iolist) {
          m_size += buf.size();
        }
      }
    }

References visDQMUpload::buf, m_iolist, and m_size.

~ClientRequest()

XrdAdaptor::ClientRequest::~ClientRequest ( )

override

Definition at line 21 of file XrdRequest.cc.

{}

Member Function Documentation

get_future()

std::future<IOSize> XrdAdaptor::ClientRequest::get_future ( )

inline

Definition at line 45 of file XrdRequest.h.

{ return m_promise.get_future(); }

References m_promise.

getCount()

size_t XrdAdaptor::ClientRequest::getCount ( void  ) const

inline

Definition at line 54 of file XrdRequest.h.

{ return m_into ? 1 : m_iolist->size(); }

References m_into, and m_iolist.

getCurrentSource() [1/2]

std::shared_ptr<Source>& XrdAdaptor::ClientRequest::getCurrentSource ( )

inline

Definition at line 61 of file XrdRequest.h.

{ return get_underlying_safe(m_source); }

References edm::get_underlying_safe(), and m_source.

getCurrentSource() [2/2]

std::shared_ptr<Source const> XrdAdaptor::ClientRequest::getCurrentSource ( ) const

inline

Returns a pointer to the current source; may be nullptr if there is no outstanding IO

Definition at line 60 of file XrdRequest.h.

{ return get_underlying_safe(m_source); }

References edm::get_underlying_safe(), and m_source.

getSize()

IOSize XrdAdaptor::ClientRequest::getSize ( ) const

inline

Definition at line 52 of file XrdRequest.h.

{ return m_size; }

References m_size.

HandleResponse()

void XrdAdaptor::ClientRequest::HandleResponse ( XrdCl::XRootDStatus *  status, XrdCl::AnyObject *  response  )

override

Handle the response from the Xrootd server.

Definition at line 23 of file XrdRequest.cc.

                                                                                          {
  std::unique_ptr<XrdCl::AnyObject> response(resp);
  std::unique_ptr<XrdCl::XRootDStatus> status(stat);
  std::shared_ptr<ClientRequest> self_ref = self_reference();
  m_self_reference = nullptr;  // propagate_const<T> has no reset() function
  {
    QualityMetricWatch qmw;
    m_qmw.swap(qmw);
  }
  m_stats = nullptr;  // propagate_const<T> has no reset() function
 
  if ((!FAKE_ERROR_COUNTER || ((++g_fakeError % FAKE_ERROR_COUNTER) != 0)) && (status->IsOK() && resp)) {
    if (m_into) {
      XrdCl::ChunkInfo *read_info;
      response->Get(read_info);
      if (read_info == nullptr) {
        edm::Exception ex(edm::errors::FileReadError);
        ex << "nullptr returned from response->Get().";
        ex.addContext("XrdAdaptor::ClientRequest::HandleResponse() called.");
        m_promise.set_exception(std::make_exception_ptr(ex));
        return;
      }
      if (read_info->length == 0) {
        edm::LogWarning("XrdAdaptorInternal")
            << "XrdAdaptor::ClientRequest::HandleResponse: While reading from\n " << m_manager.getFilename()
            << "\n  received a read_info->length = 0 and read_info->offset = " << read_info->offset;
      }
      m_promise.set_value(read_info->length);
    } else {
      XrdCl::VectorReadInfo *read_info;
      response->Get(read_info);
      if (read_info == nullptr) {
        edm::Exception ex(edm::errors::FileReadError);
        ex << "nullptr returned from response->Get() from vector read.";
        ex.addContext("XrdAdaptor::ClientRequest::HandleResponse() called.");
        m_promise.set_exception(std::make_exception_ptr(ex));
        return;
      }
      if (read_info->GetSize() == 0) {
        edm::LogWarning("XrdAdaptorInternal") << "XrdAdaptor::ClientRequest::HandleResponse: While reading from\n "
                                              << m_manager.getFilename() << "\n  received a read_info->GetSize() = 0";
      }
 
      m_promise.set_value(read_info->GetSize());
    }
  } else {
    Source *source = m_source.get();
    edm::LogWarning("XrdAdaptorInternal")
        << "XrdRequestManager::handle(name='" << m_manager.getFilename() << ") failure when reading from "
        << (source ? source->PrettyID() : "(unknown source)") << "; failed with error '" << status->ToStr()
        << "' (errno=" << status->errNo << ", code=" << status->code << ").";
    m_failure_count++;
    try {
      try {
        m_manager.requestFailure(self_ref, *status);
        return;
      } catch (XrootdException &ex) {
        if (ex.getCode() == XrdCl::errInvalidResponse) {
          m_promise.set_exception(std::current_exception());
        } else
          throw;
      }
    } catch (edm::Exception &ex) {
      ex.addContext("XrdAdaptor::ClientRequest::HandleResponse() failure while running connection recovery");
      std::stringstream ss;
      ss << "Original error: '" << status->ToStr() << "' (errno=" << status->errNo << ", code=" << status->code
         << ", source=" << (source ? source->PrettyID() : "(unknown source)") << ").";
      ex.addAdditionalInfo(ss.str());
      m_promise.set_exception(std::current_exception());
      edm::LogWarning("XrdAdaptorInternal") << "Caught a CMSSW exception when running connection recovery.";
    } catch (std::exception const &) {
      edm::Exception ex(edm::errors::FileReadError);
      ex << "XrdRequestManager::handle(name='" << m_manager.getFilename() << ") failed with error '" << status->ToStr()
         << "' (errno=" << status->errNo << ", code=" << status->code << ").  Unknown exception occurred when running"
         << " connection recovery.";
      ex.addContext("Calling XrdRequestManager::handle()");
      m_manager.addConnections(ex);
      ex.addAdditionalInfo("Original source of error is " + (source ? source->PrettyID() : "(unknown source)"));
      m_promise.set_exception(std::make_exception_ptr(ex));
      edm::LogWarning("XrdAdaptorInternal") << "Caught a new exception when running connection recovery.";
    }
  }
}

References cms::Exception::addAdditionalInfo(), cms::Exception::addContext(), cppFunctionSkipper::exception, FAKE_ERROR_COUNTER, edm::errors::FileReadError, g_fakeError, XrdAdaptor::XrootdException::getCode(), source, contentValuesCheck::ss, edm_modernize_messagelogger::stat, mps_update::status, and XrdAdaptor::QualityMetricWatch::swap().

operator=()

ClientRequest& XrdAdaptor::ClientRequest::operator= ( const ClientRequest &  )

delete

self_reference() [1/2]

std::shared_ptr<ClientRequest>& XrdAdaptor::ClientRequest::self_reference ( )

inlineprivate

Definition at line 65 of file XrdRequest.h.

{ return get_underlying_safe(m_self_reference); }

References edm::get_underlying_safe(), and m_self_reference.

self_reference() [2/2]

std::shared_ptr<ClientRequest const> XrdAdaptor::ClientRequest::self_reference ( ) const

inlineprivate

Definition at line 64 of file XrdRequest.h.

{ return get_underlying_safe(m_self_reference); }

References edm::get_underlying_safe(), and m_self_reference.

setStatistics()

void XrdAdaptor::ClientRequest::setStatistics ( std::shared_ptr< XrdReadStatistics >  stats )

inline

Definition at line 41 of file XrdRequest.h.

{ m_stats = stats; }

References m_stats, and dqmMemoryStats::stats.

Friends And Related Function Documentation

Source

friend class Source

friend

Definition at line 23 of file XrdRequest.h.

Member Data Documentation

m_failure_count

unsigned XrdAdaptor::ClientRequest::m_failure_count

private

Definition at line 67 of file XrdRequest.h.

m_into

void* XrdAdaptor::ClientRequest::m_into

private

Definition at line 68 of file XrdRequest.h.

Referenced by getCount().

m_iolist

edm::propagate_const<std::shared_ptr<std::vector<IOPosBuffer> > > XrdAdaptor::ClientRequest::m_iolist

private

Definition at line 71 of file XrdRequest.h.

Referenced by ClientRequest(), and getCount().

m_manager

RequestManager& XrdAdaptor::ClientRequest::m_manager

private

Definition at line 72 of file XrdRequest.h.

m_off

IOOffset XrdAdaptor::ClientRequest::m_off

private

Definition at line 70 of file XrdRequest.h.

m_promise

std::promise<IOSize> XrdAdaptor::ClientRequest::m_promise

private

Definition at line 83 of file XrdRequest.h.

Referenced by get_future().

m_qmw

QualityMetricWatch XrdAdaptor::ClientRequest::m_qmw

private

Definition at line 85 of file XrdRequest.h.

m_self_reference

edm::propagate_const<std::shared_ptr<ClientRequest> > XrdAdaptor::ClientRequest::m_self_reference

private

Definition at line 81 of file XrdRequest.h.

Referenced by self_reference().

m_size

IOSize XrdAdaptor::ClientRequest::m_size

private

Definition at line 69 of file XrdRequest.h.

Referenced by ClientRequest(), and getSize().

m_source

edm::propagate_const<std::shared_ptr<Source> > XrdAdaptor::ClientRequest::m_source

private

Definition at line 73 of file XrdRequest.h.

Referenced by getCurrentSource().

m_stats

edm::propagate_const<std::shared_ptr<XrdReadStatistics> > XrdAdaptor::ClientRequest::m_stats

private

Definition at line 74 of file XrdRequest.h.

Referenced by setStatistics().