XrdCl::AsyncRawReaderIntfc Class Reference

Base class for any message's body reader. More...

#include <XrdClAsyncRawReaderIntfc.hh>

Inheritance diagram for XrdCl::AsyncRawReaderIntfc:

Collaboration diagram for XrdCl::AsyncRawReaderIntfc:

Classes
struct	ChunkStatus

Public Member Functions
	AsyncRawReaderIntfc (const URL &url, const Message &request)
virtual	~AsyncRawReaderIntfc ()
	Destructor.
virtual XRootDStatus	GetResponse (AnyObject *&response)=0
	Get the response.
virtual XRootDStatus	Read (Socket &socket, uint32_t &btsret)=0
void	SetChunkList (ChunkList *chunks)
	Sets the chunk list with user buffers.
void	SetDataLength (int dlen)
	Sets response data length.

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

Protected Member Functions
XRootDStatus	ReadBytesAsync (Socket &socket, char *buffer, uint32_t toBeRead, uint32_t &bytesRead)

Protected Attributes
size_t	chidx
size_t	chlen
size_t	choff
std::vector< ChunkStatus >	chstatus
ChunkList *	chunks
bool	dataerr
buffer_t	discardbuff
uint32_t	dlen
uint32_t	msgbtsrd
uint32_t	rawbtsrd
Stage	readstage
const Message &	request
const URL &	url

Detailed Description

Base class for any message's body reader.

Definition at line 34 of file XrdClAsyncRawReaderIntfc.hh.

Member Typedef Documentation

buffer_t

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

protected

Definition at line 132 of file XrdClAsyncRawReaderIntfc.hh.

Member Enumeration Documentation

Stage

enum XrdCl::AsyncRawReaderIntfc::Stage

protected

Stages of reading out a response from the socket.

Enumerator
ReadStart
ReadRdLst
ReadRaw
ReadDiscard
ReadDone

Definition at line 137 of file XrdClAsyncRawReaderIntfc.hh.

      {
        ReadStart,   //< the next step is to initialize the read
        ReadRdLst,   //< the next step is to read the read_list
        ReadRaw,     //< the next step is to read the raw data
        ReadDiscard, //< there was an error, we are in discard mode
        ReadDone     //< the next step is to finalize the read
      };

Constructor & Destructor Documentation

AsyncRawReaderIntfc()

XrdCl::AsyncRawReaderIntfc::AsyncRawReaderIntfc ( const URL &  url, const Message &  request  )

inline

Definition at line 38 of file XrdClAsyncRawReaderIntfc.hh.

                                                                    :
        readstage( ReadStart ),
        url( url ),
        request( request ),
        chunks( nullptr ),
        dlen( 0 ),
        msgbtsrd( 0 ),
        rawbtsrd( 0 ),
        chidx( 0 ),
        choff( 0 ),
        chlen( 0 ),
        dataerr( false )
      {
      }

~AsyncRawReaderIntfc()

virtual XrdCl::AsyncRawReaderIntfc::~AsyncRawReaderIntfc ( )

inlinevirtual

Destructor.

Definition at line 56 of file XrdClAsyncRawReaderIntfc.hh.

      {
      }

Member Function Documentation

GetResponse()

virtual XRootDStatus XrdCl::AsyncRawReaderIntfc::GetResponse ( AnyObject *&  response )

pure virtual

Get the response.

Implemented in XrdCl::AsyncDiscardReader, XrdCl::AsyncRawReader, and XrdCl::AsyncVectorReader.

Read()

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

pure virtual

Readout raw data from socket

Parameters

socket	: the socket
btsret	: number of bytes read

Returns

: operation status

Implemented in XrdCl::AsyncDiscardReader, XrdCl::AsyncRawReader, and XrdCl::AsyncVectorReader.

ReadBytesAsync()

XRootDStatus XrdCl::AsyncRawReaderIntfc::ReadBytesAsync ( Socket &  socket, char *  buffer, uint32_t  toBeRead, uint32_t &  bytesRead  )

inlineprotected

Definition at line 98 of file XrdClAsyncRawReaderIntfc.hh.

      {
        size_t shift = 0;
        while( toBeRead > 0 )
        {
          int btsRead = 0;
          Status status = socket.Read( buffer + shift, toBeRead, btsRead );
 
          if( !status.IsOK() || status.code == suRetry )
            return status;
 
          bytesRead += btsRead;
          toBeRead  -= btsRead;
          shift     += btsRead;
        }
        return XRootDStatus( stOK, suDone );
      }

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

Referenced by XrdCl::AsyncRawReader::Read(), and XrdCl::AsyncVectorReader::Read().

Here is the call graph for this function:

Here is the caller graph for this function:

SetChunkList()

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

inline

Sets the chunk list with user buffers.

Definition at line 72 of file XrdClAsyncRawReaderIntfc.hh.

      {
        this->chunks = chunks;
        if( chunks )
          this->chstatus.resize( chunks->size() );
      }

References chstatus, and chunks.

SetDataLength()

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

inline

Sets response data length.

Definition at line 63 of file XrdClAsyncRawReaderIntfc.hh.

      {
        this->dlen       = dlen;
        this->readstage  = ReadStart;
      }

References dlen, readstage, and ReadStart.

Member Data Documentation

chidx

size_t XrdCl::AsyncRawReaderIntfc::chidx

protected

Definition at line 163 of file XrdClAsyncRawReaderIntfc.hh.

Referenced by XrdCl::AsyncRawReader::Read(), and XrdCl::AsyncVectorReader::Read().

chlen

size_t XrdCl::AsyncRawReaderIntfc::chlen

protected

Definition at line 165 of file XrdClAsyncRawReaderIntfc.hh.

Referenced by XrdCl::AsyncRawReader::Read(), and XrdCl::AsyncVectorReader::Read().

choff

size_t XrdCl::AsyncRawReaderIntfc::choff

protected

Definition at line 164 of file XrdClAsyncRawReaderIntfc.hh.

Referenced by XrdCl::AsyncRawReader::Read(), and XrdCl::AsyncVectorReader::Read().

chstatus

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

protected

Definition at line 158 of file XrdClAsyncRawReaderIntfc.hh.

Referenced by XrdCl::AsyncVectorReader::GetResponse(), XrdCl::AsyncVectorReader::Read(), and SetChunkList().

chunks

ChunkList* XrdCl::AsyncRawReaderIntfc::chunks

protected

Definition at line 157 of file XrdClAsyncRawReaderIntfc.hh.

Referenced by XrdCl::AsyncVectorReader::GetResponse(), XrdCl::AsyncRawReader::Read(), XrdCl::AsyncVectorReader::Read(), and SetChunkList().

dataerr

bool XrdCl::AsyncRawReaderIntfc::dataerr

protected

Definition at line 168 of file XrdClAsyncRawReaderIntfc.hh.

Referenced by XrdCl::AsyncRawReader::GetResponse().

discardbuff

buffer_t XrdCl::AsyncRawReaderIntfc::discardbuff

protected

Definition at line 167 of file XrdClAsyncRawReaderIntfc.hh.

dlen

uint32_t XrdCl::AsyncRawReaderIntfc::dlen

protected

Definition at line 159 of file XrdClAsyncRawReaderIntfc.hh.

Referenced by XrdCl::AsyncRawReader::Read(), XrdCl::AsyncVectorReader::Read(), and SetDataLength().

msgbtsrd

uint32_t XrdCl::AsyncRawReaderIntfc::msgbtsrd

protected

Definition at line 160 of file XrdClAsyncRawReaderIntfc.hh.

Referenced by XrdCl::AsyncRawReader::Read(), and XrdCl::AsyncVectorReader::Read().

rawbtsrd

uint32_t XrdCl::AsyncRawReaderIntfc::rawbtsrd

protected

Definition at line 161 of file XrdClAsyncRawReaderIntfc.hh.

Referenced by XrdCl::AsyncVectorReader::GetResponse(), XrdCl::AsyncRawReader::Read(), and XrdCl::AsyncVectorReader::Read().

readstage

Stage XrdCl::AsyncRawReaderIntfc::readstage

protected

Definition at line 149 of file XrdClAsyncRawReaderIntfc.hh.

Referenced by XrdCl::AsyncRawReader::Read(), XrdCl::AsyncVectorReader::Read(), and SetDataLength().

request

const Message& XrdCl::AsyncRawReaderIntfc::request

protected

Definition at line 155 of file XrdClAsyncRawReaderIntfc.hh.

Referenced by XrdCl::AsyncRawReader::GetResponse(), XrdCl::AsyncDiscardReader::Read(), and XrdCl::AsyncRawReader::Read().

url

const URL& XrdCl::AsyncRawReaderIntfc::url

protected

Definition at line 154 of file XrdClAsyncRawReaderIntfc.hh.

Referenced by XrdCl::AsyncDiscardReader::Read(), XrdCl::AsyncRawReader::Read(), and XrdCl::AsyncVectorReader::Read().

---

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

• XrdClAsyncRawReaderIntfc.hh