XrdCl Namespace Reference

Classes
class	AnyObject
class	ArgBase
	Base class for Arg. More...
class	Arg
class	Arg< std::string >
class	AsyncSocketHandler
class	Buffer
	Binary blob representation. More...
class	Channel
	A communication channel between the client and the server. More...
class	ChannelHandlerList
	A helper for handling channel event handlers. More...
class	CheckSumManager
	Manage the checksum calc objects. More...
class	ClassicCopyJob
class	CopyJob
	Copy job. More...
class	CopyProgressHandler
	Interface for copy progress notification. More...
class	CopyProcess
	Copy the data from one point to another. More...
class	DefaultEnv
class	DlgEnv
class	Env
class	File
	A file. More...
class	FileOperation
class	OpenImpl
	Open operation (. More...
class	ReadImpl
	Read operation (. More...
class	CloseImpl
	Close operation (. More...
class	StatImpl
	Stat operation (. More...
class	WriteImpl
	Write operation (. More...
class	SyncImpl
	Sync operation (. More...
class	TruncateImpl
	Truncate operation (. More...
class	VectorReadImpl
	VectorRead operation (. More...
class	VectorWriteImpl
	VectorWrite operation (. More...
class	WriteVImpl
	WriteV operation (. More...
class	FcntlImpl
	Fcntl operation (. More...
class	VisaImpl
	Visa operation (. More...
class	FileStateHandler
	Handle the stateful operations. More...
struct	QueryCode
	XRootD query request codes. More...
struct	OpenFlags
	Open flags, may be or'd when appropriate. More...
struct	Access
	Access mode. More...
struct	MkDirFlags
	MkDir flags. More...
struct	DirListFlags
	DirList flags. More...
struct	PrepareFlags
	Prepare flags. More...
class	FileSystem
	Send file/filesystem queries to an XRootD cluster. More...
class	FileSystemOperation
class	LocateImpl
	Locate operation (. More...
class	DeepLocateImpl
	DeepLocate operation (. More...
class	MvImpl
	Mv operation (. More...
class	QueryImpl
	Query operation (. More...
class	TruncateFsImpl
	Truncate operation (. More...
class	RmImpl
	Rm operation (. More...
class	MkDirImpl
	MkDir operation (. More...
class	RmDirImpl
	RmDir operation (. More...
class	ChModImpl
	ChMod operation (. More...
class	PingImpl
	Ping operation (. More...
class	StatFsImpl
	Stat operation (. More...
class	StatVFSImpl
	StatVS operation (. More...
class	ProtocolImpl
	Protocol operation (. More...
class	DirListImpl
	DirList operation (. More...
class	SendInfoImpl
	SendInfo operation (. More...
class	PrepareImpl
	Prepare operation (. More...
class	FileSystemUtils
class	FileTimer
	Task generating timeout events for FileStateHandlers in recovery mode. More...
class	ForkHandler
class	FSExecutor
	Execute queries given as a commandline. More...
struct	FwdStorage
class	Fwd
class	InQueue
	A synchronize queue for incoming data. More...
class	Job
	Interface for a job to be run by the job manager. More...
class	JobManager
	A synchronized queue. More...
class	LocalFileHandler
class	LocalFileTask
class	LogOut
	Interface for logger outputs. More...
class	LogOutFile
	Write log messages to a file. More...
class	LogOutCerr
	Write log messages to stderr. More...
class	Log
	Handle diagnostics. More...
class	Message
	The message representation used throughout the system. More...
class	SyncResponseHandler
	Synchronize the response. More...
class	NullResponseHandler
struct	MessageSendParams
class	MessageUtils
class	MetalinkRedirector
class	Monitor
	An abstract class to describe the client-side monitoring plugin interface. More...
struct	IsResponseHandler
struct	IsResponseHandler< Hdlr * >
class	SimpleFunctionWrapper
	Lambda wrapper. More...
class	FunctionWrapper
class	TaskWrapper
class	TaskWrapper< void, Return >
class	ExOpenFuncWrapper
	Lambda wrapper. More...
class	PipelineException
	Pipeline exception, wrapps an XRootDStatus. More...
class	FutureWrapperBase
class	FutureWrapper
class	FutureWrapper< void >
	A wrapper handler for a std::promise / std::future, overload for void type. More...
struct	RespBase
struct	Resp
struct	Resp< void >
class	PipelineHandler
class	Operation
class	Pipeline
class	ConcreteOperation
class	OutQueue
	A synchronized queue for the outgoing data. More...
class	ParallelHandler
class	ParallelOperation
class	FilePlugIn
	An interface for file plug-ins. More...
class	FileSystemPlugIn
	An interface for file plug-ins. More...
class	PlugInFactory
	Plugin factory. More...
class	PlugInManager
	Manage client-side plug-ins and match them agains URLs. More...
class	SocketHandler
	Interface. More...
class	Poller
	Interface for socket pollers. More...
class	PollerBuiltIn
	A poller implementation using the build-in XRootD poller. More...
class	PollerFactory
	Helper for creating poller objects. More...
class	PostMaster
	A hub for dispatching and receiving messages. More...
class	MessageFilter
	Message filter. More...
class	IncomingMsgHandler
	Message handler. More...
class	OutgoingMsgHandler
	Message status handler. More...
class	ChannelEventHandler
	Channel event handler. More...
struct	HandShakeData
	Data structure that carries the handshake information. More...
struct	PathID
struct	TransportQuery
class	TransportHandler
	Perform the handshake and the authentication for each physical stream. More...
class	PropertyList
	A key-value pair map storing both keys and values as strings. More...
class	RedirectJob
	A job class for redirect handling in the thread-pool. More...
class	VirtualRedirector
	An interface for metadata redirectors. More...
class	RedirectorRegistry
	Singleton access to URL to virtual redirector mapping. More...
class	RequestSync
	A helper running a fixed number of requests at a given time. More...
class	ResponseJob
	Call the user callback. More...
class	SIDManager
	Handle XRootD stream IDs. More...
class	SIDMgrPool
	Pool of SID manager objects. More...
class	Socket
	A network socket. More...
struct	Status
	Procedure execution status. More...
class	Stream
	Stream. More...
class	SyncQueue
	A synchronized queue. More...
class	Task
	Interface for a task to be run by the TaskManager. More...
class	TaskManager
class	ThirdPartyCopyJob
class	TPFallBackCopyJob
class	TransportManager
	Manage transport handler objects. More...
class	URL
	URL representation. More...
class	Utils
	Random utilities. More...
class	ScopedDescriptor
	Smart descriptor - closes the descriptor on destruction. More...
class	XCpCtx
class	XCpSrc
struct	RedirectEntry
class	XRootDMsgHandler
	Handle/Process/Forward XRootD messages. More...
class	LocationInfo
	Path location info. More...
class	XRootDStatus
	Request status. More...
class	ProtocolInfo
	Protocol response. More...
class	StatInfo
	Object stat info. More...
class	StatInfoVFS
	VFS stat info. More...
class	DirectoryList
	Directory list. More...
class	OpenInfo
	Information returned by file open operation. More...
struct	ChunkInfo
	Describe a data chunk for vector read. More...
class	VectorReadInfo
	Vector read info. More...
struct	HostInfo
class	ResponseHandler
	Handle an async response. More...
struct	XRootDQuery
	XRootD related protocol queries. More...
class	XRootDTransport
	XRootD transport handler. More...
class	ZipArchiveReader
class	ZipListHandler
Typedefs
typedef OpenImpl< false >	Open
typedef ReadImpl< false >	Read
typedef CloseImpl< false >	Close
typedef WriteImpl< false >	Write
typedef SyncImpl< false >	Sync
typedef VectorReadImpl< false >	VectorRead
typedef VectorWriteImpl< false >	VectorWrite
typedef WriteVImpl< false >	WriteV
typedef FcntlImpl< false >	Fcntl
typedef VisaImpl< false >	Visa
typedef LocateImpl< false >	Locate
typedef DeepLocateImpl< false >	DeepLocate
typedef MvImpl< false >	Mv
typedef QueryImpl< false >	Query
typedef RmImpl< false >	Rm
typedef MkDirImpl< false >	MkDir
typedef RmDirImpl< false >	RmDir
typedef ChModImpl< false >	ChMod
typedef PingImpl< false >	Ping
typedef StatVFSImpl< false >	StatVFS
typedef ProtocolImpl< false >	Protocol
typedef DirListImpl< false >	DirList
typedef SendInfoImpl< false >	SendInfo
typedef PrepareImpl< false >	Prepare
typedef XrdSysSemaphore	Semaphore
typedef Buffer	BinaryDataInfo
	Binary buffer.
typedef std::vector< ChunkInfo >	ChunkList
	List of chunks.
typedef std::vector< HostInfo >	HostList
Functions
StatImpl< false >	Stat (File *file, Arg< bool > force)
StatImpl< false >	Stat (File &file, Arg< bool > force)
TruncateImpl< false >	Truncate (File *file, Arg< uint64_t > size)
TruncateImpl< false >	Truncate (File &file, Arg< uint64_t > size)
TruncateFsImpl< false >	Truncate (FileSystem *fs, Arg< std::string > path, Arg< uint64_t > size)
TruncateFsImpl< false >	Truncate (FileSystem &fs, Arg< std::string > path, Arg< uint64_t > size)
StatFsImpl< false >	Stat (FileSystem *fs, Arg< std::string > path)
StatFsImpl< false >	Stat (FileSystem &fs, Arg< std::string > path)
std::future< XRootDStatus >	Async (Pipeline pipeline)
XRootDStatus	WaitFor (Pipeline pipeline)
template<class Container >
ParallelOperation< false >	Parallel (Container &container)
	Factory function for creating parallel operation from a vector.
void	PipesToVec (std::vector< Pipeline > &)
	Helper function for converting parameter pack into a vector.
template<typename... Others>
void	PipesToVec (std::vector< Pipeline > &v, Operation< false > &operation, Others &...others)
template<typename... Others>
void	PipesToVec (std::vector< Pipeline > &v, Operation< true > &operation, Others &...others)
template<typename... Others>
void	PipesToVec (std::vector< Pipeline > &v, Pipeline &pipeline, Others &...others)
template<typename... Operations>
ParallelOperation< false >	Parallel (Operations &&...operations)
template<>
bool	PropertyList::Get< std::string > (const std::string &name, std::string &item) const
template<>
std::string	PropertyList::Get< std::string > (const std::string &name) const
template<>
void	PropertyList::Set< std::vector< std::string > > (const std::string &name, const std::vector< std::string > &item)
template<>
bool	PropertyList::Get< std::vector< std::string > > (const std::string &name, std::vector< std::string > &item) const
Variables
const uint64_t	AppMsg = 0x0000000000000001ULL
const uint64_t	UtilityMsg = 0x0000000000000002ULL
const uint64_t	FileMsg = 0x0000000000000004ULL
const uint64_t	PollerMsg = 0x0000000000000008ULL
const uint64_t	PostMasterMsg = 0x0000000000000010ULL
const uint64_t	XRootDTransportMsg = 0x0000000000000020ULL
const uint64_t	TaskMgrMsg = 0x0000000000000040ULL
const uint64_t	XRootDMsg = 0x0000000000000080ULL
const uint64_t	FileSystemMsg = 0x0000000000000100ULL
const uint64_t	AsyncSockMsg = 0x0000000000000200ULL
const uint64_t	JobMgrMsg = 0x0000000000000400ULL
const uint64_t	PlugInMgrMsg = 0x0000000000000800ULL
const uint64_t	ExDbgMsg = 0x0000000000001000ULL
const int	DefaultSubStreamsPerChannel = 1
const int	DefaultConnectionWindow = 120
const int	DefaultConnectionRetry = 5
const int	DefaultRequestTimeout = 1800
const int	DefaultStreamTimeout = 60
const int	DefaultTimeoutResolution = 15
const int	DefaultStreamErrorWindow = 1800
const int	DefaultRunForkHandler = 0
const int	DefaultRedirectLimit = 16
const int	DefaultWorkerThreads = 3
const int	DefaultCPChunkSize = 8388608
const int	DefaultCPParallelChunks = 4
const int	DefaultDataServerTTL = 300
const int	DefaultLoadBalancerTTL = 1200
const int	DefaultCPInitTimeout = 600
const int	DefaultCPTPCTimeout = 1800
const int	DefaultTCPKeepAlive = 0
const int	DefaultTCPKeepAliveTime = 7200
const int	DefaultTCPKeepAliveInterval = 75
const int	DefaultTCPKeepAliveProbes = 9
const int	DefaultMultiProtocol = 0
const int	DefaultParallelEvtLoop = 1
const int	DefaultMetalinkProcessing = 1
const int	DefaultLocalMetalinkFile = 0
const int	DefaultXCpBlockSize = 134217728
const int	DefaultNoDelay = 1
const int	DefaultAioSignal = 0
const int	DefaultPreferIPv4 = 0
const int	DefaultMaxMetalinkWait = 60
const int	DefaultPreserveLocateTried = 1
const int	DefaultNotAuthorizedRetryLimit = 3
const int	DefaultZipMtlnCksum = 0
const char *const	DefaultPollerPreference = "built-in"
const char *const	DefaultNetworkStack = "IPAuto"
const char *const	DefaultClientMonitor = ""
const char *const	DefaultClientMonitorParam = ""
const char *const	DefaultPlugInConfDir = ""
const char *const	DefaultPlugIn = ""
const char *const	DefaultReadRecovery = "true"
const char *const	DefaultWriteRecovery = "true"
const char *const	DefaultOpenRecovery = "true"
const char *const	DefaultGlfnRedirector = ""
const uint16_t	stOK = 0x0000
	Everything went OK.
const uint16_t	stError = 0x0001
	An error occurred that could potentially be retried.
const uint16_t	stFatal = 0x0003
	Fatal error, it's still an error.
const uint16_t	suDone = 0
const uint16_t	suContinue = 1
const uint16_t	suRetry = 2
const uint16_t	suPartial = 3
const uint16_t	suAlreadyDone = 4
const uint16_t	errNone = 0
	No error.
const uint16_t	errRetry = 1
	Try again for whatever reason.
const uint16_t	errUnknown = 2
	Unknown error.
const uint16_t	errInvalidOp = 3
const uint16_t	errFcntl = 4
	failed manipulate file descriptor
const uint16_t	errPoll = 5
	error while polling descriptors
const uint16_t	errConfig = 6
	System misconfigured.
const uint16_t	errInternal = 7
	Internal error.
const uint16_t	errUnknownCommand = 8
const uint16_t	errInvalidArgs = 9
const uint16_t	errInProgress = 10
const uint16_t	errUninitialized = 11
const uint16_t	errOSError = 12
const uint16_t	errNotSupported = 13
const uint16_t	errDataError = 14
	data is corrupted
const uint16_t	errNotImplemented = 15
	Operation is not implemented.
const uint16_t	errNoMoreReplicas = 16
	No more replicas to try.
const uint16_t	errPipelineFailed = 17
	Pipeline failed and operation couldn't be executed.
const uint16_t	errInvalidAddr = 101
const uint16_t	errSocketError = 102
const uint16_t	errSocketTimeout = 103
const uint16_t	errSocketDisconnected = 104
const uint16_t	errPollerError = 105
const uint16_t	errSocketOptError = 106
const uint16_t	errStreamDisconnect = 107
const uint16_t	errConnectionError = 108
const uint16_t	errInvalidSession = 109
const uint16_t	errInvalidMessage = 201
const uint16_t	errHandShakeFailed = 202
const uint16_t	errLoginFailed = 203
const uint16_t	errAuthFailed = 204
const uint16_t	errQueryNotSupported = 205
const uint16_t	errOperationExpired = 206
const uint16_t	errOperationInterrupted = 207
const uint16_t	errNoMoreFreeSIDs = 301
const uint16_t	errInvalidRedirectURL = 302
const uint16_t	errInvalidResponse = 303
const uint16_t	errNotFound = 304
const uint16_t	errCheckSumError = 305
const uint16_t	errRedirectLimit = 306
const uint16_t	errErrorResponse = 400
const uint16_t	errRedirect = 401
const uint16_t	errResponseNegative = 500
	Query response was negative.

Detailed Description

When the envar XRD_CLIENTMONITOR is set to the libpath/libname.so that holds the monitoring object, it is automatically loaded. The following "C" external symbols must exist in the monitor plug-in shared library. It is called to obtain an instance of the XrdCl::Monitor object.

Parameters:

	exec	full path name to executable provided by XrdSysUtils::ExecName
	parms	Value of XRD_CLIENTMONITOPARAM envar or null if it is not set.

Returns:: Pointer to an instance of XrdCl::Monitor or null which causes monitoring to be disabled.

extern "C" { XrdCl::Monitor *XrdClGetMonitor(const char *exec, const char *parms); }

Typedef Documentation

typedef Buffer XrdCl::BinaryDataInfo

Binary buffer.

typedef ChModImpl<false> XrdCl::ChMod

typedef std::vector<ChunkInfo> XrdCl::ChunkList

List of chunks.

typedef CloseImpl<false> XrdCl::Close

typedef DeepLocateImpl<false> XrdCl::DeepLocate

typedef DirListImpl<false> XrdCl::DirList

typedef FcntlImpl<false> XrdCl::Fcntl

typedef std::vector<HostInfo> XrdCl::HostList

typedef LocateImpl<false> XrdCl::Locate

typedef MkDirImpl<false> XrdCl::MkDir

typedef MvImpl<false> XrdCl::Mv

typedef OpenImpl<false> XrdCl::Open

typedef PingImpl<false> XrdCl::Ping

typedef PrepareImpl<false> XrdCl::Prepare

typedef ProtocolImpl<false> XrdCl::Protocol

typedef QueryImpl<false> XrdCl::Query

typedef ReadImpl<false> XrdCl::Read

typedef RmImpl<false> XrdCl::Rm

typedef RmDirImpl<false> XrdCl::RmDir

typedef XrdSysSemaphore XrdCl::Semaphore

typedef SendInfoImpl<false> XrdCl::SendInfo

typedef StatVFSImpl<false> XrdCl::StatVFS

typedef SyncImpl<false> XrdCl::Sync

typedef VectorReadImpl<false> XrdCl::VectorRead

typedef VectorWriteImpl<false> XrdCl::VectorWrite

typedef VisaImpl<false> XrdCl::Visa

typedef WriteImpl<false> XrdCl::Write

typedef WriteVImpl<false> XrdCl::WriteV

Function Documentation

std::future<XRootDStatus> XrdCl::Async ( Pipeline pipeline ) [inline]

Helper function, schedules execution of given pipeline

Parameters:

pipeline

: the pipeline to be executed

Returns:: : future status of the operation

References XrdCl::Pipeline::ftr, and XrdCl::Pipeline::Run().

Referenced by WaitFor().

template<typename... Operations>

ParallelOperation<false> XrdCl::Parallel ( Operations &&... operations ) [inline]

Factory function for creating parallel operation from a given number of operations (we use && reference since due to reference collapsing this will fit both r- and l-value references)

References Parallel(), and PipesToVec().

template<class Container >

ParallelOperation<false> XrdCl::Parallel ( Container & container ) [inline]

Factory function for creating parallel operation from a vector.

Referenced by Parallel().

template<typename... Others>