4. XRootD.client.responses: Server response objects

This page documents the various response objects that are returned by making requests to an XRootD server.

class XRootD.client.responses.XRootDStatus[source]

Status of a request. Returned with all requests.

  • message – Message describing the status of this request
  • ok – The request was successful
  • error – Error making request
  • fatal – Fatal error making request
  • status – Status of the request
  • code – Error type, or additional hints on what to do
  • shellcode – Status code that may be returned to the shell
  • errno – Errno, if any
class XRootD.client.responses.DirectoryList[source]

Directory listing.

This object is iterable:

>>> status, dirlist = filesystem.dirlist('/tmp', DirListFlags.STAT)
>>> print dirlist
<XRootD.client.responses.DirectoryList object at 0x288b9f0>
>>> print 'Entries:', dirlist.size
Entries: 2
>>> for item in dirlist:
...   print item.name, item.statinfo.size
spam 1024
eggs 2048
  • size – The size of this listing (number of entries)
  • parent – The name of the parent directory of this directory
  • dirlist – (List of XRootD.client.responses.ListEntry objects) - The list of directory entries
class XRootD.client.responses.ListEntry[source]

An entry in a directory listing.

  • name – The name of the file/directory
  • hostaddr – The address of the host on which this file/directory lives
  • statinfo – (Instance of XRootD.client.responses.StatInfo) - Status information about this file/directory. You must pass DirListFlags.STAT with the call to XRootD.client.FileSystem.dirlist() to retrieve status information.
class XRootD.client.responses.StatInfo[source]

Status information for files and directories.

  • id – This file’s unique identifier
  • flags – Informational flags. An ORed combination of XRootD.client.flags.StatInfoFlags
  • size – The file size (in bytes)
  • modtime – Modification time (in seconds since epoch)
  • modtimestr – Modification time (as readable string)
class XRootD.client.responses.StatInfoVFS[source]

Status information for Virtual File Systems.

  • nodes_rw – Number of nodes that can provide read/write space
  • free_rw – Size of the largest contiguous area of free r/w space (in MB)
  • utilization_rw – Percentage of the partition utilization represented by free_rw
  • nodes_staging – Number of nodes that can provide staging space
  • free_staging – Size of the largest contiguous area of free staging space (in MB)
  • utilization_staging – Percentage of the partition utilization represented by free_staging
class XRootD.client.responses.VectorReadInfo[source]

Vector read response object. Returned by XRootD.client.File.vector_read().

This object is iterable:

>>> f.open('root://localhost/tmp/spam')
>>> status, chunks = file.vector_read([(0, 10), (10, 10)])
>>> print chunks
<XRootD.client.responses.VectorReadInfo object at 0x288b9f0>
>>> print chunks.size
>>> for chunk in chunks:
...   print chunk.offset, chunk.length
0 10
10 10
class XRootD.client.responses.ChunkInfo[source]

Describes a data chunk for a vector read.

  • offset – The offset in the file from which this chunk came
  • length – The length of this chunk
  • buffer – The actual chunk data
class XRootD.client.responses.LocationInfo[source]

Path location information (a list of discovered file locations).

Parameters:locations – (List of XRootD.client.responses.Location objects) List of discovered locations

This object is iterable:

>>> status, locations = filesystem.locate('/tmp', OpenFlags.REFRESH)
>>> print locations
<XRootD.client.responses.LocationInfo object at 0x288b9f0>
>>> for location in locations:
...   print location.address
class XRootD.client.responses.Location[source]

Information about a single location.

class XRootD.client.responses.HostList[source]

A list of hosts that were involved in the request.

This object is iterable:

>>> print hostlist
<XRootD.client.responses.HostList object at 0x288b9f0>
>>> for host in hostlist:
...   print host.url
Variables:hosts – (List of XRootD.client.responses.HostInfo objects) - The list of hosts
class XRootD.client.responses.HostInfo[source]

Information about a single host.

  • url – URL of the host, instance of XRootD.client.URL
  • protocol – Version of the protocol the host is speaking
  • flags – Host type, an ORed combination of XRootD.client.flags.HostTypes
  • load_balancer – Was the host used as a load balancer
class XRootD.client.responses.ProtocolInfo[source]

Protocol information for a server.

  • version – The version of the protocol this server is speaking
  • hostinfo – Informational flags for this host. An ORed combination of XRootD.client.flags.HostTypes

Previous topic

3. XRootD.client.CopyProcess: Copying files

Next topic

5. XRootD.client.flags: Flags and constants

This Page