XrdClHttp::CurlTapeOp Class Reference

#include <XrdClHttpOps.hh>

Inheritance diagram for XrdClHttp::CurlTapeOp:

Collaboration diagram for XrdClHttp::CurlTapeOp:

Public Member Functions
	~CurlTapeOp () override
void	Fail (uint16_t errCode, uint32_t errNum, const std::string &message) override
HttpVerb	GetVerb () const override
void	ReleaseHandle () override
bool	Setup (CURL *curl, CurlWorker &worker) 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 ()
void	ExtendDeadline (struct timespec timeout)
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	OptionsDone ()
virtual RedirectAction	Redirect (std::string &target)
virtual bool	RequiresOptions () const
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)

Protected Member Functions
	CurlTapeOp (XrdCl::ResponseHandler *handler, const std::string &url, std::unique_ptr< TapeOperation > tape, struct timespec timeout, XrdCl::Log *logger, CreateConnCalloutType callout, HeaderCallout *header_callout)
Protected Member Functions inherited from XrdClHttp::CurlOperation
int	FailCallback (XErrorCode ecode, const std::string &emsg)
void	SetDone (bool has_failed)
void	SetPaused (bool paused)
bool	SetupNextRequest (const std::string &url, CurlWorker &worker)
void	UpdateBytes (uint64_t bytes)

Additional Inherited Members
Public Types inherited from XrdClHttp::CurlOperation
using	HeaderList = std::vector<std::pair<std::string, std::string>>
using	HttpVerb = XrdClHttp::HttpVerb
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 Attributes inherited from XrdClHttp::CurlOperation
std::unique_ptr< CURL, void(*)(CURL *)>	m_curl
XrdCl::ResponseHandler *	m_handler {nullptr}
HeaderCallout *	m_header_callout
std::atomic< 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
std::string	m_request_url
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 632 of file XrdClHttpOps.hh.

Constructor & Destructor Documentation

~CurlTapeOp()

CurlTapeOp::~CurlTapeOp ( )

overridedefault

References Fail(), GetVerb(), ReleaseHandle(), Setup(), and Success().

Here is the call graph for this function:

CurlTapeOp()

CurlTapeOp::CurlTapeOp ( XrdCl::ResponseHandler * handler, const std::string & url, std::unique_ptr< TapeOperation > tape, struct timespec timeout, XrdCl::Log * logger, CreateConnCalloutType callout, HeaderCallout * header_callout )

protected

Definition at line 37 of file XrdClHttpOpTape.cc.

:
    CurlOperation(handler, url, timeout, logger, callout, header_callout),
    m_tape(std::move(tape))
{
}

References XrdClHttp::CurlOperation::CurlOperation().

Referenced by XrdClHttp::CurlTapePrepareOp::CurlTapePrepareOp(), and XrdClHttp::CurlTapeQueryOp::CurlTapeQueryOp().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

Fail()

void CurlTapeOp::Fail ( uint16_t errCode, uint32_t errNum, const std::string & message )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 223 of file XrdClHttpOpTape.cc.

{
    std::string detail = message;
    if(GetStatusCode() >= 400)
    {
        detail = RequestDescription() + " failed: "
            + TapeProblemResponse(GetStatusCode(), m_response);
    }
    CurlOperation::Fail(errCode, errNum, detail);
}

References XrdClHttp::CurlOperation::Fail, XrdClHttp::CurlOperation::GetStatusCode(), and XrdClHttp::TapeProblemResponse().

Referenced by ~CurlTapeOp(), Setup(), and Success().

Here is the call graph for this function:

Here is the caller graph for this function:

GetVerb()

CurlOperation::HttpVerb CurlTapeOp::GetVerb ( ) const

overridevirtual

Implements XrdClHttp::CurlOperation.

Definition at line 236 of file XrdClHttpOpTape.cc.

{
    return m_request.method;
}

Referenced by ~CurlTapeOp().

Here is the caller graph for this function:

ReleaseHandle()

void CurlTapeOp::ReleaseHandle ( )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 248 of file XrdClHttpOpTape.cc.

{
    if(m_curl == nullptr) return;
 
    curl_easy_setopt(m_curl.get(), CURLOPT_ERRORBUFFER, nullptr);
    curl_easy_setopt(m_curl.get(), CURLOPT_WRITEFUNCTION, nullptr);
    curl_easy_setopt(m_curl.get(), CURLOPT_WRITEDATA, nullptr);
    curl_easy_setopt(m_curl.get(), CURLOPT_HTTPHEADER, nullptr);
    curl_easy_setopt(m_curl.get(), CURLOPT_POST, 0L);
    curl_easy_setopt(m_curl.get(), CURLOPT_POSTFIELDS, nullptr);
    curl_easy_setopt(m_curl.get(), CURLOPT_POSTFIELDSIZE_LARGE,
                     static_cast<curl_off_t>(0));
    curl_easy_setopt(m_curl.get(), CURLOPT_CUSTOMREQUEST, nullptr);
    CurlOperation::ReleaseHandle();
}

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

Referenced by ~CurlTapeOp().

Here is the call graph for this function:

Here is the caller graph for this function:

Setup()

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

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 74 of file XrdClHttpOpTape.cc.

{
    const auto failure = [&](uint16_t code, uint32_t error,
                             const std::string &message) {
        if(!m_curl) m_curl.reset(curl);
        Fail(code, error, message);
        return false;
    };
 
    try
    {
        const auto status = m_tape->Start(m_request);
        if(!status.IsOK())
        {
            return failure(status.code, status.errNo,
                           status.GetErrorMessage());
        }
 
        m_request_url = m_request.url;
        if(!CurlOperation::Setup(curl, worker))
        {
            throw std::runtime_error(
                "failed to initialize " + RequestDescription());
        }
        m_worker = &worker;
        if(!ConfigureRequest())
        {
            throw std::runtime_error(
                "failed to configure " + RequestDescription());
        }
        return true;
    }
    catch(const std::exception &ex)
    {
        return failure(XrdCl::errInternal, EIO, ex.what());
    }
}

References XrdCl::errInternal, Fail(), XrdClHttp::CurlOperation::m_curl, XrdClHttp::CurlOperation::m_request_url, and XrdClHttp::CurlOperation::Setup().

Referenced by ~CurlTapeOp().

Here is the call graph for this function:

Here is the caller graph for this function:

Success()

void CurlTapeOp::Success ( )

overridevirtual

Implements XrdClHttp::CurlOperation.

Definition at line 173 of file XrdClHttpOpTape.cc.

{
    try
    {
        TapeHttpRequest nextRequest;
        std::string response;
        bool complete = false;
        const auto status = m_tape->Advance(
            m_curl.get(), GetStatusCode(), m_response,
            nextRequest, response, complete);
        if(!status.IsOK())
        {
            Fail(status.code, status.errNo, status.GetErrorMessage());
            return;
        }
        if(complete)
        {
            Complete(response);
            return;
        }
 
        m_request = std::move(nextRequest);
        if(!m_worker)
        {
            throw std::runtime_error(
                "worker unavailable before starting " + RequestDescription());
        }
        if(!SetupNextRequest(m_request.url, *m_worker))
        {
            throw std::runtime_error(
                "failed to reset the curl handle for " + RequestDescription());
        }
        if(!ConfigureRequest())
        {
            throw std::runtime_error(
                "failed to configure " + RequestDescription());
        }
        if(!FinishSetup(m_curl.get()))
        {
            throw std::runtime_error(
                "failed to configure headers for " + RequestDescription());
        }
    }
    catch(const std::exception &ex)
    {
        Fail(XrdCl::errInternal, EIO, ex.what());
    }
}

References XrdCl::errInternal, Fail(), XrdClHttp::CurlOperation::FinishSetup(), XrdClHttp::CurlOperation::GetStatusCode(), XrdClHttp::CurlOperation::m_curl, and XrdClHttp::CurlOperation::SetupNextRequest().

Referenced by ~CurlTapeOp().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• XrdClHttpOps.hh
• XrdClHttpOpTape.cc