xrootd
Loading...
Searching...
No Matches
Classes | Typedefs | Enumerations | Functions | Variables
XrdCl Namespace Reference

Classes

struct  Access
 Access mode. More...
 
struct  Action
 Action. More...
 
struct  ActionMetrics
 Metrics struct storing all timing and IO information of an action. More...
 
class  AnyObject
 
class  AppendFileImpl
 AppendFile operation (. More...
 
class  Arg
 
class  Arg< std::string >
 
class  ArgBase
 Base class for Arg. More...
 
class  AsyncDiscardReader
 Object for discarding data. More...
 
class  AsyncHSReader
 Utility class encapsulating reading hand-shake response logic. More...
 
class  AsyncHSWriter
 Utility class encapsulating writing hand-shake request logic. More...
 
class  AsyncMsgReader
 Utility class encapsulating reading response message logic. More...
 
class  AsyncMsgWriter
 Utility class encapsulating writing request logic. More...
 
class  AsyncPageReader
 Object for reading out data from the PgRead response. More...
 
class  AsyncRawReader
 Object for reading out data from the kXR_read response. More...
 
class  AsyncRawReaderIntfc
 Base class for any message's body reader. More...
 
class  AsyncSocketHandler
 
class  AsyncVectorReader
 Object for reading out data from the VectorRead response. More...
 
class  Buffer
 Binary blob representation. More...
 
class  Channel
 A communication channel between the client and the server. More...
 
class  ChannelEventHandler
 Channel event handler. More...
 
class  ChannelHandlerList
 A helper for handling channel event handlers. More...
 
class  CheckpointImpl
 Checkpoint operation (. More...
 
class  CheckSumHelper
 Check sum helper for stdio. More...
 
class  CheckSumManager
 Manage the checksum calc objects. More...
 
class  ChkptWrtImpl
 Checkpointed write operation (. More...
 
class  ChkptWrtVImpl
 Checkpointed WriteV operation (. More...
 
class  ChModImpl
 ChMod operation (. More...
 
struct  ChunkInfo
 Describe a data chunk for vector read. More...
 
class  ClassicCopyJob
 
struct  CloseAction
 Close action. More...
 
class  CloseArchiveImpl
 CloseArchive operation (. More...
 
class  CloseFileImpl
 CloseFile operation (. More...
 
class  CloseImpl
 Close operation (. More...
 
class  ConcreteOperation
 
class  CopyJob
 Copy job. More...
 
class  CopyProcess
 Copy the data from one point to another. More...
 
class  CopyProgressHandler
 Interface for copy progress notification. More...
 
struct  Ctx
 Utility class for storing a pointer to operation context. More...
 
class  DeepLocateImpl
 DeepLocate operation (. More...
 
class  DefaultEnv
 
class  DelXAttrBulkImpl
 DelXAttr bulk operation (. More...
 
class  DelXAttrFsBulkImpl
 DelXAttr bulk operation (. More...
 
class  DelXAttrFsImpl
 DelXAttr operation (. More...
 
class  DelXAttrImpl
 DelXAttr operation (. More...
 
class  DirectoryList
 Directory list. More...
 
struct  DirListFlags
 DirList flags. More...
 
class  DirListImpl
 DirList operation (. More...
 
class  DlgEnv
 
class  EcHandler
 
class  EcPgReadResponseHandler
 
class  EcPlugInFactory
 Plugin factory. More...
 
class  Env
 
class  ExOpenFuncWrapper
 Lambda wrapper. More...
 
struct  FcntlAction
 Fcntl action. More...
 
class  FcntlImpl
 Fcntl operation (. More...
 
class  File
 A file. More...
 
class  FileOperation
 
class  FilePlugIn
 An interface for file plug-ins. More...
 
class  FileStateHandler
 Handle the stateful operations. More...
 
class  FileSystem
 Send file/filesystem queries to an XRootD cluster. More...
 
class  FileSystemOperation
 
class  FileSystemPlugIn
 An interface for file plug-ins. More...
 
class  FileSystemUtils
 
class  FileTimer
 Task generating timeout events for FileStateHandlers in recovery mode. More...
 
class  FinalOperation
 
class  ForkHandler
 
class  FreeSpace
 
class  FSExecutor
 Execute queries given as a commandline. More...
 
class  FunctionWrapper
 
class  FunctionWrapper< void >
 
class  FutureWrapper
 
class  FutureWrapper< void >
 A wrapper handler for a std::promise / std::future, overload for void type. More...
 
class  FutureWrapperBase
 
struct  Fwd
 
struct  FwdStorage
 
class  GetXAttrBulkImpl
 GetXAttr bulk operation (. More...
 
class  GetXAttrFsBulkImpl
 GetXAttr bulk operation (. More...
 
class  GetXAttrFsImpl
 GetXAttr operation (. More...
 
class  GetXAttrImpl
 GetXAttr operation (. More...
 
struct  HandShakeData
 Data structure that carries the handshake information. More...
 
struct  HostInfo
 
class  HttpFilePlugIn
 
class  HttpFileSystemPlugIn
 
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  ListXAttrFsImpl
 ListXAttr bulk operation (. More...
 
class  ListXAttrImpl
 ListXAttr bulk operation (. More...
 
class  LocalFileHandler
 
class  LocalFileTask
 
class  LocateImpl
 Locate operation (. More...
 
class  LocationInfo
 Path location info. More...
 
class  Log
 Handle diagnostics. More...
 
class  LogOut
 Interface for logger outputs. More...
 
class  LogOutCerr
 Write log messages to stderr. More...
 
class  LogOutFile
 Write log messages to a file. More...
 
class  Message
 The message representation used throughout the system. More...
 
struct  MessageSendParams
 
class  MessageUtils
 
class  MetalinkRedirector
 
struct  MkDirFlags
 MkDir flags. More...
 
class  MkDirImpl
 MkDir operation (. More...
 
class  Monitor
 An abstract class to describe the client-side monitoring plugin interface. More...
 
class  MsgHandler
 Message handler. More...
 
class  MvImpl
 Mv operation (. More...
 
struct  None
 none object for initializing empty Optional More...
 
struct  NullRef
 
class  NullResponseHandler
 
struct  OpenAction
 Open action. More...
 
class  OpenArchiveImpl
 OpenArchive operation (. More...
 
class  OpenFileImpl
 OpenFile operation (. More...
 
struct  OpenFlags
 Open flags, may be or'd when appropriate. More...
 
class  OpenImpl
 Open operation (. More...
 
class  OpenInfo
 Information returned by file open operation. More...
 
class  Operation
 
class  operation_expired
 
class  Optional
 
class  OutQueue
 A synchronized queue for the outgoing data. More...
 
struct  PageInfo
 
class  ParallelOperation
 
struct  PathID
 
struct  PgReadAction
 
struct  PgReadFlags
 PgRead flags. More...
 
class  PgReadImpl
 PgRead operation (. More...
 
struct  PgWriteAction
 
class  PgWriteImpl
 PgWrite operation (. More...
 
class  PingImpl
 Ping operation (. More...
 
class  Pipeline
 
class  PipelineException
 Pipeline exception, wrapps an XRootDStatus. More...
 
class  PipelineHandler
 
class  PlugInFactory
 Plugin factory. More...
 
class  PlugInManager
 Manage client-side plug-ins and match them agains URLs. More...
 
struct  PolicyExecutor
 
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...
 
struct  PrepareFlags
 Prepare flags. More...
 
class  PrepareImpl
 Prepare operation (. More...
 
class  PropertyList
 A key-value pair map storing both keys and values as strings. More...
 
class  ProtocolImpl
 Protocol operation (. More...
 
class  ProtocolInfo
 Protocol response. More...
 
struct  QueryCode
 XRootD query request codes. More...
 
class  QueryImpl
 Query operation (. More...
 
class  RawWrapper
 Wrapper class for raw response handler (ResponseHandler). More...
 
struct  ReadAction
 Read action. More...
 
class  ReadImpl
 Read operation (. More...
 
struct  ReadTrait
 RdWithRsp: factory for creating ReadImpl/PgReadImpl objects. More...
 
struct  ReadTrait< ChunkInfo >
 
struct  ReadTrait< PageInfo >
 
class  Recorder
 
class  RecorderFactory
 XrdCl recorder plug-in factory. More...
 
struct  RedirectEntry
 
class  RedirectJob
 A job class for redirect handling in the thread-pool. More...
 
class  RedirectorRegistry
 Singleton access to URL to virtual redirector mapping. More...
 
class  ReplayArgs
 Args parse for XrdClReplay. More...
 
class  RequestSync
 A helper running a fixed number of requests at a given time. More...
 
struct  Resp
 
struct  Resp< void >
 
struct  RespBase
 
class  ResponseHandler
 Handle an async response. More...
 
class  ResponseJob
 Call the user callback. More...
 
struct  RetryInfo
 
class  RmDirImpl
 RmDir operation (. More...
 
class  RmImpl
 Rm operation (. More...
 
class  ScopedDescriptor
 Smart descriptor - closes the descriptor on destruction. More...
 
class  SendInfoImpl
 SendInfo operation (. More...
 
struct  seq_gen
 
struct  seq_gen< 0, Ns... >
 
struct  seq_gen< I, Ns... >
 
struct  sequence
 
class  ServerSpaceInfo
 
class  SetXAttrBulkImpl
 SetXAttr bulk operation (. More...
 
class  SetXAttrFsBulkImpl
 SetXAttr bulk operation (. More...
 
class  SetXAttrFsImpl
 SetXAttr operation (. More...
 
class  SetXAttrImpl
 SetXAttr operation (. More...
 
class  SIDManager
 Handle XRootD stream IDs. More...
 
class  SIDMgrPool
 Pool of SID manager objects. More...
 
class  Socket
 A network socket. More...
 
class  SocketHandler
 Interface. More...
 
struct  StatAction
 Stat action. More...
 
class  StatFsImpl
 Stat operation (. More...
 
class  StatImpl
 Stat operation (. More...
 
class  StatInfo
 Object stat info. More...
 
class  StatInfoVFS
 VFS stat info. More...
 
struct  Status
 Procedure execution status. More...
 
class  StatVFSImpl
 StatVS operation (. More...
 
class  Stream
 Stream. More...
 
struct  StreamQuery
 
struct  SyncAction
 Sync action. More...
 
class  SyncImpl
 Sync operation (. More...
 
class  SyncQueue
 A synchronized queue. More...
 
class  SyncResponseHandler
 Synchronize the response. More...
 
class  Task
 Interface for a task to be run by the TaskManager. More...
 
class  TaskManager
 
class  TaskWrapper
 
class  TaskWrapper< void, Return >
 
class  ThirdPartyCopyJob
 
class  Timeout
 
class  Tls
 TLS layer for socket connection. More...
 
class  TPFallBackCopyJob
 
class  TransportHandler
 Perform the handshake and the authentication for each physical stream. More...
 
class  TransportManager
 Manage transport handler objects. More...
 
struct  TransportQuery
 
struct  TruncateAction
 Truncate action. More...
 
class  TruncateFsImpl
 Truncate operation (. More...
 
class  TruncateImpl
 Truncate operation (. More...
 
class  UnpackXAttr
 Helper class for unpacking single XAttr from bulk response. More...
 
class  UnpackXAttrStatus
 Helper class for unpacking single XAttrStatus from bulk response. More...
 
class  URL
 URL representation. More...
 
class  Utils
 Random utilities. More...
 
struct  VectorReadAction
 VectorRead action. More...
 
class  VectorReadImpl
 VectorRead operation (. More...
 
class  VectorReadInfo
 Vector read info. More...
 
struct  VectorWriteAction
 Vector Write action. More...
 
class  VectorWriteImpl
 VectorWrite operation (. More...
 
class  VirtualRedirector
 An interface for metadata redirectors. More...
 
class  VisaImpl
 Visa operation (. More...
 
struct  WriteAction
 Write action. More...
 
class  WriteImpl
 Write operation (. More...
 
class  WriteVImpl
 WriteV operation (. More...
 
struct  XAttr
 Extended attributes with status. More...
 
struct  XAttrStatus
 Extended attribute operation status. More...
 
class  XCpCtx
 
class  XCpSrc
 
class  XRootDMsgHandler
 Handle/Process/Forward XRootD messages. More...
 
struct  XRootDQuery
 XRootD related protocol queries. More...
 
class  XRootDStatus
 Request status. More...
 
class  XRootDTransport
 XRootD transport handler. More...
 
class  ZipArchive
 
class  ZipCache
 Utility class for inflating a compressed buffer. More...
 
struct  ZipError
 An exception for carrying the XRootDStatus of InflCache. More...
 
class  ZipListHandler
 
class  ZipListImpl
 ZipList operation (. More...
 
class  ZipOperation
 
class  ZipReadFromImpl
 Read operation (. More...
 
class  ZipReadImpl
 Read operation (. More...
 
class  ZipStatImpl
 ZipStat operation (. More...
 
class  ZipWriteImpl
 Write operation (. More...
 

Typedefs

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 FinalOperation Final
 
typedef std::function< Operation< true > *(const XRootDStatus &)> rcvry_func
 Type of the recovery function to be provided by the user.
 
typedef std::tuple< std::string, std::string > xattr_t
 Extended attribute key - value pair.
 
typedef Buffer BinaryDataInfo
 Binary buffer.
 
typedef std::vector< ChunkInfoChunkList
 List of chunks.
 
typedef std::vector< HostInfoHostList
 
typedef CloseFileImpl< false > CloseFile
 

Enumerations

enum  ChkPtCode { BEGIN = kXR_ckpBegin , COMMIT = kXR_ckpCommit , ROLLBACK = kXR_ckpRollback }
 Checkpoint operation code. More...
 
enum  { xattr_name = 0 , xattr_value = 1 }
 Tuple indexes of name and value fields in xattr_t. More...
 

Functions

template<typename T >
T & To (AnyObject &any)
 
template<typename FUNC , typename TUPL , int ... INDICES>
static auto tuple_call_impl (FUNC &func, TUPL &args, sequence< INDICES... >) -> decltype(func(std::move(std::get< INDICES >(args))...))
 
template<typename FUNC , typename ... ARGs>
static auto Apply (FUNC &&func, std::tuple< ARGs... > &tup) -> decltype(tuple_call_impl(func, tup, typename seq_gen< sizeof...(ARGs)>::type{}))
 
template<typename METH , typename OBJ , typename ... ARGs>
static auto Apply (METH &&method, OBJ &obj, std::tuple< ARGs... > &tup) -> decltype(Apply(std::bind(method, &obj, std::placeholders::_1, std::placeholders::_2), tup))
 
CheckpointImpl< false > Checkpoint (Ctx< File > file, Arg< ChkPtCode > code, uint16_t timeout=0)
 Factory for creating ReadImpl objects.
 
ChkptWrtImpl< false > ChkptWrt (Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< const void * > buffer, uint16_t timeout=0)
 Factory for creating ReadImpl objects.
 
ChkptWrtVImpl< false > ChkptWrtV (Ctx< File > file, Arg< uint64_t > offset, Arg< std::vector< iovec > > iov, uint16_t timeout=0)
 Factory for creating ChkptWrtVImpl objects.
 
static std::string to_lower (std::string str)
 
EcHandlerGetEcHandler (const URL &headnode, const URL &redirurl)
 
OpenImpl< false > Open (Ctx< File > file, Arg< std::string > url, Arg< OpenFlags::Flags > flags, Arg< Access::Mode > mode=Access::None, uint16_t timeout=0)
 Factory for creating ReadImpl objects.
 
ReadImpl< false > Read (Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout=0)
 Factory for creating ReadImpl objects.
 
PgReadImpl< false > PgRead (Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout=0)
 Factory for creating PgReadImpl objects.
 
template<typename RSP >
ReadTrait< RSP >::RET RdWithRsp (Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout=0)
 
template<>
ReadImpl< false > RdWithRsp< ChunkInfo > (Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout)
 
template<>
PgReadImpl< false > RdWithRsp< PageInfo > (Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout)
 
PgWriteImpl< false > PgWrite (Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, Arg< std::vector< uint32_t > > cksums, uint16_t timeout=0)
 Factory for creating PgReadImpl objects.
 
PgWriteImpl< false > PgWrite (Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout=0)
 Factory for creating PgReadImpl objects.
 
CloseImpl< false > Close (Ctx< File > file, uint16_t timeout=0)
 Factory for creating CloseImpl objects.
 
StatImpl< false > Stat (Ctx< File > file, Arg< bool > force, uint16_t timeout=0)
 
WriteImpl< false > Write (Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< const void * > buffer, uint16_t timeout=0)
 Factory for creating WriteImpl objects.
 
SyncImpl< false > Sync (Ctx< File > file, uint16_t timeout=0)
 Factory for creating SyncImpl objects.
 
TruncateImpl< false > Truncate (Ctx< File > file, Arg< uint64_t > size, uint16_t timeout)
 
VectorReadImpl< false > VectorRead (Ctx< File > file, Arg< ChunkList > chunks, Arg< void * > buffer, uint16_t timeout=0)
 Factory for creating VectorReadImpl objects.
 
VectorReadImpl< false > VectorRead (Ctx< File > file, Arg< ChunkList > chunks, uint16_t timeout=0)
 
VectorWriteImpl< false > VectorWrite (Ctx< File > file, Arg< ChunkList > chunks, uint16_t timeout=0)
 Factory for creating VectorWriteImpl objects.
 
WriteVImpl< false > WriteV (Ctx< File > file, Arg< uint64_t > offset, Arg< std::vector< iovec > > iov, uint16_t timeout=0)
 Factory for creating WriteVImpl objects.
 
SetXAttrImpl< false > SetXAttr (Ctx< File > file, Arg< std::string > name, Arg< std::string > value)
 
SetXAttrBulkImpl< false > SetXAttr (Ctx< File > file, Arg< std::vector< xattr_t > > attrs)
 
GetXAttrImpl< false > GetXAttr (Ctx< File > file, Arg< std::string > name)
 
GetXAttrBulkImpl< false > GetXAttr (Ctx< File > file, Arg< std::vector< std::string > > attrs)
 
DelXAttrImpl< false > DelXAttr (Ctx< File > file, Arg< std::string > name)
 
DelXAttrBulkImpl< false > DelXAttr (Ctx< File > file, Arg< std::vector< std::string > > attrs)
 
ListXAttrImpl< false > ListXAttr (Ctx< File > file)
 
TruncateFsImpl< false > Truncate (Ctx< FileSystem > fs, Arg< std::string > path, Arg< uint64_t > size)
 
StatFsImpl< false > Stat (Ctx< FileSystem > fs, Arg< std::string > path)
 
SetXAttrFsImpl< false > SetXAttr (Ctx< FileSystem > fs, Arg< std::string > path, Arg< std::string > name, Arg< std::string > value)
 
SetXAttrFsBulkImpl< false > SetXAttr (Ctx< FileSystem > fs, Arg< std::string > path, Arg< std::vector< xattr_t > > attrs)
 
GetXAttrFsImpl< false > GetXAttr (Ctx< FileSystem > fs, Arg< std::string > path, Arg< std::string > name)
 
GetXAttrFsBulkImpl< false > GetXAttr (Ctx< FileSystem > fs, Arg< std::string > path, Arg< std::vector< std::string > > attrs)
 
DelXAttrFsImpl< false > DelXAttr (Ctx< FileSystem > fs, Arg< std::string > path, Arg< std::string > name)
 
DelXAttrFsBulkImpl< false > DelXAttr (Ctx< FileSystem > fs, Arg< std::string > path, Arg< std::vector< std::string > > attrs)
 
ListXAttrFsImpl< false > ListXAttr (Ctx< FileSystem > fs, Arg< std::string > path)
 
template<typename T , typename... Args>
std::shared_ptr< FwdStorage< T > > make_fwd (Args &&... args)
 
template<typename Response >
Response * GetResponse (AnyObject *rsp)
 
template<typename Response >
Response * GetResponse (XRootDStatus *status, AnyObject *rsp)
 
std::future< XRootDStatusAsync (Pipeline pipeline, uint16_t timeout=0)
 
XRootDStatus WaitFor (Pipeline pipeline, uint16_t timeout=0)
 
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
 
OpenArchiveImpl< false > OpenArchive (Ctx< ZipArchive > zip, Arg< std::string > fn, Arg< OpenFlags::Flags > flags, uint16_t timeout=0)
 Factory for creating OpenArchiveImpl objects.
 
OpenFileImpl< false > OpenFile (Ctx< ZipArchive > zip, Arg< std::string > fn, Arg< OpenFlags::Flags > flags=OpenFlags::None, Arg< uint64_t > size=0, Arg< uint32_t > crc32=0, uint16_t timeout=0)
 Factory for creating OpenFileImpl objects.
 
ZipReadImpl< false > Read (Ctx< ZipArchive > zip, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout=0)
 Factory for creating ArchiveReadImpl objects.
 
ZipReadFromImpl< false > ReadFrom (Ctx< ZipArchive > zip, Arg< std::string > fn, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout=0)
 Factory for creating ArchiveReadImpl objects.
 
ZipWriteImpl< false > Write (Ctx< ZipArchive > zip, Arg< uint32_t > size, Arg< const void * > buffer, uint16_t timeout=0)
 Factory for creating ArchiveReadImpl objects.
 
AppendFileImpl< false > AppendFile (Ctx< ZipArchive > zip, Arg< std::string > fn, Arg< uint32_t > crc32, Arg< uint32_t > size, Arg< const void * > buffer, uint16_t timeout=0)
 Factory for creating ArchiveReadImpl objects.
 
ZipStatImpl< false > Stat (Ctx< ZipArchive > zip)
 Factory for creating ZipStatImpl objects.
 
ZipListImpl< false > List (Ctx< ZipArchive > zip)
 Factory for creating ZipStatImpl objects.
 
CloseArchiveImpl< false > CloseArchive (Ctx< ZipArchive > zip, uint16_t timeout=0)
 Factory for creating CloseFileImpl objects.
 
void SetUpLogging (Log *logger)
 

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 uint64_t TlsMsg = 0x0000000000002000ULL
 
const uint64_t ZipMsg = 0x0000000000004000ULL
 
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 = 1
 
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 DefaultCPTimeout = 0
 
const int DefaultTCPKeepAlive = 0
 
const int DefaultTCPKeepAliveTime = 7200
 
const int DefaultTCPKeepAliveInterval = 75
 
const int DefaultTCPKeepAliveProbes = 9
 
const int DefaultMultiProtocol = 0
 
const int DefaultParallelEvtLoop = 10
 
const int DefaultMetalinkProcessing = 1
 
const int DefaultLocalMetalinkFile = 0
 
const int DefaultXRateThreshold = 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 DefaultPreserveXAttrs = 0
 
const int DefaultNoTlsOK = 0
 
const int DefaultTlsNoData = 0
 
const int DefaultTlsMetalink = 0
 
const int DefaultZipMtlnCksum = 0
 
const int DefaultIPNoShuffle = 0
 
const int DefaultWantTlsOnNoPgrw = 0
 
const int DefaultRetryWrtAtLBLimit = 3
 
const int DefaultCpRetry = 0
 
const int DefaultCpUsePgWrtRd = 1
 
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 char *const DefaultTlsDbgLvl = "OFF"
 
const char *const DefaultClConfDir = ""
 
const char *const DefaultClConfFile = ""
 
const char *const DefaultCpTarget = ""
 
const char *const DefaultCpRetryPolicy = "force"
 
static std::unordered_map< std::string, int > theDefaultInts
 
static std::unordered_map< std::string, std::string > theDefaultStrs
 
static struct XrdCl::None none
 
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 suNotStarted = 5
 
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 errTlsError = 110
 
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 errThresholdExceeded = 208
 
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 errCorruptedHeader = 307
 
const uint16_t errErrorResponse = 400
 
const uint16_t errRedirect = 401
 
const uint16_t errLocalError = 402
 
const uint16_t errResponseNegative = 500
 Query response was negative.
 
static const uint64_t kLogXrdClHttp = std::numeric_limits<std::uint64_t>::max()
 

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); }

This file is part of XrdClHttp

Typedef Documentation

◆ BinaryDataInfo

Binary buffer.

◆ ChMod

typedef ChModImpl<false> XrdCl::ChMod

◆ ChunkList

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

List of chunks.

◆ CloseFile

◆ DeepLocate

◆ DirList

typedef DirListImpl<false> XrdCl::DirList

◆ Fcntl

typedef FcntlImpl<false> XrdCl::Fcntl

◆ Final

◆ HostList

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

◆ Locate

typedef LocateImpl<false> XrdCl::Locate

◆ MkDir

typedef MkDirImpl<false> XrdCl::MkDir

◆ Mv

typedef MvImpl<false> XrdCl::Mv

◆ Ping

typedef PingImpl<false> XrdCl::Ping

◆ Prepare

typedef PrepareImpl<false> XrdCl::Prepare

◆ Protocol

typedef ProtocolImpl<false> XrdCl::Protocol

◆ Query

typedef QueryImpl<false> XrdCl::Query

◆ rcvry_func

typedef std::function<Operation<true>*(const XRootDStatus&)> XrdCl::rcvry_func

Type of the recovery function to be provided by the user.

◆ Rm

typedef RmImpl<false> XrdCl::Rm

◆ RmDir

typedef RmDirImpl<false> XrdCl::RmDir

◆ SendInfo

typedef SendInfoImpl<false> XrdCl::SendInfo

◆ StatVFS

typedef StatVFSImpl<false> XrdCl::StatVFS

◆ Visa

typedef VisaImpl<false> XrdCl::Visa

◆ xattr_t

typedef std::tuple<std::string, std::string> XrdCl::xattr_t

Extended attribute key - value pair.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Tuple indexes of name and value fields in xattr_t.

Enumerator
xattr_name 
xattr_value 

◆ ChkPtCode

Checkpoint operation code.

Enumerator
BEGIN 
COMMIT 
ROLLBACK 

Function Documentation

◆ AppendFile()

AppendFileImpl< false > XrdCl::AppendFile ( Ctx< ZipArchive zip,
Arg< std::string >  fn,
Arg< uint32_t >  crc32,
Arg< uint32_t >  size,
Arg< const void * >  buffer,
uint16_t  timeout = 0 
)
inline

Factory for creating ArchiveReadImpl objects.

References XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::Timeout().

◆ Apply() [1/2]

template<typename FUNC , typename ... ARGs>
static auto XrdCl::Apply ( FUNC &&  func,
std::tuple< ARGs... > &  tup 
) -> decltype( tuple_call_impl( func, tup, typename seq_gen<sizeof...(ARGs)>::type{} ) )
inlinestatic

Referenced by Apply().

◆ Apply() [2/2]

template<typename METH , typename OBJ , typename ... ARGs>
static auto XrdCl::Apply ( METH &&  method,
OBJ &  obj,
std::tuple< ARGs... > &  tup 
) -> decltype( Apply( std::bind( method, &obj, std::placeholders::_1, std::placeholders::_2 ), tup ) )
inlinestatic

References Apply().

◆ Async()

std::future< XRootDStatus > XrdCl::Async ( Pipeline  pipeline,
uint16_t  timeout = 0 
)
inline

Helper function, schedules execution of given pipeline

Parameters
pipeline: the pipeline to be executed
timeout: the pipeline timeout
Returns
: future status of the operation

Referenced by WaitFor().

◆ Checkpoint()

CheckpointImpl< false > XrdCl::Checkpoint ( Ctx< File file,
Arg< ChkPtCode code,
uint16_t  timeout = 0 
)
inline

◆ ChkptWrt()

ChkptWrtImpl< false > XrdCl::ChkptWrt ( Ctx< File file,
Arg< uint64_t >  offset,
Arg< uint32_t >  size,
Arg< const void * >  buffer,
uint16_t  timeout = 0 
)
inline

◆ ChkptWrtV()

ChkptWrtVImpl< false > XrdCl::ChkptWrtV ( Ctx< File file,
Arg< uint64_t >  offset,
Arg< std::vector< iovec > >  iov,
uint16_t  timeout = 0 
)
inline

◆ Close()

CloseImpl< false > XrdCl::Close ( Ctx< File file,
uint16_t  timeout = 0 
)
inline

◆ CloseArchive()

CloseArchiveImpl< false > XrdCl::CloseArchive ( Ctx< ZipArchive zip,
uint16_t  timeout = 0 
)
inline

◆ DelXAttr() [1/4]

DelXAttrImpl< false > XrdCl::DelXAttr ( Ctx< File file,
Arg< std::string >  name 
)
inline

Factory for creating DelXAttrImpl objects (as there is another DelXAttr in FileSystem there would be a clash of typenames).

◆ DelXAttr() [2/4]

DelXAttrBulkImpl< false > XrdCl::DelXAttr ( Ctx< File file,
Arg< std::vector< std::string > >  attrs 
)
inline

Factory for creating DelXAttrBulkImpl objects (as there is another DelXAttr in FileSystem there would be a clash of typenames).

◆ DelXAttr() [3/4]

DelXAttrFsImpl< false > XrdCl::DelXAttr ( Ctx< FileSystem fs,
Arg< std::string >  path,
Arg< std::string >  name 
)
inline

Factory for creating DelXAttrFsImpl objects (as there is another DelXAttr in File there would be a clash of typenames).

◆ DelXAttr() [4/4]

DelXAttrFsBulkImpl< false > XrdCl::DelXAttr ( Ctx< FileSystem fs,
Arg< std::string >  path,
Arg< std::vector< std::string > >  attrs 
)
inline

Factory for creating DelXAttrFsBulkImpl objects (as there is another DelXAttr in FileSystem there would be a clash of typenames).

◆ GetEcHandler()

EcHandler * XrdCl::GetEcHandler ( const URL headnode,
const URL redirurl 
)

References GetEcHandler().

Referenced by GetEcHandler().

◆ GetResponse() [1/2]

template<typename Response >
Response * XrdCl::GetResponse ( AnyObject rsp)
inline

Unpack response

Parameters
rsp: AnyObject holding response
Returns
: the response

References XrdCl::AnyObject::Get().

◆ GetResponse() [2/2]

template<typename Response >
Response * XrdCl::GetResponse ( XRootDStatus status,
AnyObject rsp 
)
inline

Unpack response

Parameters
rsp: AnyObject holding response
status:
Returns
: the response

References XrdCl::Status::IsOK().

◆ GetXAttr() [1/4]

GetXAttrImpl< false > XrdCl::GetXAttr ( Ctx< File file,
Arg< std::string >  name 
)
inline

Factory for creating GetXAttrImpl objects (as there is another GetXAttr in FileSystem there would be a clash of typenames).

◆ GetXAttr() [2/4]

GetXAttrBulkImpl< false > XrdCl::GetXAttr ( Ctx< File file,
Arg< std::vector< std::string > >  attrs 
)
inline

Factory for creating GetXAttrBulkImpl objects (as there is another GetXAttr in FileSystem there would be a clash of typenames).

◆ GetXAttr() [3/4]

GetXAttrFsImpl< false > XrdCl::GetXAttr ( Ctx< FileSystem fs,
Arg< std::string >  path,
Arg< std::string >  name 
)
inline

Factory for creating GetXAttrFsImpl objects (as there is another GetXAttr in File there would be a clash of typenames).

◆ GetXAttr() [4/4]

GetXAttrFsBulkImpl< false > XrdCl::GetXAttr ( Ctx< FileSystem fs,
Arg< std::string >  path,
Arg< std::vector< std::string > >  attrs 
)
inline

Factory for creating GetXAttrFsBulkImpl objects (as there is another GetXAttr in FileSystem there would be a clash of typenames).

◆ List()

ZipListImpl< false > XrdCl::List ( Ctx< ZipArchive zip)
inline

Factory for creating ZipStatImpl objects.

◆ ListXAttr() [1/2]

ListXAttrImpl< false > XrdCl::ListXAttr ( Ctx< File file)
inline

Factory for creating ListXAttrImpl objects (as there is another ListXAttr in FileSystem there would be a clash of typenames).

◆ ListXAttr() [2/2]

ListXAttrFsImpl< false > XrdCl::ListXAttr ( Ctx< FileSystem fs,
Arg< std::string >  path 
)
inline

Factory for creating ListXAttrFsImpl objects (as there is another ListXAttr in FileSystem there would be a clash of typenames).

◆ make_fwd()

template<typename T , typename... Args>
std::shared_ptr< FwdStorage< T > > XrdCl::make_fwd ( Args &&...  args)
inline

◆ Open()

OpenImpl< false > XrdCl::Open ( Ctx< File file,
Arg< std::string >  url,
Arg< OpenFlags::Flags flags,
Arg< Access::Mode mode = Access::None,
uint16_t  timeout = 0 
)
inline

◆ OpenArchive()

OpenArchiveImpl< false > XrdCl::OpenArchive ( Ctx< ZipArchive zip,
Arg< std::string >  fn,
Arg< OpenFlags::Flags flags,
uint16_t  timeout = 0 
)
inline

◆ OpenFile()

OpenFileImpl< false > XrdCl::OpenFile ( Ctx< ZipArchive zip,
Arg< std::string >  fn,
Arg< OpenFlags::Flags flags = OpenFlags::None,
Arg< uint64_t >  size = 0,
Arg< uint32_t >  crc32 = 0,
uint16_t  timeout = 0 
)
inline

◆ Parallel() [1/2]

template<class Container >
ParallelOperation< false > XrdCl::Parallel ( Container &&  container)
inline

Factory function for creating parallel operation from a vector.

Referenced by Parallel().

◆ Parallel() [2/2]

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().

◆ PgRead()

PgReadImpl< false > XrdCl::PgRead ( Ctx< File file,
Arg< uint64_t >  offset,
Arg< uint32_t >  size,
Arg< void * >  buffer,
uint16_t  timeout = 0 
)
inline

◆ PgWrite() [1/2]

PgWriteImpl< false > XrdCl::PgWrite ( Ctx< File file,
Arg< uint64_t >  offset,
Arg< uint32_t >  size,
Arg< void * >  buffer,
Arg< std::vector< uint32_t > >  cksums,
uint16_t  timeout = 0 
)
inline

◆ PgWrite() [2/2]

PgWriteImpl< false > XrdCl::PgWrite ( Ctx< File file,
Arg< uint64_t >  offset,
Arg< uint32_t >  size,
Arg< void * >  buffer,
uint16_t  timeout = 0 
)
inline

◆ PipesToVec() [1/4]

void XrdCl::PipesToVec ( std::vector< Pipeline > &  )
inline

Helper function for converting parameter pack into a vector.

Referenced by Parallel(), PipesToVec(), PipesToVec(), and PipesToVec().

◆ PipesToVec() [2/4]

template<typename ... Others>
void XrdCl::PipesToVec ( std::vector< Pipeline > &  v,
Operation< false > &  operation,
Others &...  others 
)
inline

References PipesToVec().

◆ PipesToVec() [3/4]

template<typename ... Others>
void XrdCl::PipesToVec ( std::vector< Pipeline > &  v,
Operation< true > &  operation,
Others &...  others 
)
inline

References PipesToVec().

◆ PipesToVec() [4/4]

template<typename ... Others>
void XrdCl::PipesToVec ( std::vector< Pipeline > &  v,
Pipeline pipeline,
Others &...  others 
)
inline

References PipesToVec().

◆ PropertyList::Get< std::string >() [1/2]

template<>
std::string XrdCl::PropertyList::Get< std::string > ( const std::string &  name) const
inline

◆ PropertyList::Get< std::string >() [2/2]

template<>
bool XrdCl::PropertyList::Get< std::string > ( const std::string &  name,
std::string &  item 
) const
inline

◆ PropertyList::Get< std::vector< std::string > >()

template<>
bool XrdCl::PropertyList::Get< std::vector< std::string > > ( const std::string &  name,
std::vector< std::string > &  item 
) const
inline

◆ PropertyList::Set< std::vector< std::string > >()

template<>
void XrdCl::PropertyList::Set< std::vector< std::string > > ( const std::string &  name,
const std::vector< std::string > &  item 
)
inline

◆ RdWithRsp()

template<typename RSP >
ReadTrait< RSP >::RET XrdCl::RdWithRsp ( Ctx< File file,
Arg< uint64_t >  offset,
Arg< uint32_t >  size,
Arg< void * >  buffer,
uint16_t  timeout = 0 
)
inline

◆ RdWithRsp< ChunkInfo >()

template<>
ReadImpl< false > XrdCl::RdWithRsp< ChunkInfo > ( Ctx< File file,
Arg< uint64_t >  offset,
Arg< uint32_t >  size,
Arg< void * >  buffer,
uint16_t  timeout 
)
inline

◆ RdWithRsp< PageInfo >()

template<>
PgReadImpl< false > XrdCl::RdWithRsp< PageInfo > ( Ctx< File file,
Arg< uint64_t >  offset,
Arg< uint32_t >  size,
Arg< void * >  buffer,
uint16_t  timeout 
)
inline

◆ Read() [1/2]

ReadImpl< false > XrdCl::Read ( Ctx< File file,
Arg< uint64_t >  offset,
Arg< uint32_t >  size,
Arg< void * >  buffer,
uint16_t  timeout = 0 
)
inline

◆ Read() [2/2]

ZipReadImpl< false > XrdCl::Read ( Ctx< ZipArchive zip,
Arg< uint64_t >  offset,
Arg< uint32_t >  size,
Arg< void * >  buffer,
uint16_t  timeout = 0 
)
inline

Factory for creating ArchiveReadImpl objects.

References XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::Timeout().

◆ ReadFrom()

ZipReadFromImpl< false > XrdCl::ReadFrom ( Ctx< ZipArchive zip,
Arg< std::string >  fn,
Arg< uint64_t >  offset,
Arg< uint32_t >  size,
Arg< void * >  buffer,
uint16_t  timeout = 0 
)
inline

Factory for creating ArchiveReadImpl objects.

References XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::Timeout().

◆ SetUpLogging()

void XrdCl::SetUpLogging ( Log logger)

◆ SetXAttr() [1/4]

SetXAttrImpl< false > XrdCl::SetXAttr ( Ctx< File file,
Arg< std::string >  name,
Arg< std::string >  value 
)
inline

Factory for creating SetXAttrImpl objects (as there is another SetXAttr in FileSystem there would be a clash of typenames).

◆ SetXAttr() [2/4]

SetXAttrBulkImpl< false > XrdCl::SetXAttr ( Ctx< File file,
Arg< std::vector< xattr_t > >  attrs 
)
inline

Factory for creating SetXAttrBulkImpl objects (as there is another SetXAttr in FileSystem there would be a clash of typenames).

◆ SetXAttr() [3/4]

SetXAttrFsImpl< false > XrdCl::SetXAttr ( Ctx< FileSystem fs,
Arg< std::string >  path,
Arg< std::string >  name,
Arg< std::string >  value 
)
inline

Factory for creating SetXAttrFsImpl objects (as there is another SetXAttr in File there would be a clash of typenames).

◆ SetXAttr() [4/4]

SetXAttrFsBulkImpl< false > XrdCl::SetXAttr ( Ctx< FileSystem fs,
Arg< std::string >  path,
Arg< std::vector< xattr_t > >  attrs 
)
inline

Factory for creating SetXAttrFsBulkImpl objects (as there is another SetXAttr in FileSystem there would be a clash of typenames).

◆ Stat() [1/3]

StatImpl< false > XrdCl::Stat ( Ctx< File file,
Arg< bool >  force,
uint16_t  timeout = 0 
)
inline

Factory for creating StatImpl objects (as there is another Stat in FileSystem there would be a clash of typenames).

References XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::Timeout().

◆ Stat() [2/3]

StatFsImpl< false > XrdCl::Stat ( Ctx< FileSystem fs,
Arg< std::string >  path 
)
inline

◆ Stat() [3/3]

ZipStatImpl< false > XrdCl::Stat ( Ctx< ZipArchive zip)
inline

Factory for creating ZipStatImpl objects.

◆ Sync()

SyncImpl< false > XrdCl::Sync ( Ctx< File file,
uint16_t  timeout = 0 
)
inline

◆ To()

template<typename T >
T & XrdCl::To ( AnyObject any)
inline

Helper function for extracting an object from AnyObject

Parameters
any: an instance of AnyObject
Returns
: the underlying value of type T

References XrdCl::AnyObject::Get().

◆ to_lower()

static std::string XrdCl::to_lower ( std::string  str)
inlinestatic

◆ Truncate() [1/2]

TruncateImpl< false > XrdCl::Truncate ( Ctx< File file,
Arg< uint64_t >  size,
uint16_t  timeout 
)
inline

Factory for creating TruncateImpl objects (as there is another Stat in FileSystem there would be a clash of typenames).

References XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::Timeout().

◆ Truncate() [2/2]

TruncateFsImpl< false > XrdCl::Truncate ( Ctx< FileSystem fs,
Arg< std::string >  path,
Arg< uint64_t >  size 
)
inline

◆ tuple_call_impl()

template<typename FUNC , typename TUPL , int ... INDICES>
static auto XrdCl::tuple_call_impl ( FUNC &  func,
TUPL &  args,
sequence< INDICES... >   
) -> decltype( func( std::move( std::get<INDICES>( args ) )... ) )
inlinestatic

◆ VectorRead() [1/2]

VectorReadImpl< false > XrdCl::VectorRead ( Ctx< File file,
Arg< ChunkList chunks,
Arg< void * >  buffer,
uint16_t  timeout = 0 
)
inline

◆ VectorRead() [2/2]

VectorReadImpl< false > XrdCl::VectorRead ( Ctx< File file,
Arg< ChunkList chunks,
uint16_t  timeout = 0 
)
inline

◆ VectorWrite()

VectorWriteImpl< false > XrdCl::VectorWrite ( Ctx< File file,
Arg< ChunkList chunks,
uint16_t  timeout = 0 
)
inline

◆ WaitFor()

XRootDStatus XrdCl::WaitFor ( Pipeline  pipeline,
uint16_t  timeout = 0 
)
inline

Helper function, schedules execution of given pipeline and waits for the status

Parameters
pipeline: the pipeline to be executed
timeout: the pipeline timeout
Returns
: status of the operation

References Async().

◆ Write() [1/2]

WriteImpl< false > XrdCl::Write ( Ctx< File file,
Arg< uint64_t >  offset,
Arg< uint32_t >  size,
Arg< const void * >  buffer,
uint16_t  timeout = 0 
)
inline

◆ Write() [2/2]

ZipWriteImpl< false > XrdCl::Write ( Ctx< ZipArchive zip,
Arg< uint32_t >  size,
Arg< const void * >  buffer,
uint16_t  timeout = 0 
)
inline

Factory for creating ArchiveReadImpl objects.

References XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::Timeout().

◆ WriteV()

WriteVImpl< false > XrdCl::WriteV ( Ctx< File file,
Arg< uint64_t >  offset,
Arg< std::vector< iovec > >  iov,
uint16_t  timeout = 0 
)
inline

Variable Documentation

◆ AppMsg

const uint64_t XrdCl::AppMsg = 0x0000000000000001ULL

◆ AsyncSockMsg

const uint64_t XrdCl::AsyncSockMsg = 0x0000000000000200ULL

◆ DefaultAioSignal

const int XrdCl::DefaultAioSignal = 0

◆ DefaultClConfDir

const char* const XrdCl::DefaultClConfDir = ""

◆ DefaultClConfFile

const char* const XrdCl::DefaultClConfFile = ""

◆ 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 = 8388608

◆ DefaultCPInitTimeout

const int XrdCl::DefaultCPInitTimeout = 600

◆ DefaultCPParallelChunks

const int XrdCl::DefaultCPParallelChunks = 4

◆ DefaultCpRetry

const int XrdCl::DefaultCpRetry = 0

◆ DefaultCpRetryPolicy

const char* const XrdCl::DefaultCpRetryPolicy = "force"

◆ DefaultCpTarget

const char* const XrdCl::DefaultCpTarget = ""

◆ DefaultCPTimeout

const int XrdCl::DefaultCPTimeout = 0

◆ DefaultCPTPCTimeout

const int XrdCl::DefaultCPTPCTimeout = 1800

◆ DefaultCpUsePgWrtRd

const int XrdCl::DefaultCpUsePgWrtRd = 1

◆ DefaultDataServerTTL

const int XrdCl::DefaultDataServerTTL = 300

◆ DefaultGlfnRedirector

const char* const XrdCl::DefaultGlfnRedirector = ""

◆ DefaultIPNoShuffle

const int XrdCl::DefaultIPNoShuffle = 0

◆ DefaultLoadBalancerTTL

const int XrdCl::DefaultLoadBalancerTTL = 1200

◆ DefaultLocalMetalinkFile

const int XrdCl::DefaultLocalMetalinkFile = 0

◆ DefaultMaxMetalinkWait

const int XrdCl::DefaultMaxMetalinkWait = 60

◆ DefaultMetalinkProcessing

const int XrdCl::DefaultMetalinkProcessing = 1

◆ DefaultMultiProtocol

const int XrdCl::DefaultMultiProtocol = 0

◆ DefaultNetworkStack

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

◆ DefaultNoDelay

const int XrdCl::DefaultNoDelay = 1

◆ DefaultNotAuthorizedRetryLimit

const int XrdCl::DefaultNotAuthorizedRetryLimit = 3

◆ DefaultNoTlsOK

const int XrdCl::DefaultNoTlsOK = 0

◆ DefaultOpenRecovery

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

◆ DefaultParallelEvtLoop

const int XrdCl::DefaultParallelEvtLoop = 10

◆ DefaultPlugIn

const char* const XrdCl::DefaultPlugIn = ""

◆ DefaultPlugInConfDir

const char* const XrdCl::DefaultPlugInConfDir = ""

◆ DefaultPollerPreference

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

◆ DefaultPreferIPv4

const int XrdCl::DefaultPreferIPv4 = 0

◆ DefaultPreserveLocateTried

const int XrdCl::DefaultPreserveLocateTried = 1

◆ DefaultPreserveXAttrs

const int XrdCl::DefaultPreserveXAttrs = 0

◆ DefaultReadRecovery

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

◆ DefaultRedirectLimit

const int XrdCl::DefaultRedirectLimit = 16

◆ DefaultRequestTimeout

const int XrdCl::DefaultRequestTimeout = 1800

◆ DefaultRetryWrtAtLBLimit

const int XrdCl::DefaultRetryWrtAtLBLimit = 3

◆ DefaultRunForkHandler

const int XrdCl::DefaultRunForkHandler = 1

◆ 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

◆ DefaultTlsDbgLvl

const char* const XrdCl::DefaultTlsDbgLvl = "OFF"

◆ DefaultTlsMetalink

const int XrdCl::DefaultTlsMetalink = 0

◆ DefaultTlsNoData

const int XrdCl::DefaultTlsNoData = 0

◆ DefaultWantTlsOnNoPgrw

const int XrdCl::DefaultWantTlsOnNoPgrw = 0

◆ DefaultWorkerThreads

const int XrdCl::DefaultWorkerThreads = 3

◆ DefaultWriteRecovery

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

◆ DefaultXCpBlockSize

const int XrdCl::DefaultXCpBlockSize = 134217728

◆ DefaultXRateThreshold

const int XrdCl::DefaultXRateThreshold = 0

◆ DefaultZipMtlnCksum

const int XrdCl::DefaultZipMtlnCksum = 0

◆ 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

◆ errCorruptedHeader

const uint16_t XrdCl::errCorruptedHeader = 307

◆ errDataError

const uint16_t XrdCl::errDataError = 14

data is corrupted

Referenced by XrdCl::ZipCache::ToXRootDStatus().

◆ 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

◆ 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

◆ errInvalidRedirectURL

const uint16_t XrdCl::errInvalidRedirectURL = 302

◆ errInvalidResponse

const uint16_t XrdCl::errInvalidResponse = 303

◆ errInvalidSession

const uint16_t XrdCl::errInvalidSession = 109

◆ errLocalError

const uint16_t XrdCl::errLocalError = 402

◆ 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

◆ errNotSupported

const uint16_t XrdCl::errNotSupported = 13

◆ errOperationExpired

const uint16_t XrdCl::errOperationExpired = 206

◆ errOperationInterrupted

const uint16_t XrdCl::errOperationInterrupted = 207

◆ errOSError

const uint16_t XrdCl::errOSError = 12

◆ errPipelineFailed

const uint16_t XrdCl::errPipelineFailed = 17

Pipeline failed and operation couldn't be executed.

Referenced by XrdCl::FutureWrapperBase< Response >::~FutureWrapperBase().

◆ 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

◆ errThresholdExceeded

const uint16_t XrdCl::errThresholdExceeded = 208

◆ errTlsError

const uint16_t XrdCl::errTlsError = 110

◆ errUninitialized

const uint16_t XrdCl::errUninitialized = 11

◆ errUnknown

const uint16_t XrdCl::errUnknown = 2

Unknown error.

Referenced by XrdCl::ZipCache::ToXRootDStatus().

◆ errUnknownCommand

const uint16_t XrdCl::errUnknownCommand = 8

◆ ExDbgMsg

const uint64_t XrdCl::ExDbgMsg = 0x0000000000001000ULL

◆ FileMsg

const uint64_t XrdCl::FileMsg = 0x0000000000000004ULL

◆ FileSystemMsg

const uint64_t XrdCl::FileSystemMsg = 0x0000000000000100ULL

◆ JobMgrMsg

const uint64_t XrdCl::JobMgrMsg = 0x0000000000000400ULL

◆ kLogXrdClHttp

const uint64_t XrdCl::kLogXrdClHttp = std::numeric_limits<std::uint64_t>::max()
static

◆ none

struct XrdCl::None XrdCl::none
static

◆ 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::FileSystemPlugIn::ChMod(), XrdCl::FilePlugIn::Close(), XrdCl::ZipArchive::CloseFile(), XrdCl::FileSystemPlugIn::DeepLocate(), XrdCl::FileSystemPlugIn::DelXAttr(), XrdCl::FileSystemPlugIn::DirList(), XrdCl::FilePlugIn::Fcntl(), XrdCl::CheckSumHelper::GetCheckSumImpl(), XrdCl::ZipArchive::GetCRC32(), XrdCl::ZipArchive::GetOffset(), XrdCl::CheckSumHelper::GetRawCheckSum(), XrdCl::AsyncDiscardReader::GetResponse(), XrdCl::AsyncRawReader::GetResponse(), XrdCl::FileSystemPlugIn::GetXAttr(), XrdCl::FutureWrapper< Response >::HandleResponse(), XrdCl::CheckSumHelper::Initialize(), XrdCl::Status::IsError(), XrdCl::FileSystemPlugIn::ListXAttr(), XrdCl::EcHandler::LoadPlacement(), XrdCl::EcHandler::LoadPlacement(), XrdCl::FileSystemPlugIn::Locate(), XrdCl::FileSystemPlugIn::MkDir(), XrdCl::FileSystemPlugIn::Mv(), XrdCl::FilePlugIn::Open(), XrdCl::EcHandler::Open(), XrdCl::FilePlugIn::PgRead(), XrdCl::ZipArchive::PgRead(), XrdCl::FilePlugIn::PgWrite(), XrdCl::EcHandler::PgWrite(), XrdCl::FileSystemPlugIn::Ping(), XrdCl::FileSystemPlugIn::Prepare(), XrdCl::FileSystemPlugIn::Protocol(), XrdCl::FileSystemPlugIn::Query(), XrdCl::AsyncMsgReader::Read(), XrdCl::AsyncDiscardReader::Read(), XrdCl::AsyncRawReader::Read(), XrdCl::AsyncVectorReader::Read(), XrdCl::FilePlugIn::Read(), XrdCl::EcHandler::Read(), XrdCl::FilePlugIn::Read(), XrdCl::ZipArchive::Read(), XrdCl::FileSystemPlugIn::Rm(), XrdCl::FileSystemPlugIn::RmDir(), XrdCl::Operation< HasHndl >::Run(), XrdCl::FileSystemPlugIn::SendInfo(), XrdCl::FileSystemPlugIn::SetXAttr(), XrdCl::EcHandler::Stat(), XrdCl::FilePlugIn::Stat(), XrdCl::ZipArchive::Stat(), XrdCl::FileSystemPlugIn::Stat(), XrdCl::ZipArchive::Stat(), XrdCl::FileSystemPlugIn::StatVFS(), XrdCl::FilePlugIn::Sync(), XrdCl::ZipCache::ToXRootDStatus(), XrdCl::FileSystemPlugIn::Truncate(), XrdCl::FilePlugIn::Truncate(), XrdCl::FilePlugIn::VectorRead(), XrdCl::FilePlugIn::VectorWrite(), XrdCl::FilePlugIn::Visa(), XrdCl::MessageUtils::WaitForResponse(), XrdCl::ZipArchive::Write(), XrdCl::FilePlugIn::Write(), XrdCl::EcHandler::Write(), XrdCl::FilePlugIn::Write(), XrdCl::FilePlugIn::Write(), XrdCl::FilePlugIn::WriteV(), and XrdCl::FutureWrapperBase< Response >::~FutureWrapperBase().

◆ stFatal

const uint16_t XrdCl::stFatal = 0x0003

◆ 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

◆ suNotStarted

const uint16_t XrdCl::suNotStarted = 5

◆ suPartial

const uint16_t XrdCl::suPartial = 3

◆ suRetry

const uint16_t XrdCl::suRetry = 2

◆ TaskMgrMsg

const uint64_t XrdCl::TaskMgrMsg = 0x0000000000000040ULL

◆ theDefaultInts

std::unordered_map<std::string, int> XrdCl::theDefaultInts
static

◆ theDefaultStrs

std::unordered_map<std::string, std::string> XrdCl::theDefaultStrs
static
Initial value:
{
{ to_lower( "PollerPreference" ), DefaultPollerPreference },
{ to_lower( "NetworkStack" ), DefaultNetworkStack },
{ to_lower( "ClientMonitor" ), DefaultClientMonitor },
{ to_lower( "ClientMonitorParam" ), DefaultClientMonitorParam },
{ to_lower( "PlugInConfDir" ), DefaultPlugInConfDir },
{ to_lower( "PlugIn" ), DefaultPlugIn },
{ to_lower( "ReadRecovery" ), DefaultReadRecovery },
{ to_lower( "WriteRecovery" ), DefaultWriteRecovery },
{ to_lower( "OpenRecovery" ), DefaultOpenRecovery },
{ to_lower( "GlfnRedirector" ), DefaultGlfnRedirector },
{ to_lower( "TlsDbgLvl" ), DefaultTlsDbgLvl },
{ to_lower( "ClConfDir" ), DefaultClConfDir },
{ to_lower( "DefaultClConfFile" ), DefaultClConfFile },
{ to_lower( "CpTarget" ), DefaultCpTarget }
}
const char *const DefaultClConfFile
Definition XrdClConstants.hh:112
const char *const DefaultCpTarget
Definition XrdClConstants.hh:113
const char *const DefaultClConfDir
Definition XrdClConstants.hh:111
const char *const DefaultClientMonitorParam
Definition XrdClConstants.hh:103
const char *const DefaultOpenRecovery
Definition XrdClConstants.hh:108
const char *const DefaultPlugIn
Definition XrdClConstants.hh:105
const char *const DefaultPollerPreference
Definition XrdClConstants.hh:100
const char *const DefaultNetworkStack
Definition XrdClConstants.hh:101
static std::string to_lower(std::string str)
Definition XrdClConstants.hh:116
const char *const DefaultPlugInConfDir
Definition XrdClConstants.hh:104
const char *const DefaultReadRecovery
Definition XrdClConstants.hh:106
const char *const DefaultWriteRecovery
Definition XrdClConstants.hh:107
const char *const DefaultGlfnRedirector
Definition XrdClConstants.hh:109
const char *const DefaultTlsDbgLvl
Definition XrdClConstants.hh:110

◆ TlsMsg

const uint64_t XrdCl::TlsMsg = 0x0000000000002000ULL

◆ UtilityMsg

const uint64_t XrdCl::UtilityMsg = 0x0000000000000002ULL

◆ XRootDMsg

const uint64_t XrdCl::XRootDMsg = 0x0000000000000080ULL

◆ XRootDTransportMsg

const uint64_t XrdCl::XRootDTransportMsg = 0x0000000000000020ULL

◆ ZipMsg

const uint64_t XrdCl::ZipMsg = 0x0000000000004000ULL