#include <XrdClHttpOps.hh>

Inheritance diagram for XrdClHttp::CurlReadOp:

Collaboration diagram for XrdClHttp::CurlReadOp:

Public Member Functions
	CurlReadOp (XrdCl::ResponseHandler handler, std::shared_ptr< XrdCl::ResponseHandler > default_handler, const std::string &url, struct timespec timeout, const std::pair< uint64_t, uint64_t > &op, char buffer, size_t sz, XrdCl::Log logger, CreateConnCalloutType callout, HeaderCallout header_callout)

virtual	~CurlReadOp ()

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

bool	ContinueHandle () override

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

virtual HttpVerb	GetVerb () const override

virtual 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)

Protected Attributes
char *	m_buffer {nullptr}

size_t	m_buffer_size {0}

std::shared_ptr< XrdClHttp::HandlerQueue >	m_continue_queue

std::string	m_err_msg

std::pair< uint64_t, uint64_t >	m_op

uint64_t	m_written {0}

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

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)

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 611 of file XrdClHttpOps.hh.

Constructor & Destructor Documentation

◆ CurlReadOp()

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

Definition at line 30 of file XrdClHttpOpRead.cc.

                                    :
         CurlOperation(handler, url, timeout, logger, callout, header_callout),
         m_default_handler(default_handler),
         m_op(op),
         m_buffer(buffer),
         m_buffer_size(sz)
     {}

◆ ~CurlReadOp()

virtual XrdClHttp::CurlReadOp::~CurlReadOp ( )

inlinevirtual

Definition at line 617 of file XrdClHttpOps.hh.

617 {}

Member Function Documentation

◆ Continue()

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

Definition at line 42 of file XrdClHttpOpRead.cc.

 {
     if (op.get() != this) {
         m_logger->Debug(kLogXrdClHttp, "Interface error: must provide shared pointer to self");
         Fail(XrdCl::errInternal, 0, "Interface error: must provide shared pointer to self");
         return false;
     }
     m_handler = handler;
     m_buffer = buffer;
     m_buffer_size = buffer_size;
     m_written = 0;
  
     if (!m_prefetch_buffer.empty()) {
         auto prefetch_remaining = m_prefetch_buffer.size() - m_prefetch_buffer_offset;
         auto to_copy = prefetch_remaining > buffer_size ? buffer_size : prefetch_remaining;
         m_written += to_copy;
         memcpy(buffer, m_prefetch_buffer.data() + m_prefetch_buffer_offset, to_copy);
         m_prefetch_buffer_offset += to_copy;
         if (m_prefetch_buffer_offset == m_prefetch_buffer.size()) {
             m_prefetch_buffer.clear();
             m_prefetch_buffer_offset = 0;
         }
     }
  
     // This handles the case where the transfer finished but its last WriteCallback
     // produced more data than the client buffer could hold, the excess being stored
     // in the prefetch buffer
     // we just need to deliver the response without re-queuing to the continue queue
     if (op->IsDone()) {
         DeliverResponse();
     } else {
         try {
             m_continue_queue->Produce(op);
         } catch (...) {
             Fail(XrdCl::errInternal, ENOMEM, "Failed to continue the curl operation");
             return false;
         }
     }
  
     return true;
 }

References XrdCl::Log::Debug(), XrdCl::errInternal, Fail(), XrdClHttp::kLogXrdClHttp, m_buffer, m_buffer_size, m_continue_queue, XrdClHttp::CurlOperation::m_handler, XrdClHttp::CurlOperation::m_logger, and m_written.

Here is the call graph for this function:

◆ ContinueHandle()

bool CurlReadOp::ContinueHandle ( )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 85 of file XrdClHttpOpRead.cc.

 {
     if (IsDone()) {
         return false;
     }
     if (!m_curl) {
         return false;
     }
  
     CURLcode rc;
     if ((rc = curl_easy_pause(m_curl.get(), 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.get();
     }

References XrdCl::Log::Error(), XrdClHttp::CurlOperation::IsDone(), XrdClHttp::kLogXrdClHttp, XrdClHttp::CurlOperation::m_curl, XrdClHttp::CurlOperation::m_logger, and XrdClHttp::CurlOperation::SetPaused().

Here is the call graph for this function:

◆ Fail()

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

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 137 of file XrdClHttpOpRead.cc.

 {
     std::string custom_msg = msg;
     SetDone(true);
     if (m_handler == nullptr && m_default_handler == nullptr) {return;}
     if (!custom_msg.empty()) {
         m_logger->Debug(kLogXrdClHttp, "curl operation at offset %llu failed with message: %s%s", static_cast<long long unsigned>(m_op.first), msg.c_str(), m_err_msg.empty() ? "" : (", server message: " + m_err_msg).c_str());
         custom_msg += " (read operation at offset " + std::to_string(static_cast<long long unsigned>(m_op.first)) + ")";
     } else {
         m_logger->Debug(kLogXrdClHttp, "curl operation at offset %llu failed with status code %d%s", static_cast<long long unsigned>(m_op.first), errNum, m_err_msg.empty() ? "" : (", server message: " + m_err_msg).c_str());
     }
     auto status = new XrdCl::XRootDStatus(XrdCl::stError, errCode, errNum, custom_msg);
     auto handle = m_handler;
     m_handler = nullptr;
     if (handle) handle->HandleResponse(status, nullptr);
     else m_default_handler->HandleResponse(status, nullptr);
 }

References XrdCl::Log::Debug(), XrdCl::ResponseHandler::HandleResponse(), XrdClHttp::kLogXrdClHttp, m_err_msg, XrdClHttp::CurlOperation::m_handler, XrdClHttp::CurlOperation::m_logger, m_op, XrdClHttp::CurlOperation::SetDone(), and XrdCl::stError.

Referenced by Continue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetVerb()

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

inlineoverridevirtual

Implements XrdClHttp::CurlOperation.

Reimplemented in XrdClHttp::CurlPgReadOp.

Definition at line 638 of file XrdClHttpOps.hh.

638 {return HttpVerb::GET;}

◆ Pause()

void CurlReadOp::Pause ( )

virtual

Reimplemented in XrdClHttp::CurlPrefetchOpenOp.

Definition at line 179 of file XrdClHttpOpRead.cc.

 {
     SetPaused(true);
     if (m_handler == nullptr) {
         m_logger->Warning(kLogXrdClHttp, "Get operation paused with no callback handler");
         return;
     }
     DeliverResponse();
 }

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

Referenced by XrdClHttp::CurlPrefetchOpenOp::Pause().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReleaseHandle()

void CurlReadOp::ReleaseHandle ( )

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 205 of file XrdClHttpOpRead.cc.

 {
     if (m_curl == nullptr) return;
     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_OPENSOCKETFUNCTION, nullptr);
     curl_easy_setopt(m_curl.get(), CURLOPT_OPENSOCKETDATA, nullptr);
     curl_easy_setopt(m_curl.get(), CURLOPT_SOCKOPTFUNCTION, nullptr);
     curl_easy_setopt(m_curl.get(), CURLOPT_SOCKOPTDATA, nullptr);
     CurlOperation::ReleaseHandle();
 }

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

Here is the call graph for this function:

◆ SetContinueQueue()

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

inlineoverridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 634 of file XrdClHttpOps.hh.

                                                                                            {
                 m_continue_queue = queue;
         }

References m_continue_queue.

◆ Setup()

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

overridevirtual

Reimplemented from XrdClHttp::CurlOperation.

Definition at line 104 of file XrdClHttpOpRead.cc.

 {
     if (!CurlOperation::Setup(curl, worker)) {return false;}
  
     curl_easy_setopt(m_curl.get(), CURLOPT_WRITEFUNCTION, CurlReadOp::WriteCallback);
     curl_easy_setopt(m_curl.get(), CURLOPT_WRITEDATA, this);
  
     // Note: range requests are inclusive of the end byte, meaning "bytes=0-1023" is a 1024-byte request.
     // This is why we subtract '1' off the end.
     if (m_op.second == 0) {
         Success();
         return true;
     }
     if (m_op.second >= 1024*1024) {
         curl_easy_setopt(curl, CURLOPT_BUFFERSIZE, 128*1024);
     }
     else if (m_op.second >= 256*1024) {
         curl_easy_setopt(curl, CURLOPT_BUFFERSIZE, 64*1024);
     }
     else if (m_op.second >= 128*1024) {
         curl_easy_setopt(curl, CURLOPT_BUFFERSIZE, 32*1024);
     }
     // If the requested read size is UINT64_MAX, it means read the entire object;
     // in this case, we do not set the Range header.
     if (m_op.second != UINT64_MAX) {
         auto range_req = "bytes=" + std::to_string(m_op.first) + "-" + std::to_string(m_op.first + m_op.second - 1);
         m_headers_list.emplace_back("Range", range_req);
     }
  
     return true;
 }

References XrdClHttp::CurlOperation::m_curl, XrdClHttp::CurlOperation::m_headers_list, m_op, XrdClHttp::CurlOperation::Setup(), and Success().

Here is the call graph for this function:

◆ Success()

void CurlReadOp::Success ( )

overridevirtual

Implements XrdClHttp::CurlOperation.

Reimplemented in XrdClHttp::CurlPgReadOp.

Definition at line 190 of file XrdClHttpOpRead.cc.

 {
     SetDone(false);
     if (m_handler == nullptr) {return;}
     auto status = new XrdCl::XRootDStatus();
     auto chunk_info = new XrdCl::ChunkInfo(m_op.first + m_prefetch_object_offset, m_written, m_buffer);
     m_prefetch_object_offset += m_written;
     auto obj = new XrdCl::AnyObject();
     obj->Set(chunk_info);
     auto handle = m_handler;
     m_handler = nullptr;
     handle->HandleResponse(status, obj);
 }

References XrdCl::ResponseHandler::HandleResponse(), m_buffer, XrdClHttp::CurlOperation::m_handler, m_op, m_written, and XrdClHttp::CurlOperation::SetDone().

Referenced by Setup().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_buffer

char* XrdClHttp::CurlReadOp::m_buffer {nullptr}

protected

Definition at line 669 of file XrdClHttpOps.hh.

Referenced by Continue(), Success(), and XrdClHttp::CurlPgReadOp::Success().

◆ m_buffer_size

size_t XrdClHttp::CurlReadOp::m_buffer_size {0}

protected

Definition at line 670 of file XrdClHttpOps.hh.

Referenced by Continue().

◆ m_continue_queue

std::shared_ptr<XrdClHttp::HandlerQueue> XrdClHttp::CurlReadOp::m_continue_queue

protected

Definition at line 677 of file XrdClHttpOps.hh.

Referenced by Continue(), and SetContinueQueue().

◆ m_err_msg

std::string XrdClHttp::CurlReadOp::m_err_msg

protected

Definition at line 674 of file XrdClHttpOps.hh.

Referenced by Fail().

◆ m_op

std::pair<uint64_t, uint64_t> XrdClHttp::CurlReadOp::m_op

protected

Definition at line 667 of file XrdClHttpOps.hh.

Referenced by Fail(), Setup(), Success(), and XrdClHttp::CurlPgReadOp::Success().

◆ m_written

uint64_t XrdClHttp::CurlReadOp::m_written {0}

protected

Definition at line 668 of file XrdClHttpOps.hh.

Referenced by Continue(), Success(), and XrdClHttp::CurlPgReadOp::Success().

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CurlReadOp()

◆ ~CurlReadOp()

Member Function Documentation

◆ Continue()

◆ ContinueHandle()

◆ Fail()

◆ GetVerb()

◆ Pause()

◆ ReleaseHandle()

◆ SetContinueQueue()

◆ Setup()

◆ Success()

Member Data Documentation

◆ m_buffer

◆ m_buffer_size

◆ m_continue_queue

◆ m_err_msg

◆ m_op

◆ m_written