xrootd
Classes | Typedefs | Variables
XrdCl Namespace Reference

Classes

struct  Access
 Access mode. More...
 
class  AnyObject
 
class  Buffer
 Binary blob representation. More...
 
class  ChannelEventHandler
 Channel event handler. More...
 
struct  ChunkInfo
 Describe a data chunk for vector read. More...
 
class  CopyProcess
 Copy the data from one point to another. More...
 
class  CopyProgressHandler
 Interface for copy progress notification. More...
 
class  DefaultEnv
 
class  DirectoryList
 Directory list. More...
 
struct  DirListFlags
 DirList flags. More...
 
class  Env
 
class  File
 A file. More...
 
class  FileSystem
 Send file/filesystem queries to an XRootD cluster. More...
 
struct  HandShakeData
 Data structure that carries the handshake information. More...
 
struct  HostInfo
 
class  IncomingMsgHandler
 Message handler. More...
 
class  LocationInfo
 Path location info. More...
 
class  Message
 The message representation used throughout the system. More...
 
class  MessageFilter
 Message filter. More...
 
struct  MkDirFlags
 MkDir flags. More...
 
class  Monitor
 An abstract class to describe the client-side monitoring plugin interface. More...
 
struct  OpenFlags
 Open flags, may be or'd when appropriate. More...
 
class  OpenInfo
 Information returned by file open operation. More...
 
class  OutgoingMsgHandler
 Message status handler. More...
 
struct  PathID
 
class  PostMaster
 A hub for dispatching and receiving messages. More...
 
struct  PrepareFlags
 Prepare flags. More...
 
class  ProtocolInfo
 Protocol response. More...
 
struct  QueryCode
 XRootD query request codes. More...
 
class  ResponseHandler
 Handle an async response. More...
 
class  StatInfo
 Object stat info. More...
 
class  StatInfoVFS
 VFS stat info. More...
 
struct  Status
 Procedure execution status. More...
 
class  TransportHandler
 Perform the handshake and the authentication for each physical stream. More...
 
class  TransportManager
 Manage transport handler objects. More...
 
struct  TransportQuery
 
class  URL
 URL representation. More...
 
class  VectorReadInfo
 Vector read info. More...
 
class  VirtualMessage
 A message that aims to use a VirtualRedirector. More...
 
class  XRootDStatus
 Request status. More...
 

Typedefs

typedef Buffer BinaryDataInfo
 Binary buffer. More...
 
typedef std::vector< ChunkInfoChunkList
 List of chunks. More...
 
typedef std::vector< HostInfoHostList
 

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 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 = 16777216
 
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 = 1
 
const int DefaultXCpBlockSize = 134217728
 
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 DefaultGlfnRedirector = ""
 
const uint16_t stOK = 0x0000
 Everything went OK. More...
 
const uint16_t stError = 0x0001
 An error occurred that could potentially be retried. More...
 
const uint16_t stFatal = 0x0003
 Fatal error, it's still an error. More...
 
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. More...
 
const uint16_t errRetry = 1
 Try again for whatever reason. More...
 
const uint16_t errUnknown = 2
 Unknown error. More...
 
const uint16_t errInvalidOp = 3
 
const uint16_t errFcntl = 4
 failed manipulate file descriptor More...
 
const uint16_t errPoll = 5
 error while polling descriptors More...
 
const uint16_t errConfig = 6
 System misconfigured. More...
 
const uint16_t errInternal = 7
 Internal error. More...
 
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 More...
 
const uint16_t errNotImplemented = 15
 Operation is not implemented. More...
 
const uint16_t errNoMoreReplicas = 16
 No more replicas to try. More...
 
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 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. More...
 

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
execfull path name to executable provided by XrdSysUtils::ExecName
parmsValue 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

◆ BinaryDataInfo

Binary buffer.

◆ ChunkList

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

List of chunks.

◆ HostList

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

Variable Documentation

◆ AppMsg

const uint64_t XrdCl::AppMsg = 0x0000000000000001ULL

◆ AsyncSockMsg

const uint64_t XrdCl::AsyncSockMsg = 0x0000000000000200ULL

◆ DefaultClientMonitor

const char* const XrdCl::DefaultClientMonitor = ""

◆ DefaultClientMonitorParam

const char* const XrdCl::DefaultClientMonitorParam = ""

◆ DefaultConnectionRetry

const int XrdCl::DefaultConnectionRetry = 5

◆ DefaultConnectionWindow

const int XrdCl::DefaultConnectionWindow = 120

◆ DefaultCPChunkSize

const int XrdCl::DefaultCPChunkSize = 16777216

◆ DefaultCPInitTimeout

const int XrdCl::DefaultCPInitTimeout = 600

◆ DefaultCPParallelChunks

const int XrdCl::DefaultCPParallelChunks = 4

◆ DefaultCPTPCTimeout

const int XrdCl::DefaultCPTPCTimeout = 1800

◆ DefaultDataServerTTL

const int XrdCl::DefaultDataServerTTL = 300

◆ DefaultGlfnRedirector

const char* const XrdCl::DefaultGlfnRedirector = ""

◆ DefaultLoadBalancerTTL

const int XrdCl::DefaultLoadBalancerTTL = 1200

◆ DefaultLocalMetalinkFile

const int XrdCl::DefaultLocalMetalinkFile = 1

◆ DefaultMetalinkProcessing

const int XrdCl::DefaultMetalinkProcessing = 1

◆ DefaultMultiProtocol

const int XrdCl::DefaultMultiProtocol = 0

◆ DefaultNetworkStack

const char* const XrdCl::DefaultNetworkStack = "IPAuto"

◆ DefaultParallelEvtLoop

const int XrdCl::DefaultParallelEvtLoop = 1

◆ DefaultPlugIn

const char* const XrdCl::DefaultPlugIn = ""

◆ DefaultPlugInConfDir

const char* const XrdCl::DefaultPlugInConfDir = ""

◆ DefaultPollerPreference

const char* const XrdCl::DefaultPollerPreference = "built-in"

◆ DefaultReadRecovery

const char* const XrdCl::DefaultReadRecovery = "true"

◆ DefaultRedirectLimit

const int XrdCl::DefaultRedirectLimit = 16

◆ DefaultRequestTimeout

const int XrdCl::DefaultRequestTimeout = 1800

◆ DefaultRunForkHandler

const int XrdCl::DefaultRunForkHandler = 0

◆ DefaultStreamErrorWindow

const int XrdCl::DefaultStreamErrorWindow = 1800

◆ DefaultStreamTimeout

const int XrdCl::DefaultStreamTimeout = 60

◆ DefaultSubStreamsPerChannel

const int XrdCl::DefaultSubStreamsPerChannel = 1

◆ DefaultTCPKeepAlive

const int XrdCl::DefaultTCPKeepAlive = 0

◆ DefaultTCPKeepAliveInterval

const int XrdCl::DefaultTCPKeepAliveInterval = 75

◆ DefaultTCPKeepAliveProbes

const int XrdCl::DefaultTCPKeepAliveProbes = 9

◆ DefaultTCPKeepAliveTime

const int XrdCl::DefaultTCPKeepAliveTime = 7200

◆ DefaultTimeoutResolution

const int XrdCl::DefaultTimeoutResolution = 15

◆ DefaultWorkerThreads

const int XrdCl::DefaultWorkerThreads = 3

◆ DefaultWriteRecovery

const char* const XrdCl::DefaultWriteRecovery = "true"

◆ DefaultXCpBlockSize

const int XrdCl::DefaultXCpBlockSize = 134217728

◆ errAuthFailed

const uint16_t XrdCl::errAuthFailed = 204

◆ errCheckSumError

const uint16_t XrdCl::errCheckSumError = 305

◆ errConfig

const uint16_t XrdCl::errConfig = 6

System misconfigured.

◆ errConnectionError

const uint16_t XrdCl::errConnectionError = 108

◆ errDataError

const uint16_t XrdCl::errDataError = 14

data is corrupted

◆ errErrorResponse

const uint16_t XrdCl::errErrorResponse = 400

◆ errFcntl

const uint16_t XrdCl::errFcntl = 4

failed manipulate file descriptor

◆ errHandShakeFailed

const uint16_t XrdCl::errHandShakeFailed = 202

◆ errInProgress

const uint16_t XrdCl::errInProgress = 10

◆ errInternal

const uint16_t XrdCl::errInternal = 7

Internal error.

◆ errInvalidAddr

const uint16_t XrdCl::errInvalidAddr = 101

◆ errInvalidArgs

const uint16_t XrdCl::errInvalidArgs = 9

◆ errInvalidMessage

const uint16_t XrdCl::errInvalidMessage = 201

◆ errInvalidOp

const uint16_t XrdCl::errInvalidOp = 3

The operation cannot be performed in the given circumstances

◆ errInvalidRedirectURL

const uint16_t XrdCl::errInvalidRedirectURL = 302

◆ errInvalidResponse

const uint16_t XrdCl::errInvalidResponse = 303

◆ errInvalidSession

const uint16_t XrdCl::errInvalidSession = 109

◆ errLoginFailed

const uint16_t XrdCl::errLoginFailed = 203

◆ errNoMoreFreeSIDs

const uint16_t XrdCl::errNoMoreFreeSIDs = 301

◆ errNoMoreReplicas

const uint16_t XrdCl::errNoMoreReplicas = 16

No more replicas to try.

◆ errNone

const uint16_t XrdCl::errNone = 0

No error.

◆ errNotFound

const uint16_t XrdCl::errNotFound = 304

◆ errNotImplemented

const uint16_t XrdCl::errNotImplemented = 15

Operation is not implemented.

◆ errNotSupported

const uint16_t XrdCl::errNotSupported = 13

◆ errOperationExpired

const uint16_t XrdCl::errOperationExpired = 206

◆ errOSError

const uint16_t XrdCl::errOSError = 12

◆ errPoll

const uint16_t XrdCl::errPoll = 5

error while polling descriptors

◆ errPollerError

const uint16_t XrdCl::errPollerError = 105

◆ errQueryNotSupported

const uint16_t XrdCl::errQueryNotSupported = 205

◆ errRedirect

const uint16_t XrdCl::errRedirect = 401

◆ errRedirectLimit

const uint16_t XrdCl::errRedirectLimit = 306

◆ errResponseNegative

const uint16_t XrdCl::errResponseNegative = 500

Query response was negative.

◆ errRetry

const uint16_t XrdCl::errRetry = 1

Try again for whatever reason.

◆ errSocketDisconnected

const uint16_t XrdCl::errSocketDisconnected = 104

◆ errSocketError

const uint16_t XrdCl::errSocketError = 102

◆ errSocketOptError

const uint16_t XrdCl::errSocketOptError = 106

◆ errSocketTimeout

const uint16_t XrdCl::errSocketTimeout = 103

◆ errStreamDisconnect

const uint16_t XrdCl::errStreamDisconnect = 107

◆ errUninitialized

const uint16_t XrdCl::errUninitialized = 11

◆ errUnknown

const uint16_t XrdCl::errUnknown = 2

Unknown error.

◆ errUnknownCommand

const uint16_t XrdCl::errUnknownCommand = 8

◆ FileMsg

const uint64_t XrdCl::FileMsg = 0x0000000000000004ULL

◆ FileSystemMsg

const uint64_t XrdCl::FileSystemMsg = 0x0000000000000100ULL

◆ JobMgrMsg

const uint64_t XrdCl::JobMgrMsg = 0x0000000000000400ULL

◆ PlugInMgrMsg

const uint64_t XrdCl::PlugInMgrMsg = 0x0000000000000800ULL

◆ PollerMsg

const uint64_t XrdCl::PollerMsg = 0x0000000000000008ULL

◆ PostMasterMsg

const uint64_t XrdCl::PostMasterMsg = 0x0000000000000010ULL

◆ stError

const uint16_t XrdCl::stError = 0x0001

An error occurred that could potentially be retried.

Referenced by XrdCl::Status::IsError().

◆ stFatal

const uint16_t XrdCl::stFatal = 0x0003

Fatal error, it's still an error.

Referenced by XrdCl::Status::IsFatal().

◆ stOK

const uint16_t XrdCl::stOK = 0x0000

◆ suAlreadyDone

const uint16_t XrdCl::suAlreadyDone = 4

◆ suContinue

const uint16_t XrdCl::suContinue = 1

◆ suDone

const uint16_t XrdCl::suDone = 0

◆ suPartial

const uint16_t XrdCl::suPartial = 3

◆ suRetry

const uint16_t XrdCl::suRetry = 2

◆ TaskMgrMsg

const uint64_t XrdCl::TaskMgrMsg = 0x0000000000000040ULL

◆ UtilityMsg

const uint64_t XrdCl::UtilityMsg = 0x0000000000000002ULL

◆ XRootDMsg

const uint64_t XrdCl::XRootDMsg = 0x0000000000000080ULL

◆ XRootDTransportMsg

const uint64_t XrdCl::XRootDTransportMsg = 0x0000000000000020ULL