Go to the documentation of this file.
25 #ifndef __XRD_CL_FILE_STATE_HANDLER_HH__
26 #define __XRD_CL_FILE_STATE_HANDLER_HH__
47 class PgReadRetryHandler;
48 class PgReadSubstitutionHandler;
53 class ResponseHandlerHolder;
78 friend class ::PgReadHandler;
79 friend class ::PgReadRetryHandler;
80 friend class ::PgReadSubstitutionHandler;
129 uint16_t timeout = 0 );
140 uint16_t timeout = 0 );
155 uint16_t timeout = 0 );
178 uint16_t timeout = 0 );
198 uint16_t timeout = 0 );
216 PgReadHandler *handler,
217 uint16_t timeout = 0 );
239 uint16_t timeout = 0 );
256 uint16_t timeout = 0 );
272 uint16_t timeout = 0 );
293 uint16_t timeout = 0 );
305 uint16_t timeout = 0 );
318 uint16_t timeout = 0 );
333 uint16_t timeout = 0 );
346 uint16_t timeout = 0 );
360 const struct iovec *
iov,
363 uint16_t timeout = 0 );
379 uint16_t timeout = 0 );
392 uint16_t timeout = 0 );
408 uint16_t timeout = 0 );
424 uint16_t timeout = 0 );
440 uint16_t timeout = 0 );
454 uint16_t timeout = 0 );
502 bool SetProperty(
const std::string &name,
const std::string &value );
509 bool GetProperty(
const std::string &name, std::string &value )
const;
551 request(r), handler(h), params(p) {}
569 const std::vector<T> &attrs,
571 uint16_t timeout = 0 );
640 pOpenTime.tv_sec = 0; pOpenTime.tv_usec = 0;
673 std::unique_ptr<XrdSys::KernelBuffer> kbuff,
727 #endif // __XRD_CL_FILE_STATE_HANDLER_HH__
bool SetProperty(const std::string &name, const std::string &value)
XRootDStatus Truncate(uint64_t size, ResponseHandler *handler, uint16_t timeout=0)
Definition: XrdClMessageUtils.hh:132
Handle an async response.
Definition: XrdClXRootDResponses.hh:1037
XRootDStatus Stat(bool force, ResponseHandler *handler, uint16_t timeout=0)
Status RunRecovery()
Run the recovery procedure if appropriate.
Definition: XrdSysPthread.hh:166
Definition: XrdClLocalFileHandler.hh:33
XRootDStatus pStatus
Definition: XrdClFileStateHandler.hh:679
XRootDStatus pCloseReason
Definition: XrdClFileStateHandler.hh:712
Flags
PgRead flags.
Definition: XrdClFileStateHandler.hh:65
void Tick(time_t now)
Tick.
~FileStateHandler()
Destructor.
XRootDStatus GetXAttr(const std::vector< std::string > &attrs, ResponseHandler *handler, uint16_t timeout=0)
bool IsOpen() const
Check if the file is open.
RequestData()
Definition: XrdClFileStateHandler.hh:548
XRootDStatus ReOpenFileAtServer(const URL &url, uint16_t timeout)
Re-open the current file at a given server.
PgRead flags.
Definition: XrdClFileStateHandler.hh:60
void FailMessage(RequestData rd, XRootDStatus status)
Fail a message.
XRootDStatus Write(uint64_t offset, uint32_t size, const void *buffer, ResponseHandler *handler, uint16_t timeout=0)
XRootDStatus Sync(ResponseHandler *handler, uint16_t timeout=0)
URL * pLoadBalancer
Definition: XrdClFileStateHandler.hh:683
unsigned char kXR_char
Definition: XPtypes.hh:65
uint64_t pWBytes
Definition: XrdClFileStateHandler.hh:705
Handle the stateful operations.
Definition: XrdClFileStateHandler.hh:77
FileStatus pFileState
Definition: XrdClFileStateHandler.hh:678
URL * pDataServer
Definition: XrdClFileStateHandler.hh:682
bool IsReadOnly() const
Check if the file is open for read only.
ResponseHandlerHolder * pReOpenHandler
Definition: XrdClFileStateHandler.hh:718
void ResetMonitoringVars()
Reset monitoring vars.
Definition: XrdClFileStateHandler.hh:638
Status XAttrOperationImpl(kXR_char subcode, kXR_char options, const std::vector< T > &attrs, ResponseHandler *handler, uint16_t timeout=0)
RequestList pToBeRecovered
Definition: XrdClFileStateHandler.hh:689
XRootDStatus WriteKernelBuffer(uint64_t offset, uint32_t length, std::unique_ptr< XrdSys::KernelBuffer > kbuff, ResponseHandler *handler, uint16_t timeout)
Send a write request with payload being stored in a kernel buffer.
uint8_t * pFileHandle
Definition: XrdClFileStateHandler.hh:686
ResponseHandler * handler
Definition: XrdClFileStateHandler.hh:553
XRootDStatus IssueRequest(const URL &url, Message *msg, ResponseHandler *handler, MessageSendParams &sendParams)
@ OpenInProgress
Opening is in progress.
Definition: XrdClFileStateHandler.hh:92
The message representation used throughout the system.
Definition: XrdClMessage.hh:30
uint64_t pVSegs
Definition: XrdClFileStateHandler.hh:707
XRootDStatus SendClose(uint16_t timeout)
bool pFollowRedirects
Definition: XrdClFileStateHandler.hh:694
uint64_t pVRBytes
Definition: XrdClFileStateHandler.hh:704
void OnStateError(XRootDStatus *status, Message *message, ResponseHandler *userHandler, MessageSendParams &sendParams)
Handle an error while sending a stateful message.
void ReSendQueuedMessages()
Re-send queued messages.
uint64_t pVWCount
Definition: XrdClFileStateHandler.hh:711
XRootDStatus Fcntl(const Buffer &arg, ResponseHandler *handler, uint16_t timeout=0)
XRootDStatus PgRead(uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout=0)
Definition: XrdClFileStateHandler.hh:547
URL * pWrtRecoveryRedir
Definition: XrdClFileStateHandler.hh:685
void OnStateResponse(XRootDStatus *status, Message *message, AnyObject *response, HostList *hostList)
Handle stateful response.
XRootDStatus Write(uint64_t offset, Buffer &&buffer, ResponseHandler *handler, uint16_t timeout=0)
@ Closed
The file is closed.
Definition: XrdClFileStateHandler.hh:88
bool pIsChannelEncrypted
Definition: XrdClFileStateHandler.hh:696
bool GetProperty(const std::string &name, std::string &value) const
Request status.
Definition: XrdClXRootDResponses.hh:215
Message * request
Definition: XrdClFileStateHandler.hh:552
std::vector< ChunkInfo > ChunkList
List of chunks.
Definition: XrdClXRootDResponses.hh:966
StatInfo * pStatInfo
Definition: XrdClFileStateHandler.hh:680
bool pDoRecoverRead
Definition: XrdClFileStateHandler.hh:692
LocalFileHandler * pLFileHandler
Definition: XrdClFileStateHandler.hh:723
#define XRDOUC_ENUM_OPERATORS(T)
Definition: XrdOucEnum.hh:22
uint64_t pRBytes
Definition: XrdClFileStateHandler.hh:703
@ Retry
Definition: XrdClFileStateHandler.hh:67
uint64_t pSessionId
Definition: XrdClFileStateHandler.hh:691
RequestData(Message *r, ResponseHandler *h, const MessageSendParams &p)
Definition: XrdClFileStateHandler.hh:549
MessageSendParams params
Definition: XrdClFileStateHandler.hh:554
XRootDStatus Read(uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout=0)
void OnOpen(const XRootDStatus *status, const OpenInfo *openInfo, const HostList *hostList)
Process the results of the opening operation.
timeval pOpenTime
Definition: XrdClFileStateHandler.hh:702
XRootDStatus SetXAttr(const std::vector< xattr_t > &attrs, ResponseHandler *handler, uint16_t timeout=0)
@ Opened
Opening has succeeded.
Definition: XrdClFileStateHandler.hh:89
XRootDStatus Open(const std::string &url, uint16_t flags, uint16_t mode, ResponseHandler *handler, uint16_t timeout=0)
void OnStateRedirection(const std::string &redirectUrl, Message *message, ResponseHandler *userHandler, MessageSendParams &sendParams)
Handle stateful redirect.
Definition: XrdClOptional.hh:44
bool IsRecoverable(const XRootDStatus &stataus) const
Check if the stateful error is recoverable.
FileStatus
State of the file.
Definition: XrdClFileStateHandler.hh:87
Definition: XrdOucIOVec.hh:65
FileStateHandler(bool useVirtRedirector)
void AfterForkChild()
Called in the child process after the fork.
XRootDStatus VectorRead(const ChunkList &chunks, void *buffer, ResponseHandler *handler, uint16_t timeout=0)
void Lock()
Lock the internal lock.
Definition: XrdClFileStateHandler.hh:514
XRootDStatus ListXAttr(ResponseHandler *handler, uint16_t timeout=0)
URL * pStateRedirect
Definition: XrdClFileStateHandler.hh:684
Status SendOrQueue(const URL &url, Message *msg, ResponseHandler *handler, MessageSendParams &sendParams)
Send a message to a host or put it in the recovery queue.
@ Recovering
Recovering from an error.
Definition: XrdClFileStateHandler.hh:91
void MonitorClose(const XRootDStatus *status)
Dispatch monitoring information on close.
bool pUseVirtRedirector
Definition: XrdClFileStateHandler.hh:695
XRootDStatus PgReadRetry(uint64_t offset, uint32_t size, size_t pgnb, void *buffer, PgReadHandler *handler, uint16_t timeout=0)
@ Error
Opening has failed.
Definition: XrdClFileStateHandler.hh:90
XRootDStatus WriteV(uint64_t offset, const struct iovec *iov, int iovcnt, ResponseHandler *handler, uint16_t timeout=0)
Definition: XrdClAnyObject.hh:26
bool pDoRecoverWrite
Definition: XrdClFileStateHandler.hh:693
URL * pFileUrl
Definition: XrdClFileStateHandler.hh:681
uint64_t pVWBytes
Definition: XrdClFileStateHandler.hh:706
void TimeOutRequests(time_t now)
Declare timeout on requests being recovered.
XRootDStatus Close(ResponseHandler *handler, uint16_t timeout=0)
void FailQueuedMessages(XRootDStatus status)
Fail queued messages.
std::vector< HostInfo > HostList
Definition: XrdClXRootDResponses.hh:1031
static const int kXR_pgRetry
Definition: XProtocol.hh:482
void UnLock()
Unlock the internal lock.
Definition: XrdClFileStateHandler.hh:522
std::set< Message * > pInTheFly
Definition: XrdClFileStateHandler.hh:690
uint64_t pWCount
Definition: XrdClFileStateHandler.hh:710
uint16_t pOpenMode
Definition: XrdClFileStateHandler.hh:687
uint64_t pVRCount
Definition: XrdClFileStateHandler.hh:709
XRootDStatus PgReadImpl(uint64_t offset, uint32_t size, void *buffer, uint16_t flags, ResponseHandler *handler, uint16_t timeout=0)
Object stat info.
Definition: XrdClXRootDResponses.hh:396
std::list< RequestData > RequestList
Definition: XrdClFileStateHandler.hh:556
void ReWriteFileHandle(Message *msg)
Re-write file handle.
Information returned by file open operation.
Definition: XrdClXRootDResponses.hh:849
Procedure execution status.
Definition: XrdClStatus.hh:111
URL representation.
Definition: XrdClURL.hh:31
XRootDStatus Visa(ResponseHandler *handler, uint16_t timeout=0)
XRootDStatus DelXAttr(const std::vector< std::string > &attrs, ResponseHandler *handler, uint16_t timeout=0)
Status RecoverMessage(RequestData rd, bool callbackOnFailure=true)
Binary blob representation.
Definition: XrdClBuffer.hh:34
uint16_t pOpenFlags
Definition: XrdClFileStateHandler.hh:688
uint64_t pRCount
Definition: XrdClFileStateHandler.hh:708
XrdSysMutex pMutex
Definition: XrdClFileStateHandler.hh:677
FileStateHandler()
Constructor.
Definition: XrdClAnyObject.hh:33
XRootDStatus Write(uint64_t offset, uint32_t size, Optional< uint64_t > fdoff, int fd, ResponseHandler *handler, uint16_t timeout=0)
XRootDStatus VectorWrite(const ChunkList &chunks, ResponseHandler *handler, uint16_t timeout=0)
bool pAllowBundledClose
Definition: XrdClFileStateHandler.hh:697
void OnClose(const XRootDStatus *status)
Process the results of the closing operation.
none object for initializing empty Optional
Definition: XrdClOptional.hh:35