XrdCl::AsyncMsgReader Class Reference

Utility class encapsulating reading response message logic. More...

#include <XrdClAsyncMsgReader.hh>

Collaboration diagram for XrdCl::AsyncMsgReader:

Public Member Functions
	AsyncMsgReader (TransportHandler &xrdTransport, Socket &socket, const std::string &strmname, Stream &strm, uint16_t substrmnb)
virtual	~AsyncMsgReader ()
	Destructor.
void	Reset ()
	Reset the state of the object (makes it ready to read out next msg)
XRootDStatus	Read ()
	Read out the response from the socket.

Private Types
enum	Stage {   ReadStart , ReadHeader , ReadAttn , ReadMore ,   ReadMsgBody , ReadRawData , ReadDone }
	Stages of reading out a response from the socket. More...

Private Member Functions
XRootDStatus	ReadAttnActnum ()
bool	IsStatusRsp ()
bool	HasEmbeddedRsp ()

Private Attributes
Stage	readstage
TransportHandler &	xrdTransport
Socket &	socket
const std::string &	strmname
Stream &	strm
uint16_t	substrmnb
std::shared_ptr< Message >	inmsg
uint32_t	inmsgsize
MsgHandler *	inhandler

Detailed Description

Utility class encapsulating reading response message logic.

Member Enumeration Documentation

Stage

enum XrdCl::AsyncMsgReader::Stage

private

Stages of reading out a response from the socket.

Enumerator
ReadStart
ReadHeader
ReadAttn
ReadMore
ReadMsgBody
ReadRawData
ReadDone

Constructor & Destructor Documentation

AsyncMsgReader()

XrdCl::AsyncMsgReader::AsyncMsgReader ( TransportHandler &  xrdTransport, Socket &  socket, const std::string &  strmname, Stream &  strm, uint16_t  substrmnb  )

inline

Constructor

Parameters

xrdTransport	: the (xrootd) transport layer
socket	: the socket with the message to be read out
strmname	: stream name
strm	: the stream encapsulating the connection
substrmnb	: the substream number

~AsyncMsgReader()

virtual XrdCl::AsyncMsgReader::~AsyncMsgReader ( )

inlinevirtual

Destructor.

Member Function Documentation

HasEmbeddedRsp()

bool XrdCl::AsyncMsgReader::HasEmbeddedRsp ( )

inlineprivate

References ServerResponseBody_Attn::actnum, inmsg, and kXR_asynresp.

Referenced by Read().

IsStatusRsp()

bool XrdCl::AsyncMsgReader::IsStatusRsp ( )

inlineprivate

References inmsg, kXR_status, and ServerResponseHeader::status.

Referenced by Read().

Read()

XRootDStatus XrdCl::AsyncMsgReader::Read ( )

inline

Read out the response from the socket.

References XrdCl::AsyncSockMsg, XrdCl::Status::code, XrdCl::MsgHandler::Corrupted, XrdCl::Log::Dump(), XrdCl::errCorruptedHeader, XrdCl::TransportHandler::GetBody(), XrdCl::TransportHandler::GetHeader(), XrdCl::DefaultEnv::GetLog(), XrdCl::TransportHandler::GetMore(), HasEmbeddedRsp(), ServerResponse::hdr, inhandler, inmsg, inmsgsize, XrdCl::Stream::InspectStatusRsp(), XrdCl::Stream::InstallIncHandler(), XrdCl::Status::IsOK(), IsStatusRsp(), kXR_attn, XrdCl::MsgHandler::More, XrdCl::Stream::OnIncoming(), XrdCl::MsgHandler::Raw, ReadAttn, ReadAttnActnum(), ReadDone, ReadHeader, XrdCl::MsgHandler::ReadMessageBody(), ReadMore, ReadMsgBody, ReadRawData, readstage, ReadStart, socket, ServerResponseHeader::status, XrdCl::stError, strm, strmname, substrmnb, XrdCl::suRetry, and xrdTransport.

ReadAttnActnum()

XRootDStatus XrdCl::AsyncMsgReader::ReadAttnActnum ( )

inlineprivate

References ServerResponseBody_Attn::actnum, XrdCl::Status::code, inmsg, XrdCl::Status::IsOK(), XrdCl::Socket::Read(), socket, and XrdCl::suRetry.

Referenced by Read().

Reset()

void XrdCl::AsyncMsgReader::Reset ( )

inline

Reset the state of the object (makes it ready to read out next msg)

References inhandler, inmsg, inmsgsize, readstage, and ReadStart.

Member Data Documentation

inhandler

MsgHandler* XrdCl::AsyncMsgReader::inhandler

private

Referenced by Read(), and Reset().

inmsg

std::shared_ptr<Message> XrdCl::AsyncMsgReader::inmsg

private

Referenced by HasEmbeddedRsp(), IsStatusRsp(), Read(), ReadAttnActnum(), and Reset().

inmsgsize

uint32_t XrdCl::AsyncMsgReader::inmsgsize

private

Referenced by Read(), and Reset().

readstage

Stage XrdCl::AsyncMsgReader::readstage

private

Referenced by Read(), and Reset().

socket

Socket& XrdCl::AsyncMsgReader::socket

private

Referenced by Read(), and ReadAttnActnum().

strm

Stream& XrdCl::AsyncMsgReader::strm

private

Referenced by Read().

strmname

const std::string& XrdCl::AsyncMsgReader::strmname

private

Referenced by Read().

substrmnb

uint16_t XrdCl::AsyncMsgReader::substrmnb

private

Referenced by Read().

xrdTransport

TransportHandler& XrdCl::AsyncMsgReader::xrdTransport

private

Referenced by Read().

---

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

• XrdClAsyncMsgReader.hh