XrdOucFileInfo Class Reference

#include <XrdOucFileInfo.hh>

Collaboration diagram for XrdOucFileInfo:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void AddDigest (const char *hname, const char *hval)
void AddUrl (const char *url, const char *cntry=0, int prty=0, bool fifo=true)
void AddFileName (const char *filename)
void AddLfn (const char *lfn)
void AddProtocol (const char *protname)
const char * GetDigest (const char *&hval, bool xrdname=true)
const char * GetLfn ()
const char * GetTargetName ()
long long GetSize ()
const char * GetUrl (char *cntry=0, int *prty=0)
bool HasProtocol (const char *protname)
void SetSize (long long fsz)
 XrdOucFileInfo (const char *lfn=0)
 ~XrdOucFileInfo ()
 Destructor.

Public Attributes

XrdOucFileInfonextFile
 Link field to simply miltiple file processing.

Private Attributes

XrdOucFIHash * fHash
XrdOucFIHash * fHashNext
XrdOucFIUrl * fUrl
XrdOucFIUrl * fUrlNext
char * fLfn
char * fTargetName
long long fSize
std::string protList

Constructor & Destructor Documentation

XrdOucFileInfo::XrdOucFileInfo ( const char *  lfn = 0  )  [inline]

Constructor

Parameters:
lfn An optional logical file name associated with this file.

References fLfn.

XrdOucFileInfo::~XrdOucFileInfo (  ) 

Destructor.


Member Function Documentation

void XrdOucFileInfo::AddDigest ( const char *  hname,
const char *  hval 
)

Add a digest to the file descriptions.

Parameters:
hname Poiner to hash name.
hval Poiner to hash value.
void XrdOucFileInfo::AddFileName ( const char *  filename  ) 

Add target filename to the file descriptions.

Parameters:
filename Poiner to file name.
void XrdOucFileInfo::AddLfn ( const char *  lfn  ) 

Add logical filename to the file descriptions.

Parameters:
lfn Poiner to logical file name.
void XrdOucFileInfo::AddProtocol ( const char *  protname  ) 

Add protocol to the list of available protocols.

Parameters:
protname Poiner to protocol name ending with a colon
void XrdOucFileInfo::AddUrl ( const char *  url,
const char *  cntry = 0,
int  prty = 0,
bool  fifo = true 
)

Add a url to the file descriptions.

Parameters:
url Poiner to file url.
cntry Poiner to the optional 2-char null terminated country code. Upper case country codes are converted to lower case.
prty Selection priority. If less than 0 it is set to zero. Urls are placed in increasing prty order (0 is top priority).
fifo When true, the location is placed at the end of locations of equal pririoty. Otherwise, is is placed at the head.
const char* XrdOucFileInfo::GetDigest ( const char *&  hval,
bool  xrdname = true 
)

Obtain the next digest that can be used to validate the file.

Parameters:
hVal Place to put the pointer to the hash value in ASCII encoded hex,
xrdname When true the corresponding name expected by XRootD is returned
Returns:
Pointer to the hash name. The name and value are valid until this object is deleted. If no more hashes exist, a nil pointer is returned. A subsequent call will start at the front of the list.
const char* XrdOucFileInfo::GetLfn (  )  [inline]

Obtain the logical file name associated with this file.

Returns:
Pointer to the lfn. The lfn is valid until this object is deleted. A nil pointer indicates that no lfn has been specified.

References fLfn.

long long XrdOucFileInfo::GetSize (  )  [inline]

Get file size.

Returns:
The size of the file. If it is negative the size has not been set.

References fSize.

const char* XrdOucFileInfo::GetTargetName (  )  [inline]

Obtain the target file name.

Returns:
Pointer to the target file name. The target filename is valid until this object is deleted.

References fTargetName.

const char* XrdOucFileInfo::GetUrl ( char *  cntry = 0,
int *  prty = 0 
)

Obtain the next url for this file.

Parameters:
cntry If not nil, the null terminated country code is placed in the buffer which must be atleast three characters in size.
prty If not nil, the url's priority is placed in the int pointed to by this parameter.
Returns:
Pointer to the url. The url is valid until this object is deleted. If no more urls exist, a nil pointer is returned. A subsequent call will start at the front of teh list.
bool XrdOucFileInfo::HasProtocol ( const char *  protname  ) 

Check if protocol is in he list of protocols. This does not indicate that an actual url for the protocol was added to this object.

Parameters:
protname Poiner to protocol name ending with a colon
Returns:
true if the protocol was encountered and false otherwise.
void XrdOucFileInfo::SetSize ( long long  fsz  )  [inline]

Set file size.

Parameters:
fsz Supposed size of the file.

References fSize.


Member Data Documentation

XrdOucFIHash* XrdOucFileInfo::fHash [private]
XrdOucFIHash* XrdOucFileInfo::fHashNext [private]
char* XrdOucFileInfo::fLfn [private]

Referenced by GetLfn(), and XrdOucFileInfo().

long long XrdOucFileInfo::fSize [private]

Referenced by GetSize(), and SetSize().

char* XrdOucFileInfo::fTargetName [private]

Referenced by GetTargetName().

XrdOucFIUrl* XrdOucFileInfo::fUrl [private]
XrdOucFIUrl* XrdOucFileInfo::fUrlNext [private]

Link field to simply miltiple file processing.

std::string XrdOucFileInfo::protList [private]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 30 Sep 2019 for xrootd by  doxygen 1.6.1