XrdClHttp::CurlPutOp Class Reference

#include <XrdClHttpOps.hh>

Inheritance diagram for XrdClHttp::CurlPutOp:

Collaboration diagram for XrdClHttp::CurlPutOp:

Public Member Functions
	CurlPutOp (XrdCl::ResponseHandler *handler, std::shared_ptr< XrdCl::ResponseHandler > default_handler, const std::string &url, const char *buffer, size_t buffer_size, struct timespec timeout, XrdCl::Log *logger, CreateConnCalloutType callout, HeaderCallout *header_callout)
	CurlPutOp (XrdCl::ResponseHandler *handler, std::shared_ptr< XrdCl::ResponseHandler > default_handler, const std::string &url, XrdCl::Buffer &&buffer, struct timespec timeout, XrdCl::Log *logger, CreateConnCalloutType callout, HeaderCallout *header_callout)
virtual	~CurlPutOp ()
bool	Continue (std::shared_ptr< CurlOperation > op, XrdCl::ResponseHandler *handler, const char *buffer, size_t buffer_size)
bool	Continue (std::shared_ptr< CurlOperation > op, XrdCl::ResponseHandler *handler, XrdCl::Buffer &&buffer)
bool	ContinueHandle () override
void	Fail (uint16_t errCode, uint32_t errNum, const std::string &msg) override
virtual HttpVerb	GetVerb () const override
void	Pause ()
void	ReleaseHandle () override
virtual void	SetContinueQueue (std::shared_ptr< XrdClHttp::HandlerQueue > queue) 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 ()
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
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::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 868 of file XrdClHttpOps.hh.

Constructor & Destructor Documentation

CurlPutOp() [1/2]

CurlPutOp::CurlPutOp	(	XrdCl::ResponseHandler *	handler,
		std::shared_ptr< XrdCl::ResponseHandler >	default_handler,
		const std::string &	url,
		const char *	buffer,
		size_t	buffer_size,
		struct timespec	timeout,
		XrdCl::Log *	logger,
		CreateConnCalloutType	callout,
		HeaderCallout *	header_callout )

Definition at line 27 of file XrdClHttpOpPut.cc.

    : CurlOperation(handler, url, timeout, logger, callout, header_callout),
    m_data(buffer, buffer_size),
    m_default_handler(default_handler)
{
}

References XrdClHttp::CurlOperation::CurlOperation().

Here is the call graph for this function:

CurlPutOp() [2/2]

CurlPutOp::CurlPutOp	(	XrdCl::ResponseHandler *	handler,
		std::shared_ptr< XrdCl::ResponseHandler >	default_handler,
		const std::string &	url,
		XrdCl::Buffer &&	buffer,
		struct timespec	timeout,
		XrdCl::Log *	logger,
		CreateConnCalloutType	callout,
		HeaderCallout *	header_callout )

Definition at line 36 of file XrdClHttpOpPut.cc.

    : CurlOperation(handler, url, timeout, logger, callout, header_callout),
    m_owned_buffer(std::move(buffer)),
    m_data(buffer.GetBuffer(), buffer.GetSize()),
    m_default_handler(default_handler)
{
 
}

References XrdClHttp::CurlOperation::CurlOperation().

Here is the call graph for this function:

~CurlPutOp()

virtual XrdClHttp::CurlPutOp::~CurlPutOp ( )

inlinevirtual

Definition at line 879 of file XrdClHttpOps.hh.

{}

Member Function Documentation

Continue() [1/2]

bool CurlPutOp::Continue	(	std::shared_ptr< CurlOperation >	op,
		XrdCl::ResponseHandler *	handler,
		const char *	buffer,
		size_t	buffer_size )

Definition at line 145 of file XrdClHttpOpPut.cc.

{
    if (op.get() != this) {
        Fail(XrdCl::errInternal, 0, "Interface error: must provide shared pointer to self");
        return false;
    }
    m_handler = handler;
    m_data = std::string_view(buffer, buffer_size);
    if (!buffer_size)
    {
        m_final = true;
    }
 
    try {
        m_continue_queue->Produce(op);
    } catch (...) {
        Fail(XrdCl::errInternal, ENOMEM, "Failed to continue the curl operation");
        return false;
    }
    return true;
}

References XrdCl::errInternal, Fail(), and XrdClHttp::CurlOperation::m_handler.

Here is the call graph for this function:

Continue() [2/2]

bool CurlPutOp::Continue	(	std::shared_ptr< CurlOperation >	op,
		XrdCl::ResponseHandler *	handler,
		XrdCl::Buffer &&	buffer )

Definition at line 168 of file XrdClHttpOpPut.cc.

{
    if (op.get() != this) {
        Fail(XrdCl::errInternal, 0, "Interface error: must provide shared pointer to self");
        return false;
    }
    m_handler = handler;
    m_data = std::string_view(buffer.GetBuffer(), buffer.GetSize());
    if (!buffer.GetSize())
    {
        m_final = true;
    }
 
    try {
        m_continue_queue->Produce(op);
    } catch (...) {
        Fail(XrdCl::errInternal, ENOMEM, "Failed to continue the curl operation");
        return false;
    }
    return true;
}

References XrdCl::errInternal, Fail(), and XrdClHttp::CurlOperation::m_handler.

Here is the call graph for this function:

ContinueHandle()

bool CurlPutOp::ContinueHandle ( )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 129 of file XrdClHttpOpPut.cc.

{
    if (!m_curl_handle) {
                return false;
        }
 
        CURLcode rc;
        if ((rc = curl_easy_pause(m_curl_handle, CURLPAUSE_CONT)) != CURLE_OK) {
                m_logger->Error(kLogXrdClHttp, "Failed to continue a paused handle: %s", curl_easy_strerror(rc));
                return false;
        }
        SetPaused(false);
        return m_curl_handle;
}

References XrdClHttp::kLogXrdClHttp, XrdClHttp::CurlOperation::m_logger, and XrdClHttp::CurlOperation::SetPaused().

Here is the call graph for this function:

Fail()

void CurlPutOp::Fail ( uint16_t errCode, uint32_t errNum, const std::string & msg )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 48 of file XrdClHttpOpPut.cc.

{
    SetDone(true);
    if (m_handler == nullptr && m_default_handler == nullptr) {return;}
    if (!msg.empty()) {
        m_logger->Debug(kLogXrdClHttp, "PUT operation at offset %llu failed with message: %s", static_cast<long long unsigned>(m_offset), msg.c_str());
    } else {
        m_logger->Debug(kLogXrdClHttp, "PUT operation at offset %llu failed with status code %d", static_cast<long long unsigned>(m_offset), errNum);
    }
 
    auto status = new XrdCl::XRootDStatus(XrdCl::stError, errCode, errNum, msg);
    auto handle = m_handler;
    m_handler = nullptr;
    if (handle) handle->HandleResponse(status, nullptr);
    else m_default_handler->HandleResponse(status, nullptr);
}

References XrdClHttp::kLogXrdClHttp, XrdClHttp::CurlOperation::m_handler, XrdClHttp::CurlOperation::m_logger, XrdClHttp::CurlOperation::SetDone(), and XrdCl::stError.

Referenced by Continue(), and Continue().

Here is the call graph for this function:

Here is the caller graph for this function:

GetVerb()

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

inlineoverridevirtual

Implements XrdClHttp::CurlOperation.

Definition at line 903 of file XrdClHttpOps.hh.

{return HttpVerb::PUT;}

References XrdClHttp::CurlOperation::PUT.

Pause()

void CurlPutOp::Pause

(

)

Definition at line 96 of file XrdClHttpOpPut.cc.

{
    SetPaused(true);
    if (m_handler == nullptr && m_default_handler == nullptr) {
        m_logger->Warning(kLogXrdClHttp, "Put operation paused with no callback handler");
        return;
    }
    auto handle = m_handler;
    auto status = new XrdCl::XRootDStatus();
    m_handler = nullptr;
    m_owned_buffer.Free();
    // Note: As soon as this is invoked, another thread may continue and start to manipulate
    // the CurlPutOp object.  To avoid race conditions, all reads/writes to member data must
    // be done *before* the callback is invoked.
    if (handle) handle->HandleResponse(status, nullptr);
    else m_default_handler->HandleResponse(status, nullptr);
}

References XrdClHttp::kLogXrdClHttp, XrdClHttp::CurlOperation::m_handler, XrdClHttp::CurlOperation::m_logger, and XrdClHttp::CurlOperation::SetPaused().

Here is the call graph for this function:

ReleaseHandle()

void CurlPutOp::ReleaseHandle ( )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 81 of file XrdClHttpOpPut.cc.

{
    curl_easy_setopt(m_curl.get(), CURLOPT_READFUNCTION, nullptr);
    curl_easy_setopt(m_curl.get(), CURLOPT_READDATA, nullptr);
    curl_easy_setopt(m_curl.get(), CURLOPT_UPLOAD, 0);
    // If one uses just `-1` here -- instead of casting it to `curl_off_t`, then on Linux
    // we have observed compilers casting the `-1` to an unsigned, resulting in the file
    // size being set to 4294967295 instead of "unknown".  This causes the second use of the
    // handle to claim to upload a large file, resulting in the client hanging while waiting
    // for more input data (which will never come).
    curl_easy_setopt(m_curl.get(), CURLOPT_INFILESIZE_LARGE, static_cast<curl_off_t>(-1));
    CurlOperation::ReleaseHandle();
}

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

Here is the call graph for this function:

SetContinueQueue()

virtual void XrdClHttp::CurlPutOp::SetContinueQueue ( std::shared_ptr< XrdClHttp::HandlerQueue > queue )

inlineoverridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 887 of file XrdClHttpOps.hh.

                                                                                           {
                m_continue_queue = queue;
        }

Setup()

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

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 66 of file XrdClHttpOpPut.cc.

{
    m_curl_handle = curl;
    if (!CurlOperation::Setup(curl, worker)) return false;
 
    curl_easy_setopt(m_curl.get(), CURLOPT_UPLOAD, 1);
    curl_easy_setopt(m_curl.get(), CURLOPT_READDATA, this);
    curl_easy_setopt(m_curl.get(), CURLOPT_READFUNCTION, CurlPutOp::ReadCallback);
    if (m_object_size >= 0) {
        curl_easy_setopt(m_curl.get(), CURLOPT_INFILESIZE_LARGE, m_object_size);
    }
    return true;
}

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

Here is the call graph for this function:

Success()

void CurlPutOp::Success ( )

overridevirtual

Implements XrdClHttp::CurlOperation.

Definition at line 115 of file XrdClHttpOpPut.cc.

{
    SetDone(false);
    if (m_handler == nullptr) {
        m_logger->Warning(kLogXrdClHttp, "Put operation succeeded with no callback handler");
        return;
    }
    auto status = new XrdCl::XRootDStatus();
    auto handle = m_handler;
    m_handler = nullptr;
    handle->HandleResponse(status, nullptr);
}

References XrdClHttp::kLogXrdClHttp, XrdClHttp::CurlOperation::m_handler, XrdClHttp::CurlOperation::m_logger, and XrdClHttp::CurlOperation::SetDone().

Here is the call graph for this function:

---

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

• XrdClHttpOps.hh
• XrdClHttpOpPut.cc