XrdCl::MessageUtils Class Reference

#include <XrdClMessageUtils.hh>

List of all members.

Static Public Member Functions
static XRootDStatus	WaitForStatus (SyncResponseHandler *handler)
	Wait and return the status of the query.
template<class Type >
static XrdCl::XRootDStatus	WaitForResponse (SyncResponseHandler *handler, Type *&response)
	Wait for the response.
template<class Type >
static void	CreateRequest (Message *&msg, Type *&req, uint32_t payloadSize=0)
	Create a message.
static Status	SendMessage (const URL &url, Message *msg, ResponseHandler *handler, const MessageSendParams &sendParams)
	Send message.
static void	ProcessSendParams (MessageSendParams &sendParams)
	Process sending params.
static void	AppendCGI (Message *msg, const URL::ParamsMap &newCgi, bool replace)
	Append cgi to the one already present in the message.
static void	MergeCGI (URL::ParamsMap &cgi1, const URL::ParamsMap &cgi2, bool replace)
	Merge cgi2 into cgi1.

---

Member Function Documentation

void XrdCl::MessageUtils::AppendCGI ( Message *  msg, const URL::ParamsMap &  newCgi, bool  replace  )

static

Append cgi to the one already present in the message.

Append cgi to the on already present in the message

Parameters:

msg	message concerned
newCgi	the new cgi
replace	indicates whether, in case of a conflict, the new CGI parameter should replace an existing one or be appended to it using a comma

References ClientRequestHdr::dlen, XrdCl::Buffer::GetBuffer(), XrdCl::URL::GetParams(), ClientRequest::header, kXR_chmod, kXR_mkdir, kXR_mv, kXR_open, kXR_rm, kXR_rmdir, kXR_stat, kXR_truncate, MergeCGI(), XrdCl::Buffer::ReAllocate(), ClientRequestHdr::requestid, and XrdCl::XRootDTransport::SetDescription().

template<class Type >

static void XrdCl::MessageUtils::CreateRequest ( Message *&  msg, Type *&  req, uint32_t  payloadSize = 0  )

inlinestatic

Create a message.

References XrdCl::Buffer::GetBuffer(), and XrdCl::Buffer::Zero().

Referenced by XrdCl::FileSystem::ChMod(), XrdCl::FileStateHandler::Close(), XrdCl::FileSystem::DirList(), XrdCl::FileSystem::Locate(), XrdCl::FileSystem::MkDir(), XrdCl::FileSystem::Mv(), XrdCl::FileStateHandler::Open(), XrdCl::FileSystem::Ping(), XrdCl::FileSystem::Prepare(), XrdCl::FileSystem::Protocol(), XrdCl::FileSystem::Query(), XrdCl::FileStateHandler::Read(), XrdCl::FileStateHandler::ReOpenFileAtServer(), XrdCl::FileSystem::Rm(), XrdCl::FileSystem::RmDir(), XrdCl::FileSystem::SendInfo(), XrdCl::FileStateHandler::Stat(), XrdCl::FileSystem::Stat(), XrdCl::FileSystem::StatVFS(), XrdCl::FileStateHandler::Sync(), XrdCl::FileStateHandler::Truncate(), XrdCl::FileSystem::Truncate(), XrdCl::FileStateHandler::VectorRead(), and XrdCl::FileStateHandler::Write().

void XrdCl::MessageUtils::MergeCGI ( URL::ParamsMap &  cgi1, const URL::ParamsMap &  cgi2, bool  replace  )

static

Merge cgi2 into cgi1.

Merge cgi2 into cgi1

Parameters:

cgi1	cgi to be merged into
cgi2	cgi to be merged in
replace	indicates whether, in case of a conflict, the new CGI parameter should replace an existing one or be appended to it using a comma

Referenced by AppendCGI(), XrdCl::FileStateHandler::OnOpen(), XrdCl::FileStateHandler::OnStateRedirection(), and XrdCl::ThirdPartyCopyJob::Run().

void XrdCl::MessageUtils::ProcessSendParams ( MessageSendParams &  sendParams )

static

Process sending params.

References XrdCl::DefaultRedirectLimit, XrdCl::DefaultRequestTimeout, XrdCl::MessageSendParams::expires, XrdCl::DefaultEnv::GetEnv(), XrdCl::Env::GetInt(), XrdCl::MessageSendParams::redirectLimit, and XrdCl::MessageSendParams::timeout.

Referenced by XrdCl::FileSystem::ChMod(), XrdCl::FileStateHandler::Close(), XrdCl::FileSystem::DirList(), XrdCl::FileSystem::Locate(), XrdCl::FileSystem::MkDir(), XrdCl::FileSystem::Mv(), XrdCl::FileStateHandler::Open(), XrdCl::FileSystem::Ping(), XrdCl::FileSystem::Prepare(), XrdCl::FileSystem::Protocol(), XrdCl::FileSystem::Query(), XrdCl::FileStateHandler::Read(), XrdCl::FileStateHandler::ReOpenFileAtServer(), XrdCl::FileSystem::Rm(), XrdCl::FileSystem::RmDir(), XrdCl::FileSystem::SendInfo(), XrdCl::FileStateHandler::Stat(), XrdCl::FileSystem::Stat(), XrdCl::FileSystem::StatVFS(), XrdCl::FileStateHandler::Sync(), XrdCl::FileStateHandler::Truncate(), XrdCl::FileSystem::Truncate(), XrdCl::FileStateHandler::VectorRead(), and XrdCl::FileStateHandler::Write().

Status XrdCl::MessageUtils::SendMessage ( const URL &  url, Message *  msg, ResponseHandler *  handler, const MessageSendParams &  sendParams  )

static

Send message.

References XrdCl::SIDManager::AllocateSID(), XrdCl::MessageSendParams::chunkList, XrdCl::Log::Dump(), XrdCl::Log::Error(), XrdCl::errUninitialized, XrdCl::MessageSendParams::expires, XrdCl::MessageSendParams::followRedirects, XrdCl::AnyObject::Get(), XrdCl::Buffer::GetBuffer(), XrdCl::Message::GetDescription(), XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), XrdCl::DefaultEnv::GetPostMaster(), XrdCl::MessageSendParams::hostList, XrdCl::Status::IsOK(), XrdCl::URL::IsValid(), XrdCl::MessageSendParams::loadBalancer, XrdCl::XRootDTransport::MarshallRequest(), XrdCl::PostMaster::QueryTransport(), XrdCl::MessageSendParams::redirectLimit, XrdCl::PostMaster::Send(), XrdCl::XRootDMsgHandler::SetChunkList(), XrdCl::XRootDMsgHandler::SetExpiration(), XrdCl::XRootDMsgHandler::SetHostList(), XrdCl::XRootDMsgHandler::SetLoadBalancer(), XrdCl::XRootDMsgHandler::SetRedirectAsAnswer(), XrdCl::XRootDMsgHandler::SetRedirectCounter(), XrdCl::XRootDQuery::SIDManager, XrdCl::MessageSendParams::stateful, XrdCl::stError, ClientRequestHdr::streamid, XrdCl::Status::ToString(), XrdCl::XRootDTransport::UnMarshallRequest(), XrdCl::HostInfo::url, and XrdCl::XRootDMsg.

Referenced by XrdCl::FileStateHandler::Close(), XrdCl::FileStateHandler::Open(), XrdCl::FileStateHandler::ReOpenFileAtServer(), XrdCl::FileStateHandler::ReSendQueuedMessages(), XrdCl::FileSystem::Send(), and XrdCl::FileStateHandler::SendOrQueue().

template<class Type >

static XrdCl::XRootDStatus XrdCl::MessageUtils::WaitForResponse ( SyncResponseHandler *  handler, Type *&  response  )

inlinestatic

Wait for the response.

References XrdCl::errInternal, XrdCl::SyncResponseHandler::GetResponse(), XrdCl::SyncResponseHandler::GetStatus(), XrdCl::Status::IsOK(), XrdCl::stError, and XrdCl::SyncResponseHandler::WaitForResponse().

Referenced by XrdCl::FileSystem::DeepLocate(), XrdCl::FileSystem::DirList(), XrdCl::FileSystem::Locate(), XrdCl::FileSystem::Prepare(), XrdCl::FileSystem::Protocol(), XrdCl::FileSystem::Query(), XrdCl::File::Read(), XrdCl::FileSystem::SendInfo(), XrdCl::File::Stat(), XrdCl::FileSystem::Stat(), XrdCl::FileSystem::StatVFS(), and XrdCl::File::VectorRead().

static XRootDStatus XrdCl::MessageUtils::WaitForStatus ( SyncResponseHandler *  handler )

inlinestatic

Wait and return the status of the query.

References XrdCl::SyncResponseHandler::GetStatus(), and XrdCl::SyncResponseHandler::WaitForResponse().

Referenced by XrdCl::FileSystem::ChMod(), XrdCl::File::Close(), XrdCl::FileSystem::MkDir(), XrdCl::FileSystem::Mv(), XrdCl::File::Open(), XrdCl::FileSystem::Ping(), XrdCl::FileSystem::Rm(), XrdCl::FileSystem::RmDir(), XrdCl::File::Sync(), XrdCl::File::Truncate(), XrdCl::FileSystem::Truncate(), and XrdCl::File::Write().

---

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

• XrdClMessageUtils.hh
• XrdClMessageUtils.cc