25 #ifndef __XRD_CL_FILE_STATE_HANDLER_HH__
26 #define __XRD_CL_FILE_STATE_HANDLER_HH__
48 class PgReadRetryHandler;
49 class PgReadSubstitutionHandler;
55 class ResponseHandlerHolder;
81 friend class ::PgReadHandler;
82 friend class ::PgReadRetryHandler;
83 friend class ::PgReadSubstitutionHandler;
84 friend class ::OpenHandler;
133 uint16_t timeout = 0 );
144 uint16_t timeout = 0 );
159 uint16_t timeout = 0 );
182 uint16_t timeout = 0 );
202 uint16_t timeout = 0 );
220 PgReadHandler *handler,
221 uint16_t timeout = 0 );
243 uint16_t timeout = 0 );
260 uint16_t timeout = 0 );
276 uint16_t timeout = 0 );
297 uint16_t timeout = 0 );
314 std::vector<uint32_t> &cksums,
316 uint16_t timeout = 0 );
335 uint16_t timeout = 0 );
353 std::vector<uint32_t> &cksums,
356 uint16_t timeout = 0 );
367 uint16_t timeout = 0 );
380 uint16_t timeout = 0 );
395 uint16_t timeout = 0 );
408 uint16_t timeout = 0 );
422 const struct iovec *
iov,
425 uint16_t timeout = 0 );
442 uint16_t timeout = 0 );
458 uint16_t timeout = 0 );
471 uint16_t timeout = 0 );
487 uint16_t timeout = 0 );
503 uint16_t timeout = 0 );
519 uint16_t timeout = 0 );
533 uint16_t timeout = 0 );
548 uint16_t timeout = 0 );
565 uint16_t timeout = 0 );
579 const struct iovec *
iov,
582 uint16_t timeout = 0 );
630 return pIsChannelEncrypted;
638 bool SetProperty(
const std::string &name,
const std::string &value );
645 bool GetProperty(
const std::string &name, std::string &value )
const;
692 request(r), handler(h), params(p) {}
710 const std::vector<T> &attrs,
712 uint16_t timeout = 0 );
781 pOpenTime.tv_sec = 0; pOpenTime.tv_usec = 0;
814 std::unique_ptr<XrdSys::KernelBuffer> kbuff,
unsigned char kXR_char
Definition: XPtypes.hh:65
#define XRDOUC_ENUM_OPERATORS(T)
Definition: XrdOucEnum.hh:22
Definition: XrdClAnyObject.hh:33
Binary blob representation.
Definition: XrdClBuffer.hh:34
An interface for file plug-ins.
Definition: XrdClPlugInInterface.hh:39
Handle the stateful operations.
Definition: XrdClFileStateHandler.hh:80
uint64_t pRBytes
Definition: XrdClFileStateHandler.hh:844
void OnStateRedirection(const std::string &redirectUrl, Message *message, ResponseHandler *userHandler, MessageSendParams &sendParams)
Handle stateful redirect.
Status SendOrQueue(const URL &url, Message *msg, ResponseHandler *handler, MessageSendParams &sendParams)
Send a message to a host or put it in the recovery queue.
XRootDStatus VectorWrite(const ChunkList &chunks, ResponseHandler *handler, uint16_t timeout=0)
ResponseHandlerHolder * pReOpenHandler
Definition: XrdClFileStateHandler.hh:859
URL * pDataServer
Definition: XrdClFileStateHandler.hh:823
std::set< Message * > pInTheFly
Definition: XrdClFileStateHandler.hh:831
void AfterForkChild()
Called in the child process after the fork.
XRootDStatus SetXAttr(const std::vector< xattr_t > &attrs, ResponseHandler *handler, uint16_t timeout=0)
URL * pStateRedirect
Definition: XrdClFileStateHandler.hh:825
FileStateHandler(bool useVirtRedirector, FilePlugIn *&plugin)
XRootDStatus ReadV(uint64_t offset, struct iovec *iov, int iovcnt, ResponseHandler *handler, uint16_t timeout=0)
void TimeOutRequests(time_t now)
Declare timeout on requests being recovered.
XRootDStatus VectorRead(const ChunkList &chunks, void *buffer, ResponseHandler *handler, uint16_t timeout=0)
XRootDStatus PgRead(uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout=0)
XRootDStatus Stat(bool force, ResponseHandler *handler, uint16_t timeout=0)
void ReWriteFileHandle(Message *msg)
Re-write file handle.
bool pDoRecoverRead
Definition: XrdClFileStateHandler.hh:833
XRootDStatus Read(uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout=0)
void Tick(time_t now)
Tick.
bool IsReadOnly() const
Check if the file is open for read only.
Status XAttrOperationImpl(kXR_char subcode, kXR_char options, const std::vector< T > &attrs, ResponseHandler *handler, uint16_t timeout=0)
bool pFollowRedirects
Definition: XrdClFileStateHandler.hh:835
XRootDStatus ChkptWrtV(uint64_t offset, const struct iovec *iov, int iovcnt, ResponseHandler *handler, uint16_t timeout=0)
void FailQueuedMessages(XRootDStatus status)
Fail queued messages.
std::list< RequestData > RequestList
Definition: XrdClFileStateHandler.hh:697
XRootDStatus WriteV(uint64_t offset, const struct iovec *iov, int iovcnt, ResponseHandler *handler, uint16_t timeout=0)
XRootDStatus Checkpoint(kXR_char code, ResponseHandler *handler, uint16_t timeout=0)
bool pIsChannelEncrypted
Definition: XrdClFileStateHandler.hh:837
XRootDStatus Sync(ResponseHandler *handler, uint16_t timeout=0)
XRootDStatus TryOtherServer(uint16_t timeout)
Try other data server.
XRootDStatus PgWrite(uint64_t offset, uint32_t size, const void *buffer, std::vector< uint32_t > &cksums, ResponseHandler *handler, uint16_t timeout=0)
XRootDStatus IssueRequest(const URL &url, Message *msg, ResponseHandler *handler, MessageSendParams &sendParams)
XRootDStatus PgWriteImpl(uint64_t offset, uint32_t size, const void *buffer, std::vector< uint32_t > &cksums, kXR_char flags, ResponseHandler *handler, uint16_t timeout=0)
XRootDStatus DelXAttr(const std::vector< std::string > &attrs, ResponseHandler *handler, uint16_t timeout=0)
uint64_t pVWBytes
Definition: XrdClFileStateHandler.hh:847
FileStateHandler(FilePlugIn *&plugin)
Constructor.
FilePlugIn *& pPlugin
Definition: XrdClFileStateHandler.hh:869
uint16_t pOpenFlags
Definition: XrdClFileStateHandler.hh:829
XrdSysMutex pMutex
Definition: XrdClFileStateHandler.hh:818
URL * pLoadBalancer
Definition: XrdClFileStateHandler.hh:824
XRootDStatus Write(uint64_t offset, uint32_t size, const void *buffer, ResponseHandler *handler, uint16_t timeout=0)
URL * pWrtRecoveryRedir
Definition: XrdClFileStateHandler.hh:826
XRootDStatus PgWriteRetry(uint64_t offset, uint32_t size, const void *buffer, uint32_t digest, ResponseHandler *handler, uint16_t timeout=0)
uint64_t pVSegs
Definition: XrdClFileStateHandler.hh:848
StatInfo * pStatInfo
Definition: XrdClFileStateHandler.hh:821
FileStatus
State of the file.
Definition: XrdClFileStateHandler.hh:91
@ OpenInProgress
Opening is in progress.
Definition: XrdClFileStateHandler.hh:96
@ Closed
The file is closed.
Definition: XrdClFileStateHandler.hh:92
@ Opened
Opening has succeeded.
Definition: XrdClFileStateHandler.hh:93
@ Error
Opening has failed.
Definition: XrdClFileStateHandler.hh:94
@ Recovering
Recovering from an error.
Definition: XrdClFileStateHandler.hh:95
void UnLock()
Unlock the internal lock.
Definition: XrdClFileStateHandler.hh:658
XRootDStatus Write(uint64_t offset, uint32_t size, Optional< uint64_t > fdoff, int fd, ResponseHandler *handler, uint16_t timeout=0)
RequestList pToBeRecovered
Definition: XrdClFileStateHandler.hh:830
void ResetMonitoringVars()
Reset monitoring vars.
Definition: XrdClFileStateHandler.hh:779
XRootDStatus pCloseReason
Definition: XrdClFileStateHandler.hh:853
uint64_t pVWCount
Definition: XrdClFileStateHandler.hh:852
XRootDStatus Truncate(uint64_t size, ResponseHandler *handler, uint16_t timeout=0)
uint64_t pVRBytes
Definition: XrdClFileStateHandler.hh:845
uint64_t pSessionId
Definition: XrdClFileStateHandler.hh:832
bool SetProperty(const std::string &name, const std::string &value)
bool pAllowBundledClose
Definition: XrdClFileStateHandler.hh:838
XRootDStatus SendClose(uint16_t timeout)
XRootDStatus GetXAttr(const std::vector< std::string > &attrs, ResponseHandler *handler, uint16_t timeout=0)
Status RunRecovery()
Run the recovery procedure if appropriate.
void OnClose(const XRootDStatus *status)
Process the results of the closing operation.
void OnStateError(XRootDStatus *status, Message *message, ResponseHandler *userHandler, MessageSendParams &sendParams)
Handle an error while sending a stateful message.
XRootDStatus Visa(ResponseHandler *handler, uint16_t timeout=0)
void OnStateResponse(XRootDStatus *status, Message *message, AnyObject *response, HostList *hostList)
Handle stateful response.
uint16_t pOpenMode
Definition: XrdClFileStateHandler.hh:828
XRootDStatus Write(uint64_t offset, Buffer &&buffer, ResponseHandler *handler, uint16_t timeout=0)
uint8_t * pFileHandle
Definition: XrdClFileStateHandler.hh:827
XRootDStatus ListXAttr(ResponseHandler *handler, uint16_t timeout=0)
XRootDStatus Fcntl(const Buffer &arg, ResponseHandler *handler, uint16_t timeout=0)
void OnOpen(const XRootDStatus *status, const OpenInfo *openInfo, const HostList *hostList)
Process the results of the opening operation.
XRootDStatus PgReadImpl(uint64_t offset, uint32_t size, void *buffer, uint16_t flags, ResponseHandler *handler, uint16_t timeout=0)
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.
XRootDStatus ChkptWrt(uint64_t offset, uint32_t size, const void *buffer, ResponseHandler *handler, uint16_t timeout=0)
uint64_t pRCount
Definition: XrdClFileStateHandler.hh:849
void MonitorClose(const XRootDStatus *status)
Dispatch monitoring information on close.
Status RecoverMessage(RequestData rd, bool callbackOnFailure=true)
bool pDoRecoverWrite
Definition: XrdClFileStateHandler.hh:834
bool IsRecoverable(const XRootDStatus &stataus) const
Check if the stateful error is recoverable.
uint64_t pVRCount
Definition: XrdClFileStateHandler.hh:850
XRootDStatus Close(ResponseHandler *handler, uint16_t timeout=0)
uint64_t pWBytes
Definition: XrdClFileStateHandler.hh:846
XRootDStatus pStatus
Definition: XrdClFileStateHandler.hh:820
XRootDStatus Open(const std::string &url, uint16_t flags, uint16_t mode, ResponseHandler *handler, uint16_t timeout=0)
bool IsSecure() const
Check if the file is using an encrypted connection.
Definition: XrdClFileStateHandler.hh:628
void FailMessage(RequestData rd, XRootDStatus status)
Fail a message.
~FileStateHandler()
Destructor.
bool GetProperty(const std::string &name, std::string &value) const
LocalFileHandler * pLFileHandler
Definition: XrdClFileStateHandler.hh:864
uint64_t pWCount
Definition: XrdClFileStateHandler.hh:851
XRootDStatus PgReadRetry(uint64_t offset, uint32_t size, size_t pgnb, void *buffer, PgReadHandler *handler, uint16_t timeout=0)
FileStatus pFileState
Definition: XrdClFileStateHandler.hh:819
bool pUseVirtRedirector
Definition: XrdClFileStateHandler.hh:836
timeval pOpenTime
Definition: XrdClFileStateHandler.hh:843
bool IsOpen() const
Check if the file is open.
XRootDStatus ReOpenFileAtServer(const URL &url, uint16_t timeout)
Re-open the current file at a given server.
void ReSendQueuedMessages()
Re-send queued messages.
void Lock()
Lock the internal lock.
Definition: XrdClFileStateHandler.hh:650
URL * pFileUrl
Definition: XrdClFileStateHandler.hh:822
Definition: XrdClLocalFileHandler.hh:33
The message representation used throughout the system.
Definition: XrdClMessage.hh:30
Information returned by file open operation.
Definition: XrdClXRootDResponses.hh:853
Definition: XrdClOptional.hh:44
Handle an async response.
Definition: XrdClXRootDResponses.hh:1117
Object stat info.
Definition: XrdClXRootDResponses.hh:400
URL representation.
Definition: XrdClURL.hh:31
Request status.
Definition: XrdClXRootDResponses.hh:219
Definition: XrdSysPthread.hh:165
Definition: XrdClAnyObject.hh:26
std::vector< HostInfo > HostList
Definition: XrdClXRootDResponses.hh:1111
std::vector< ChunkInfo > ChunkList
List of chunks.
Definition: XrdClXRootDResponses.hh:1046
static const int kXR_pgRetry
Definition: XProtocol.hh:498
Definition: XrdClFileStateHandler.hh:688
RequestData()
Definition: XrdClFileStateHandler.hh:689
Message * request
Definition: XrdClFileStateHandler.hh:693
RequestData(Message *r, ResponseHandler *h, const MessageSendParams &p)
Definition: XrdClFileStateHandler.hh:690
ResponseHandler * handler
Definition: XrdClFileStateHandler.hh:694
MessageSendParams params
Definition: XrdClFileStateHandler.hh:695
Definition: XrdClMessageUtils.hh:132
none object for initializing empty Optional
Definition: XrdClOptional.hh:35
PgRead flags.
Definition: XrdClFileStateHandler.hh:63
Flags
PgRead flags.
Definition: XrdClFileStateHandler.hh:68
@ Retry
Definition: XrdClFileStateHandler.hh:70
Procedure execution status.
Definition: XrdClStatus.hh:114
Definition: XrdOucIOVec.hh:65