Handle/Process/Forward XRootD messages. More...

#include <XrdClXRootDMsgHandler.hh>

Inheritance diagram for XrdCl::XRootDMsgHandler:

Collaboration diagram for XrdCl::XRootDMsgHandler:

Public Member Functions
	XRootDMsgHandler (Message msg, ResponseHandler respHandler, const URL url, SIDManager sidMgr)

	~XRootDMsgHandler ()
	Destructor. More...

virtual uint8_t	OnIncoming (Message *msg)

virtual uint8_t	OnStreamEvent (StreamEvent event, uint16_t streamNum, Status status)

virtual void	OnStatusReady (const Message *message, Status status)
	The requested action has been performed and the status is available. More...

void	WaitDone (time_t now)

void	SetExpiration (time_t expiration)
	Set a timestamp after which we give up. More...

void	SetRedirectAsAnswer (bool redirectAsAnswer)

const Message *	GetRequest () const
	Get the request pointer. More...

void	SetLoadBalancer (const HostInfo &loadBalancer)
	Set the load balancer. More...

void	SetHostList (HostList *hostList)
	Set host list. More...

void	SetChunkList (ChunkList *chunkList)
	Set the chunk list. More...

void	SetRedirectCounter (uint16_t redirectCounter)
	Set the redirect coutner. More...

Public Member Functions inherited from XrdCl::IncomingMsgHandler
virtual	~IncomingMsgHandler ()
	Event types that the message handler may receive. More...

Public Member Functions inherited from XrdCl::OutgoingMsgHandler
virtual	~OutgoingMsgHandler ()

virtual void	OnReadyToSend (Message *msg, uint16_t streamNum)

Private Member Functions
void	HandleError (Status status, Message *msg=0)
	Recover error. More...

Status	RetryAtServer (const URL &url)
	Retry the request at another server. More...

void	HandleResponse ()
	Unpack the message and call the response handler. More...

XRootDStatus *	ProcessStatus ()
	Extract the status information from the stuff that we got. More...

Status	ParseResponse (AnyObject *&response)

Status	RewriteRequestRedirect (const URL::ParamsMap &newCgi)

Status	RewriteRequestWait ()
	Some requests need to be rewriten also after getting kXR_wait - sigh. More...

Status	UnpackVectorRead (VectorReadInfo vReadInfo, ChunkList list, char *sourceBuffer, uint32_t sourceBufferSize)
	Unpack vector read. More...

void	UpdateTriedCGI ()
	Update the "tried=" part of the CGI of the current message. More...

void	SwitchOnRefreshFlag ()
	Switch on the refresh flag for some requests. More...

Private Attributes
Message *	pRequest

Message *	pResponse

std::vector< Message * >	pPartialResps

ResponseHandler *	pResponseHandler

URL	pUrl

PostMaster *	pPostMaster

SIDManager *	pSidMgr

Status	pStatus

time_t	pExpiration

bool	pRedirectAsAnswer

HostList *	pHosts

bool	pHasLoadBalancer

HostInfo	pLoadBalancer

bool	pHasSessionId

std::string	pRedirectCgi

ChunkList *	pChunkList

uint16_t	pRedirectCounter

Additional Inherited Members
Public Types inherited from XrdCl::IncomingMsgHandler
enum	Action { Take = 0x01, Ignore = 0x02, RemoveHandler = 0x04 }
	Actions to be taken after a message is processed by the handler. More...

enum	StreamEvent { Ready = 1, Broken = 2, Timeout = 3, FatalError = 4 }
	Events that may have occured to the stream. More...

Detailed Description

Handle/Process/Forward XRootD messages.

Constructor & Destructor Documentation

XrdCl::XRootDMsgHandler::XRootDMsgHandler	(	Message *	msg,
		ResponseHandler *	respHandler,
		const URL *	url,
		SIDManager *	sidMgr
	)

inline

Constructor

Parameters

msg	message that has been sent out
respHandler	response handler to be called then the final final response arrives
url	the url the message has been sent to
sidMgr	the sid manager used to allocate SID for the initial message

References XrdCl::DefaultEnv::GetPostMaster(), XrdCl::Message::GetSessionId(), pHasSessionId, and pPostMaster.

XrdCl::XRootDMsgHandler::~XRootDMsgHandler ( )

inline

Destructor.

References pHasSessionId, pPartialResps, pRequest, and pResponse.

Member Function Documentation

const Message* XrdCl::XRootDMsgHandler::GetRequest ( ) const

inline

Get the request pointer.

References pRequest.

void XrdCl::XRootDMsgHandler::HandleError	(	Status	status,
		Message *	msg = `0`
	)

private

void XrdCl::XRootDMsgHandler::HandleResponse ( )

private

Unpack the message and call the response handler.

References XrdCl::Status::code, XrdCl::errOperationExpired, XrdCl::Buffer::GetBuffer(), XrdCl::ResponseHandler::HandleResponseWithHosts(), ClientRequest::header, XrdCl::Status::IsOK(), ParseResponse(), pHosts, pRequest, pResponseHandler, ProcessStatus(), pSidMgr, XrdCl::SIDManager::ReleaseSID(), ClientRequestHdr::streamid, XrdCl::SIDManager::TimeOutSID(), and XrdCl::XRootDTransport::UnMarshallRequest().

Referenced by HandleError(), and OnIncoming().

uint8_t XrdCl::XRootDMsgHandler::OnIncoming ( Message * msg )

virtual

Examine an incomming message, and decide on the action to be taken

Parameters

msg	the message, may be zero if receive failed

Returns: action type that needs to be take wrt the message and the handler

Implements XrdCl::IncomingMsgHandler.

void XrdCl::XRootDMsgHandler::OnStatusReady	(	const Message *	message,
		Status	status
	)

virtual

The requested action has been performed and the status is available.

Implements XrdCl::OutgoingMsgHandler.

References XrdCl::Log::Dump(), XrdCl::Log::Error(), XrdCl::Message::GetDescription(), XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), HandleError(), XrdCl::Status::IsOK(), pExpiration, pPostMaster, pUrl, XrdCl::PostMaster::Receive(), and XrdCl::XRootDMsg.

uint8_t XrdCl::XRootDMsgHandler::OnStreamEvent	(	StreamEvent	event,
		uint16_t	streamNum,
		Status	status
	)

virtual

Handle an event other that a message arrival

Parameters

event	type of the event
streamNum	stream concerned
status	status info

Reimplemented from XrdCl::IncomingMsgHandler.

References XrdCl::Log::Dump(), XrdCl::Message::GetDescription(), XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), HandleError(), pRequest, pUrl, XrdCl::IncomingMsgHandler::Ready, XrdCl::IncomingMsgHandler::RemoveHandler, and XrdCl::XRootDMsg.

Status XrdCl::XRootDMsgHandler::ParseResponse ( AnyObject *& response )

private

Parse the response and put it in an object that could be passed to the user

References XrdCl::Buffer::Allocate(), XrdCl::Buffer::Append(), ServerResponse::body, ServerResponse::buffer, XrdCl::ChunkInfo::buffer, ServerResponseBody_Buffer::data, ClientRequest::dirlist, ClientDirlistRequest::dlen, ClientOpenRequest::dlen, ServerResponseHeader::dlen, XrdCl::Log::Dump(), XrdCl::errInvalidMessage, XrdCl::errInvalidResponse, XrdCl::Log::Error(), ServerResponseBody_Protocol::flags, XrdCl::Buffer::GetBuffer(), XrdCl::Message::GetDescription(), XrdCl::URL::GetHostId(), XrdCl::URL::GetHostName(), XrdCl::DefaultEnv::GetLog(), XrdCl::URL::GetPort(), XrdCl::Message::GetSessionId(), ServerResponse::hdr, ClientRequest::header, XrdCl::Status::IsOK(), kXR_chmod, kXR_close, kXR_dirlist, kXR_locate, kXR_mkdir, kXR_mv, kXR_ok, kXR_open, kXR_ping, kXR_prepare, kXR_protocol, kXR_query, kXR_read, kXR_readv, kXR_redirect, kXR_retstat, kXR_rm, kXR_rmdir, kXR_set, kXR_stat, kXR_sync, kXR_truncate, kXR_vfs, kXR_write, XrdCl::ChunkInfo::length, XrdCl::ChunkInfo::offset, ClientRequest::open, ClientOpenRequest::options, ClientStatRequest::options, pChunkList, pPartialResps, pRedirectAsAnswer, pRedirectCgi, pRequest, pResponse, ServerResponse::protocol, pUrl, ServerResponseBody_Protocol::pval, ClientRequestHdr::requestid, XrdCl::AnyObject::Set(), ClientRequest::stat, ServerResponseHeader::status, XrdCl::stError, UnpackVectorRead(), and XrdCl::XRootDMsg.

Referenced by HandleResponse().

XRootDStatus * XrdCl::XRootDMsgHandler::ProcessStatus ( )

private

Extract the status information from the stuff that we got.

References ServerResponse::body, XrdCl::Status::code, XrdCl::errErrorResponse, ServerResponseBody_Error::errmsg, XrdCl::Status::errNo, ServerResponseBody_Error::errnum, ServerResponse::error, XrdCl::Buffer::GetBuffer(), XrdCl::Status::IsOK(), pResponse, pStatus, and XrdCl::XRootDStatus::SetErrorMessage().

Referenced by HandleResponse().

Status XrdCl::XRootDMsgHandler::RetryAtServer ( const URL & url )

private

Retry the request at another server.

References pExpiration, pHosts, pPostMaster, pRequest, pUrl, and XrdCl::PostMaster::Send().

Referenced by HandleError(), OnIncoming(), and WaitDone().

Status XrdCl::XRootDMsgHandler::RewriteRequestRedirect ( const URL::ParamsMap & newCgi )

private

Perform the changes to the original request needed by the redirect procedure - allocate new streamid, append redirection data and such

References XrdCl::SIDManager::AllocateSID(), XrdCl::MessageUtils::AppendCGI(), XrdCl::Log::Error(), XrdCl::AnyObject::Get(), XrdCl::Buffer::GetBuffer(), XrdCl::Message::GetDescription(), XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), ClientRequest::header, XrdCl::Status::IsOK(), XrdCl::XRootDTransport::MarshallRequest(), pPostMaster, pRequest, pSidMgr, pUrl, XrdCl::PostMaster::QueryTransport(), XrdCl::SIDManager::ReleaseSID(), XrdCl::XRootDQuery::SIDManager, ClientRequestHdr::streamid, XrdCl::XRootDTransport::UnMarshallRequest(), and XrdCl::XRootDMsg.

Referenced by OnIncoming().

Status XrdCl::XRootDMsgHandler::RewriteRequestWait ( )

private

Some requests need to be rewriten also after getting kXR_wait - sigh.

References XrdCl::Buffer::GetBuffer(), ClientRequest::header, kXR_locate, kXR_open, kXR_refresh, ClientRequest::locate, XrdCl::XRootDTransport::MarshallRequest(), ClientLocateRequest::options, pRequest, ClientRequestHdr::requestid, XrdCl::XRootDTransport::SetDescription(), and XrdCl::XRootDTransport::UnMarshallRequest().

Referenced by OnIncoming().

void XrdCl::XRootDMsgHandler::SetChunkList ( ChunkList * chunkList )

inline

Set the chunk list.

References pChunkList.

Referenced by XrdCl::MessageUtils::SendMessage().

void XrdCl::XRootDMsgHandler::SetExpiration ( time_t expiration )

inline

Set a timestamp after which we give up.

References pExpiration.

Referenced by XrdCl::MessageUtils::SendMessage().

void XrdCl::XRootDMsgHandler::SetHostList ( HostList * hostList )

inline

Set host list.

References pHosts.

Referenced by XrdCl::MessageUtils::SendMessage().

void XrdCl::XRootDMsgHandler::SetLoadBalancer ( const HostInfo & loadBalancer )

inline

Set the load balancer.

References XrdCl::URL::IsValid(), pHasLoadBalancer, pLoadBalancer, and XrdCl::HostInfo::url.

Referenced by XrdCl::MessageUtils::SendMessage().

void XrdCl::XRootDMsgHandler::SetRedirectAsAnswer ( bool redirectAsAnswer )

inline

Treat the kXR_redirect response as a valid answer to the message and notify the handler with the URL as a response

References pRedirectAsAnswer.

Referenced by XrdCl::MessageUtils::SendMessage().

void XrdCl::XRootDMsgHandler::SetRedirectCounter ( uint16_t redirectCounter )

inline

Set the redirect coutner.

References pRedirectCounter.

Referenced by XrdCl::MessageUtils::SendMessage().

void XrdCl::XRootDMsgHandler::SwitchOnRefreshFlag ( )

private

Switch on the refresh flag for some requests.

References XrdCl::Buffer::GetBuffer(), ClientRequest::header, kXR_locate, kXR_open, kXR_refresh, ClientRequest::locate, XrdCl::XRootDTransport::MarshallRequest(), ClientLocateRequest::options, pRequest, ClientRequestHdr::requestid, XrdCl::XRootDTransport::SetDescription(), and XrdCl::XRootDTransport::UnMarshallRequest().

Referenced by HandleError().

Status XrdCl::XRootDMsgHandler::UnpackVectorRead	(	VectorReadInfo *	vReadInfo,
		ChunkList *	list,
		char *	sourceBuffer,
		uint32_t	sourceBufferSize
	)

private

Unpack vector read.

References XrdCl::errInvalidResponse, XrdCl::Log::Error(), XrdCl::VectorReadInfo::GetChunks(), XrdCl::Message::GetDescription(), XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), readahead_list::offset, pRequest, pUrl, readahead_list::rlen, XrdCl::VectorReadInfo::SetSize(), XrdCl::stFatal, and XrdCl::XRootDMsg.

Referenced by ParseResponse().

void XrdCl::XRootDMsgHandler::UpdateTriedCGI ( )

private

Update the "tried=" part of the CGI of the current message.

References XrdCl::MessageUtils::AppendCGI(), XrdCl::URL::GetHostName(), XrdCl::XRootDTransport::MarshallRequest(), pRequest, pUrl, and XrdCl::XRootDTransport::UnMarshallRequest().

Referenced by HandleError().

void XrdCl::XRootDMsgHandler::WaitDone ( time_t now )

Called after the wait time for kXR_wait has elapsed

Parameters

now	current timestamp

References HandleError(), pUrl, and RetryAtServer().

Member Data Documentation

ChunkList* XrdCl::XRootDMsgHandler::pChunkList

private

Referenced by ParseResponse(), and SetChunkList().

time_t XrdCl::XRootDMsgHandler::pExpiration

private

Referenced by HandleError(), OnStatusReady(), RetryAtServer(), and SetExpiration().

bool XrdCl::XRootDMsgHandler::pHasLoadBalancer

private

Referenced by OnIncoming(), and SetLoadBalancer().

bool XrdCl::XRootDMsgHandler::pHasSessionId

private

Referenced by XRootDMsgHandler(), and ~XRootDMsgHandler().

HostList* XrdCl::XRootDMsgHandler::pHosts

private

Referenced by HandleResponse(), OnIncoming(), RetryAtServer(), and SetHostList().

HostInfo XrdCl::XRootDMsgHandler::pLoadBalancer

private

Referenced by HandleError(), OnIncoming(), and SetLoadBalancer().

std::vector<Message *> XrdCl::XRootDMsgHandler::pPartialResps

private

Referenced by OnIncoming(), ParseResponse(), and ~XRootDMsgHandler().

PostMaster* XrdCl::XRootDMsgHandler::pPostMaster

private

Referenced by OnIncoming(), OnStatusReady(), RetryAtServer(), RewriteRequestRedirect(), and XRootDMsgHandler().

bool XrdCl::XRootDMsgHandler::pRedirectAsAnswer

private

Referenced by OnIncoming(), ParseResponse(), and SetRedirectAsAnswer().

std::string XrdCl::XRootDMsgHandler::pRedirectCgi

private

Referenced by OnIncoming(), and ParseResponse().

uint16_t XrdCl::XRootDMsgHandler::pRedirectCounter

private

Referenced by OnIncoming(), and SetRedirectCounter().

Message* XrdCl::XRootDMsgHandler::pRequest

private

Referenced by GetRequest(), HandleError(), HandleResponse(), OnIncoming(), OnStreamEvent(), ParseResponse(), RetryAtServer(), RewriteRequestRedirect(), RewriteRequestWait(), SwitchOnRefreshFlag(), UnpackVectorRead(), UpdateTriedCGI(), and ~XRootDMsgHandler().

Message* XrdCl::XRootDMsgHandler::pResponse

private

Referenced by HandleError(), OnIncoming(), ParseResponse(), ProcessStatus(), and ~XRootDMsgHandler().

ResponseHandler* XrdCl::XRootDMsgHandler::pResponseHandler

private

Referenced by HandleResponse().

SIDManager* XrdCl::XRootDMsgHandler::pSidMgr

private

Referenced by HandleResponse(), and RewriteRequestRedirect().

Status XrdCl::XRootDMsgHandler::pStatus

private

Referenced by HandleError(), OnIncoming(), and ProcessStatus().

URL XrdCl::XRootDMsgHandler::pUrl

private

Referenced by HandleError(), OnIncoming(), OnStatusReady(), OnStreamEvent(), ParseResponse(), RetryAtServer(), RewriteRequestRedirect(), UnpackVectorRead(), UpdateTriedCGI(), and WaitDone().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation