XrdClHttp::CurlChecksumOp Class Reference

#include <XrdClHttpOps.hh>

Inheritance diagram for XrdClHttp::CurlChecksumOp:

Collaboration diagram for XrdClHttp::CurlChecksumOp:

Public Member Functions
	CurlChecksumOp (XrdCl::ResponseHandler *handler, const std::string &url, XrdClHttp::ChecksumType preferred, struct timespec timeout, XrdCl::Log *logger, bool response_info, CreateConnCalloutType callout, HeaderCallout *header_callout)
virtual	~CurlChecksumOp ()
virtual HttpVerb	GetVerb () const override
virtual void	OptionsDone () override
RedirectAction	Redirect (std::string &target) override
void	ReleaseHandle () override
bool	Setup (CURL *curl, CurlWorker &) override
void	Success () override
Public Member Functions inherited from XrdClHttp::CurlStatOp
	CurlStatOp (XrdCl::ResponseHandler *handler, const std::string &url, struct timespec timeout, XrdCl::Log *log, bool response_info, CreateConnCalloutType callout, HeaderCallout *header_callout)
virtual	~CurlStatOp ()
std::pair< int64_t, bool >	GetStatInfo ()
RedirectAction	Redirect (std::string &target) override
void	ReleaseHandle () override
virtual bool	RequiresOptions () const override
bool	Setup (CURL *curl, CurlWorker &) override
void	Success () override
Public Member Functions inherited from XrdClHttp::CurlOperation
	CurlOperation (const CurlOperation &)=delete
	CurlOperation (XrdCl::ResponseHandler *handler, const std::string &url, std::chrono::steady_clock::time_point expiry, XrdCl::Log *log, CreateConnCalloutType, HeaderCallout *header_callout)
	CurlOperation (XrdCl::ResponseHandler *handler, const std::string &url, struct timespec timeout, XrdCl::Log *log, CreateConnCalloutType, HeaderCallout *header_callout)
virtual	~CurlOperation ()
virtual bool	ContinueHandle ()
virtual void	Fail (uint16_t errCode, uint32_t errNum, const std::string &)
bool	FinishSetup (CURL *curl)
std::pair< XErrorCode, std::string >	GetCallbackError () const
CreateConnCalloutType	GetConnCalloutFunc () const
std::string	GetCurlErrorMessage () const
CURL *	GetCurlHandle () const
OpError	GetError () const
std::chrono::steady_clock::time_point	GetHeaderExpiry () const
std::chrono::steady_clock::time_point	GetOperationExpiry ()
std::unique_ptr< ResponseInfo >	GetResponseInfo ()
int	GetStatusCode () const
std::string	GetStatusMessage () const
bool	GetTriedBoker () const
const std::string &	GetUrl () const
bool	HasFailed () const
bool	HeaderTimeoutExpired (const std::chrono::steady_clock::time_point &now)
bool	IsDone () const
bool	IsPaused () const
bool	IsRedirect () const
std::unique_ptr< ResponseInfo >	MoveResponseInfo ()
bool	OperationTimeoutExpired (const std::chrono::steady_clock::time_point &now)
virtual void	SetContinueQueue (std::shared_ptr< XrdClHttp::HandlerQueue > queue)
void	SetTriedBoker ()
bool	StartConnectionCallout (std::string &err)
std::tuple< uint64_t, std::chrono::steady_clock::duration, std::chrono::steady_clock::duration, std::chrono::steady_clock::duration >	StatisticsReset ()
bool	TransferStalled (uint64_t xfer_bytes, const std::chrono::steady_clock::time_point &now)
bool	UseConnectionCallout ()
virtual int	WaitSocket ()
virtual int	WaitSocketCallback (std::string &err)

Additional Inherited Members
Public Types inherited from XrdClHttp::CurlOperation
using	HeaderList = std::vector<std::pair<std::string, std::string>>
enum class	HttpVerb {   COPY ,   DELETE ,   HEAD ,   GET ,   MKCOL ,   OPTIONS ,   PROPFIND ,   PUT ,   Count }
enum	OpError {   ErrNone ,   ErrHeaderTimeout ,   ErrCallback ,   ErrOperationTimeout ,   ErrTransferClientStall ,   ErrTransferStall ,   ErrTransferSlow }
enum class	RedirectAction {   Fail ,   Reinvoke ,   ReinvokeAfterAllow }
Static Public Member Functions inherited from XrdClHttp::CurlOperation
static void	CleanupDnsCache ()
static int	GetDefaultSlowRateBytesSec ()
static int	GetDefaultStallTimeout ()
static const std::string	GetVerbString (HttpVerb)
static void	SetSlowRateBytesSec (int rate)
static void	SetStallTimeout (const std::chrono::steady_clock::duration &stall_interval)
static void	SetStallTimeout (int stall_interval)
Protected Member Functions inherited from XrdClHttp::CurlStatOp
void	SuccessImpl (bool returnObj)
Protected Member Functions inherited from XrdClHttp::CurlOperation
int	FailCallback (XErrorCode ecode, const std::string &emsg)
void	SetDone (bool has_failed)
void	SetPaused (bool paused)
void	UpdateBytes (uint64_t bytes)
Protected Attributes inherited from XrdClHttp::CurlOperation
std::unique_ptr< CURL, void(*)(CURL *)>	m_curl
XrdCl::ResponseHandler *	m_handler {nullptr}
HeaderCallout *	m_header_callout
std::chrono::steady_clock::time_point	m_header_expiry
HeaderParser	m_headers
std::vector< std::pair< std::string, std::string > >	m_headers_list
XrdCl::Log *	m_logger
int	m_minimum_rate {m_minimum_transfer_rate}
std::chrono::steady_clock::time_point	m_operation_expiry
const std::string	m_url
Static Protected Attributes inherited from XrdClHttp::CurlOperation
static constexpr int	m_default_minimum_rate {1024 * 256}
static int	m_minimum_transfer_rate {CurlOperation::m_default_minimum_rate}

Detailed Description

Definition at line 527 of file XrdClHttpOps.hh.

Constructor & Destructor Documentation

CurlChecksumOp()

CurlChecksumOp::CurlChecksumOp	(	XrdCl::ResponseHandler *	handler,
		const std::string &	url,
		XrdClHttp::ChecksumType	preferred,
		struct timespec	timeout,
		XrdCl::Log *	logger,
		bool	response_info,
		CreateConnCalloutType	callout,
		HeaderCallout *	header_callout )

Definition at line 33 of file XrdClHttpOpChecksum.cc.

:
    CurlStatOp(handler, url, timeout, logger, response_info, callout, header_callout),
    m_preferred_cksum(preferred)
{}

References XrdClHttp::CurlStatOp::CurlStatOp().

Here is the call graph for this function:

~CurlChecksumOp()

virtual XrdClHttp::CurlChecksumOp::~CurlChecksumOp ( )

inlinevirtual

Definition at line 533 of file XrdClHttpOps.hh.

{}

Member Function Documentation

GetVerb()

virtual HttpVerb XrdClHttp::CurlChecksumOp::GetVerb ( ) const

inlineoverridevirtual

Reimplemented from XrdClHttp::CurlStatOp.

Definition at line 535 of file XrdClHttpOps.hh.

{return HttpVerb::HEAD;}

References XrdClHttp::CurlOperation::HEAD.

OptionsDone()

void CurlChecksumOp::OptionsDone ( )

overridevirtual

Reimplemented from XrdClHttp::CurlStatOp.

Definition at line 43 of file XrdClHttpOpChecksum.cc.

{}

Redirect()

CurlOperation::RedirectAction CurlChecksumOp::Redirect ( std::string & target )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 61 of file XrdClHttpOpChecksum.cc.

{
    auto result = CurlOperation::Redirect(target);
    curl_easy_setopt(m_curl.get(), CURLOPT_NOBODY, 1L);
    curl_easy_setopt(m_curl.get(), CURLOPT_CUSTOMREQUEST, nullptr);
    return result;
}

References XrdClHttp::CurlOperation::m_curl, and XrdClHttp::CurlOperation::Redirect().

Here is the call graph for this function:

ReleaseHandle()

void CurlChecksumOp::ReleaseHandle ( )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 70 of file XrdClHttpOpChecksum.cc.

{
    if (m_curl == nullptr) return;
    curl_easy_setopt(m_curl.get(), CURLOPT_HTTPHEADER, nullptr);
 
    CurlStatOp::ReleaseHandle();
}

References XrdClHttp::CurlOperation::m_curl, and XrdClHttp::CurlStatOp::ReleaseHandle().

Here is the call graph for this function:

Setup()

bool CurlChecksumOp::Setup ( CURL * curl, CurlWorker & worker )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 47 of file XrdClHttpOpChecksum.cc.

{
    auto rv = CurlStatOp::Setup(curl, worker);
    if (!rv) return false;
 
    curl_easy_setopt(m_curl.get(), CURLOPT_NOBODY, 1L);
    curl_easy_setopt(m_curl.get(), CURLOPT_CUSTOMREQUEST, nullptr);
 
    m_headers_list.emplace_back("Want-Digest", XrdClHttp::HeaderParser::ChecksumTypeToDigestName(m_preferred_cksum));
 
    return true;
}

References XrdClHttp::HeaderParser::ChecksumTypeToDigestName(), XrdClHttp::CurlOperation::m_curl, XrdClHttp::CurlOperation::m_headers_list, and XrdClHttp::CurlStatOp::Setup().

Here is the call graph for this function:

Success()

void CurlChecksumOp::Success ( )

overridevirtual

Implements XrdClHttp::CurlOperation.

Definition at line 79 of file XrdClHttpOpChecksum.cc.

{
    SetDone(false);
    auto checksums = m_headers.GetChecksums();
 
    std::array<unsigned char, XrdClHttp::g_max_checksum_length> value;
    auto type = XrdClHttp::ChecksumType::kUnknown;
    if (checksums.IsSet(m_preferred_cksum)) {
        value = checksums.Get(m_preferred_cksum);
        type = m_preferred_cksum;
    } else {
        bool isset;
        std::tie(type, value, isset) = checksums.GetFirst();
        if (!isset) {
            m_logger->Error(kLogXrdClHttp, "Checksums not found in response for %s", m_url.c_str());
            auto handle = m_handler;
            m_handler = nullptr;
            handle->HandleResponse(new XrdCl::XRootDStatus(XrdCl::stError, XrdCl::errCheckSumError), nullptr);
            return; 
        }
    }
    std::stringstream ss;
    for (size_t idx = 0; idx < XrdClHttp::GetChecksumLength(type); ++idx) {
        ss << std::hex << std::setw(2) << std::setfill('0') << static_cast<int>(value[idx]);
    }
 
    std::string response = XrdClHttp::GetTypeString(type) + " " + ss.str();
    auto buf = new XrdClHttp::QueryResponse();
    buf->FromString(response);
    buf->SetResponseInfo(MoveResponseInfo());
    
    auto obj = new XrdCl::AnyObject();
    obj->Set(static_cast<XrdCl::Buffer*>(buf));
 
    auto handle = m_handler;
    m_handler = nullptr;
    handle->HandleResponse(new XrdCl::XRootDStatus(), obj);
    // Does not call CurlStatOp::Success() as we don't need to invoke a stat info callback
}

References XrdCl::errCheckSumError, XrdClHttp::GetChecksumLength(), XrdClHttp::GetTypeString(), XrdClHttp::kLogXrdClHttp, XrdClHttp::kUnknown, XrdClHttp::CurlOperation::m_handler, XrdClHttp::CurlOperation::m_headers, XrdClHttp::CurlOperation::m_logger, XrdClHttp::CurlOperation::m_url, XrdClHttp::CurlOperation::MoveResponseInfo(), XrdClHttp::CurlOperation::SetDone(), and XrdCl::stError.

Here is the call graph for this function:

---

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

• XrdClHttpOps.hh
• XrdClHttpOpChecksum.cc