xrootd
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
XrdClient Class Reference

#include <XrdClient.hh>

Inheritance diagram for XrdClient:
Inheritance graph
[legend]
Collaboration diagram for XrdClient:
Collaboration graph
[legend]

Public Member Functions

 XrdClient (const char *url, XrdClientCallback *XrdCcb=0, void *XrdCcbArg=0)
 
virtual ~XrdClient ()
 
UnsolRespProcResult ProcessUnsolicitedMsg (XrdClientUnsolMsgSender *sender, XrdClientMessage *unsolmsg)
 
bool Close ()
 
bool Sync ()
 
bool Copy (const char *localpath)
 
bool GetCacheInfo (int &size, long long &bytessubmitted, long long &byteshit, long long &misscount, float &missrate, long long &readreqcnt, float &bytesusefulness)
 
bool GetCounters (XrdClientCounters *cnt)
 
bool IsOpen ()
 
bool IsOpen_inprogress ()
 
bool IsOpen_wait ()
 
bool Open (kXR_unt16 mode, kXR_unt16 options, bool doitparallel=true)
 
int Read (void *buf, long long offset, int len)
 
kXR_int64 ReadV (char *buf, long long *offsets, int *lens, int nbuf)
 
XReqErrorType Read_Async (long long offset, int len, bool updatecounters=true)
 
bool Stat (struct XrdClientStatInfo *stinfo, bool force=false)
 
bool UseCache (bool u=true)
 
void RemoveAllDataFromCache ()
 
void RemoveDataFromCache (long long begin_offs, long long end_offs, bool remove_overlapped=false)
 
void SetCacheParameters (int CacheSize, int ReadAheadSize, int RmPolicy)
 
void SetReadAheadStrategy (int strategy)
 
void SetBlockReadTrimming (int blocksize)
 
bool Truncate (long long len)
 
bool Write (const void *buf, long long offset, int len)
 
- Public Member Functions inherited from XrdClientAbs
 XrdClientAbs (XrdClientCallback *XrdCcb=0, void *XrdCcbArg=0)
 
void SetParm (const char *parm, int val)
 
void SetParm (const char *parm, double val)
 
XrdClientConnGetClientConn () const
 
XrdClientUrlInfo GetCurrentUrl ()
 
struct ServerResponseHeaderLastServerResp ()
 
struct ServerResponseBody_ErrorLastServerError ()
 
bool Query (kXR_int16 ReqCode, const kXR_char *Args, kXR_char *Resp, kXR_int32 MaxResplen)
 
bool Query (kXR_int16 ReqCode, const kXR_char *Args, kXR_char **Resp, kXR_int32 MaxResplen)
 
- Public Member Functions inherited from XrdClientAbsUnsolMsgHandler
virtual ~XrdClientAbsUnsolMsgHandler ()
 

Public Attributes

std::vector< std::string > fExcludedHosts
 

Protected Member Functions

virtual bool OpenFileWhenRedirected (char *newfhandle, bool &wasopen)
 
virtual bool CanRedirOnError ()
 

Protected Attributes

XrdClientCounters fCounters
 
- Protected Attributes inherited from XrdClientAbs
XrdClientConnfConnModule
 
char fHandle [4]
 
XrdClientCallbackfXrdCcb
 
void * fXrdCcbArg
 

Private Member Functions

bool TryOpen (kXR_unt16 mode, kXR_unt16 options, bool doitparallel)
 
bool LowOpen (const char *file, kXR_unt16 mode, kXR_unt16 options, char *additionalquery=0)
 
void TerminateOpenAttempt ()
 
void WaitForNewAsyncData ()
 
kXR_int64 ReadVEach (char *buf, kXR_int64 *offsets, int *lens, int &nbuf)
 
bool IsOpenedForWrite ()
 
void PrintCounters ()
 

Private Attributes

struct XrdClientOpenInfo fOpenPars
 
XrdSysCondVarfOpenProgCnd
 
XrdClientThreadfOpenerTh
 
bool fOpenWithRefresh
 
XrdSysCondVarfReadWaitData
 
struct XrdClientStatInfo fStatInfo
 
long fReadTrimBlockSize
 
bool fUseCache
 
XrdOucString fInitialUrl
 
XrdClientUrlInfo fUrl
 
XrdClientReadAheadMgrfReadAheadMgr
 

Static Private Attributes

static XrdSysSemWait fConcOpenSem
 

Friends

void * FileOpenerThread (void *, XrdClientThread *)
 

Constructor & Destructor Documentation

◆ XrdClient()

XrdClient::XrdClient ( const char *  url,
XrdClientCallback XrdCcb = 0,
void *  XrdCcbArg = 0 
)

◆ ~XrdClient()

virtual XrdClient::~XrdClient ( )
virtual

Member Function Documentation

◆ CanRedirOnError()

virtual bool XrdClient::CanRedirOnError ( )
inlineprotectedvirtual

◆ Close()

bool XrdClient::Close ( )

◆ Copy()

bool XrdClient::Copy ( const char *  localpath)

◆ GetCacheInfo()

bool XrdClient::GetCacheInfo ( int &  size,
long long &  bytessubmitted,
long long &  byteshit,
long long &  misscount,
float &  missrate,
long long &  readreqcnt,
float &  bytesusefulness 
)

◆ GetCounters()

bool XrdClient::GetCounters ( XrdClientCounters cnt)

◆ IsOpen()

bool XrdClient::IsOpen ( )
inline

◆ IsOpen_inprogress()

bool XrdClient::IsOpen_inprogress ( )

◆ IsOpen_wait()

bool XrdClient::IsOpen_wait ( )
virtual

Reimplemented from XrdClientAbs.

◆ IsOpenedForWrite()

bool XrdClient::IsOpenedForWrite ( )
inlineprivate

◆ LowOpen()

bool XrdClient::LowOpen ( const char *  file,
kXR_unt16  mode,
kXR_unt16  options,
char *  additionalquery = 0 
)
private

◆ Open()

bool XrdClient::Open ( kXR_unt16  mode,
kXR_unt16  options,
bool  doitparallel = true 
)

◆ OpenFileWhenRedirected()

virtual bool XrdClient::OpenFileWhenRedirected ( char *  newfhandle,
bool &  wasopen 
)
protectedvirtual

Implements XrdClientAbs.

◆ PrintCounters()

void XrdClient::PrintCounters ( )
private

◆ ProcessUnsolicitedMsg()

UnsolRespProcResult XrdClient::ProcessUnsolicitedMsg ( XrdClientUnsolMsgSender sender,
XrdClientMessage unsolmsg 
)
virtual

◆ Read()

int XrdClient::Read ( void *  buf,
long long  offset,
int  len 
)

◆ Read_Async()

XReqErrorType XrdClient::Read_Async ( long long  offset,
int  len,
bool  updatecounters = true 
)

◆ ReadV()

kXR_int64 XrdClient::ReadV ( char *  buf,
long long *  offsets,
int *  lens,
int  nbuf 
)

◆ ReadVEach()

kXR_int64 XrdClient::ReadVEach ( char *  buf,
kXR_int64 offsets,
int *  lens,
int &  nbuf 
)
private

◆ RemoveAllDataFromCache()

void XrdClient::RemoveAllDataFromCache ( )

◆ RemoveDataFromCache()

void XrdClient::RemoveDataFromCache ( long long  begin_offs,
long long  end_offs,
bool  remove_overlapped = false 
)

◆ SetBlockReadTrimming()

void XrdClient::SetBlockReadTrimming ( int  blocksize)

◆ SetCacheParameters()

void XrdClient::SetCacheParameters ( int  CacheSize,
int  ReadAheadSize,
int  RmPolicy 
)

◆ SetReadAheadStrategy()

void XrdClient::SetReadAheadStrategy ( int  strategy)

◆ Stat()

bool XrdClient::Stat ( struct XrdClientStatInfo stinfo,
bool  force = false 
)

◆ Sync()

bool XrdClient::Sync ( )

◆ TerminateOpenAttempt()

void XrdClient::TerminateOpenAttempt ( )
private

◆ Truncate()

bool XrdClient::Truncate ( long long  len)

◆ TryOpen()

bool XrdClient::TryOpen ( kXR_unt16  mode,
kXR_unt16  options,
bool  doitparallel 
)
private

◆ UseCache()

bool XrdClient::UseCache ( bool  u = true)

◆ WaitForNewAsyncData()

void XrdClient::WaitForNewAsyncData ( )
private

◆ Write()

bool XrdClient::Write ( const void *  buf,
long long  offset,
int  len 
)

Friends And Related Function Documentation

◆ FileOpenerThread

void* FileOpenerThread ( void *  ,
XrdClientThread  
)
friend

Member Data Documentation

◆ fConcOpenSem

XrdSysSemWait XrdClient::fConcOpenSem
staticprivate

◆ fCounters

XrdClientCounters XrdClient::fCounters
protected

◆ fExcludedHosts

std::vector<std::string> XrdClient::fExcludedHosts

◆ fInitialUrl

XrdOucString XrdClient::fInitialUrl
private

◆ fOpenerTh

XrdClientThread* XrdClient::fOpenerTh
private

◆ fOpenPars

struct XrdClientOpenInfo XrdClient::fOpenPars
private

◆ fOpenProgCnd

XrdSysCondVar* XrdClient::fOpenProgCnd
private

◆ fOpenWithRefresh

bool XrdClient::fOpenWithRefresh
private

◆ fReadAheadMgr

XrdClientReadAheadMgr* XrdClient::fReadAheadMgr
private

◆ fReadTrimBlockSize

long XrdClient::fReadTrimBlockSize
private

◆ fReadWaitData

XrdSysCondVar* XrdClient::fReadWaitData
private

◆ fStatInfo

struct XrdClientStatInfo XrdClient::fStatInfo
private

◆ fUrl

XrdClientUrlInfo XrdClient::fUrl
private

◆ fUseCache

bool XrdClient::fUseCache
private

The documentation for this class was generated from the following file: