XrdCl::AsyncVectorReader Class Reference

Object for reading out data from the VectorRead response. More...

#include <XrdClAsyncVectorReader.hh>

Collaboration diagram for XrdCl::AsyncVectorReader:

Classes
struct	ChunkStatus

Public Member Functions
	AsyncVectorReader (const URL &url)
virtual	~AsyncVectorReader ()
	Destructor. More...
void	SetDataLength (int dlen)
	Sets response data length. More...
void	SetChunkList (ChunkList *chunks)
	Sets the chunk list with user buffers. More...
XRootDStatus	Read (Socket &socket, uint32_t &btsret)
Status	GetVectorReadInfo (VectorReadInfo *&info)

Private Types
enum	Stage {   ReadStart , ReadRdLst , ReadChunk , ReadDiscard ,   ReadDone }
	Stages of reading out a response from the socket. More...
using	buffer_t = std::vector< char >

Private Member Functions
Status	ReadBytesAsync (Socket &socket, char *buffer, uint32_t toBeRead, uint32_t &bytesRead)

Private Attributes
Stage	readstage
const URL &	url
ChunkList *	chunks
std::vector< ChunkStatus >	chstatus
uint32_t	dlen
uint32_t	totalbtsrd
size_t	chidx
size_t	choff
size_t	chlen
size_t	rdlstoff
readahead_list	rdlst
size_t	rdlstlen
buffer_t	discardbuff

Detailed Description

Object for reading out data from the VectorRead response.

Member Typedef Documentation

buffer_t

using XrdCl::AsyncVectorReader::buffer_t = std::vector<char>

private

Member Enumeration Documentation

Stage

enum XrdCl::AsyncVectorReader::Stage

private

Stages of reading out a response from the socket.

Enumerator
ReadStart
ReadRdLst
ReadChunk
ReadDiscard
ReadDone

Constructor & Destructor Documentation

AsyncVectorReader()

XrdCl::AsyncVectorReader::AsyncVectorReader ( const URL &  url )

inline

Constructor

Parameters

url	: channel URL

References rdlst.

~AsyncVectorReader()

virtual XrdCl::AsyncVectorReader::~AsyncVectorReader ( )

inlinevirtual

Destructor.

Member Function Documentation

GetVectorReadInfo()

Status XrdCl::AsyncVectorReader::GetVectorReadInfo ( VectorReadInfo *&  info )

inline

References chstatus, chunks, XrdCl::errInvalidResponse, and XrdCl::stFatal.

Read()

XRootDStatus XrdCl::AsyncVectorReader::Read ( Socket &  socket, uint32_t &  btsret  )

inline

Readout raw data from socket

Parameters

socket	: the socket
btsret	: number of bytes read

Returns

: operation status

References chidx, chlen, choff, chstatus, chunks, XrdCl::Status::code, discardbuff, dlen, XrdCl::Log::Dump(), XrdCl::Log::Error(), XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), XrdCl::Status::IsOK(), readahead_list::offset, rdlst, rdlstlen, rdlstoff, ReadBytesAsync(), ReadChunk, ReadDiscard, ReadDone, ReadRdLst, readstage, ReadStart, readahead_list::rlen, XrdCl::suRetry, totalbtsrd, url, XrdCl::Log::Warning(), and XrdCl::XRootDMsg.

ReadBytesAsync()

Status XrdCl::AsyncVectorReader::ReadBytesAsync ( Socket &  socket, char *  buffer, uint32_t  toBeRead, uint32_t &  bytesRead  )

inlineprivate

References XrdCl::Status::code, XrdCl::Status::IsOK(), XrdCl::Socket::Read(), XrdCl::stOK, XrdCl::suDone, and XrdCl::suRetry.

Referenced by Read().

SetChunkList()

void XrdCl::AsyncVectorReader::SetChunkList ( ChunkList *  chunks )

inline

Sets the chunk list with user buffers.

References chstatus, and chunks.

SetDataLength()

void XrdCl::AsyncVectorReader::SetDataLength ( int  dlen )

inline

Sets response data length.

References dlen, readstage, ReadStart, and totalbtsrd.

Member Data Documentation

chidx

size_t XrdCl::AsyncVectorReader::chidx

private

Referenced by Read().

chlen

size_t XrdCl::AsyncVectorReader::chlen

private

Referenced by Read().

choff

size_t XrdCl::AsyncVectorReader::choff

private

Referenced by Read().

chstatus

std::vector<ChunkStatus> XrdCl::AsyncVectorReader::chstatus

private

Referenced by GetVectorReadInfo(), Read(), and SetChunkList().

chunks

ChunkList* XrdCl::AsyncVectorReader::chunks

private

Referenced by GetVectorReadInfo(), Read(), and SetChunkList().

discardbuff

buffer_t XrdCl::AsyncVectorReader::discardbuff

private

Referenced by Read().

dlen

uint32_t XrdCl::AsyncVectorReader::dlen

private

Referenced by Read(), and SetDataLength().

rdlst

readahead_list XrdCl::AsyncVectorReader::rdlst

private

Referenced by AsyncVectorReader(), and Read().

rdlstlen

size_t XrdCl::AsyncVectorReader::rdlstlen

private

Referenced by Read().

rdlstoff

size_t XrdCl::AsyncVectorReader::rdlstoff

private

Referenced by Read().

readstage

Stage XrdCl::AsyncVectorReader::readstage

private

Referenced by Read(), and SetDataLength().

totalbtsrd

uint32_t XrdCl::AsyncVectorReader::totalbtsrd

private

Referenced by Read(), and SetDataLength().

url

const URL& XrdCl::AsyncVectorReader::url

private

Referenced by Read().

---

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

• XrdClAsyncVectorReader.hh