#include <XrdOfs.hh>
|
int | open (const char *fileName, XrdSfsFileOpenMode openMode, mode_t createMode, const XrdSecEntity *client, const char *opaque=0) |
|
int | close () |
|
int | fctl (const int cmd, const char *args, XrdOucErrInfo &out_error) |
|
int | fctl (const int cmd, int alen, const char *args, const XrdSecEntity *client=0) |
|
const char * | FName () |
|
int | getMmap (void **Addr, off_t &Size) |
|
int | read (XrdSfsFileOffset fileOffset, XrdSfsXferSize amount) |
|
XrdSfsXferSize | read (XrdSfsFileOffset fileOffset, char *buffer, XrdSfsXferSize buffer_size) |
|
XrdSfsXferSize | readv (XrdOucIOVec *readV, int readCount) |
|
int | read (XrdSfsAio *aioparm) |
|
XrdSfsXferSize | write (XrdSfsFileOffset fileOffset, const char *buffer, XrdSfsXferSize buffer_size) |
|
int | write (XrdSfsAio *aioparm) |
|
int | sync () |
|
int | sync (XrdSfsAio *aiop) |
|
int | stat (struct stat *buf) |
|
int | truncate (XrdSfsFileOffset fileOffset) |
|
int | getCXinfo (char cxtype[4], int &cxrsz) |
|
| XrdOfsFile (const char *user, int MonID) |
|
| ~XrdOfsFile () |
|
virtual int | fctl (const int cmd, const char *args, XrdOucErrInfo &eInfo)=0 |
|
virtual int | fctl (const int cmd, int alen, const char *args, const XrdSecEntity *client=0) |
|
virtual int | SendData (XrdSfsDio *sfDio, XrdSfsFileOffset offset, XrdSfsXferSize size) |
|
virtual XrdSfsXferSize | writev (XrdOucIOVec *writeV, int wdvCnt) |
|
virtual void | setXio (XrdSfsXio *xioP) |
|
| XrdSfsFile (const char *user=0, int MonID=0) |
|
virtual | ~XrdSfsFile () |
| Destructor. More...
|
|
◆ XrdOfsFile()
XrdOfsFile::XrdOfsFile |
( |
const char * |
user, |
|
|
int |
MonID |
|
) |
| |
◆ ~XrdOfsFile()
XrdOfsFile::~XrdOfsFile |
( |
| ) |
|
|
inline |
◆ close()
int XrdOfsFile::close |
( |
| ) |
|
|
virtual |
◆ fctl() [1/4]
virtual int XrdSfsFile::fctl |
Execute a special operation on the file (version 1)
- Parameters
-
cmd | - The operation to be performed (see below). SFS_FCTL_GETFD Return file descriptor if possible SFS_FCTL_STATV Reserved for future use. |
args | - specific arguments to cmd SFS_FCTL_GETFD Set to zero. |
eInfo | - The object where error info or results are to be returned. This is legacy and the error onject may be used as well. |
- Returns
- If an error occurs or the operation is not support, SFS_ERROR should be returned with error.code set to errno. Otherwise, SFS_FCTL_GETFD error.code holds the real file descriptor number If the value is negative, sendfile() is not used. If the value is SFS_SFIO_FDVAL then the SendData() method is used for future read requests.
◆ fctl() [2/4]
int XrdOfsFile::fctl |
( |
const int |
cmd, |
|
|
const char * |
args, |
|
|
XrdOucErrInfo & |
eInfo |
|
) |
| |
|
virtual |
Execute a special operation on the file (version 1)
- Parameters
-
cmd | - The operation to be performed (see below). SFS_FCTL_GETFD Return file descriptor if possible SFS_FCTL_STATV Reserved for future use. |
args | - specific arguments to cmd SFS_FCTL_GETFD Set to zero. |
eInfo | - The object where error info or results are to be returned. This is legacy and the error onject may be used as well. |
- Returns
- If an error occurs or the operation is not support, SFS_ERROR should be returned with error.code set to errno. Otherwise, SFS_FCTL_GETFD error.code holds the real file descriptor number If the value is negative, sendfile() is not used. If the value is SFS_SFIO_FDVAL then the SendData() method is used for future read requests.
Implements XrdSfsFile.
◆ fctl() [3/4]
virtual int XrdSfsFile::fctl |
|
inline |
Execute a special operation on the file (version 2)
- Parameters
-
cmd | - The operation to be performed: SFS_FCTL_SPEC1 Perform implementation defined action |
alen | - Length of data pointed to by args. |
args | - Data sent with request, zero if alen is zero. |
client | - Client's identify (see common description). |
- Returns
- SFS_OK a null response is sent.
-
SFS_DATA error.code length of the data to be sent. error.message contains the data to be sent. o/w one of SFS_ERROR, SFS_REDIRECT, or SFS_STALL.
◆ fctl() [4/4]
int XrdOfsFile::fctl |
( |
const int |
cmd, |
|
|
int |
alen, |
|
|
const char * |
args, |
|
|
const XrdSecEntity * |
client = 0 |
|
) |
| |
|
virtual |
Execute a special operation on the file (version 2)
- Parameters
-
cmd | - The operation to be performed: SFS_FCTL_SPEC1 Perform implementation defined action |
alen | - Length of data pointed to by args. |
args | - Data sent with request, zero if alen is zero. |
client | - Client's identify (see common description). |
- Returns
- SFS_OK a null response is sent.
-
SFS_DATA error.code length of the data to be sent. error.message contains the data to be sent. o/w one of SFS_ERROR, SFS_REDIRECT, or SFS_STALL.
Reimplemented from XrdSfsFile.
◆ FName()
const char* XrdOfsFile::FName |
( |
| ) |
|
|
inlinevirtual |
◆ GenFWEvent()
void XrdOfsFile::GenFWEvent |
( |
| ) |
|
|
private |
◆ getCXinfo()
int XrdOfsFile::getCXinfo |
( |
char |
cxtype[4], |
|
|
int & |
cxrsz |
|
) |
| |
|
virtual |
Get compression information for the file.
- Parameters
-
cxtype | - Place where the compression algorithm name is to be placed |
cxrsz | - Place where the compression page size is to be returned |
- Returns
- One of the valid SFS return codes described above. If the file is not compressed or an error is returned, cxrsz must be set to 0.
Implements XrdSfsFile.
◆ getMmap()
int XrdOfsFile::getMmap |
( |
void ** |
Addr, |
|
|
off_t & |
Size |
|
) |
| |
|
virtual |
Get file's memory mapping if one exists (memory mapped files only).
- Parameters
-
addr | - Place where the starting memory address is returned. |
size | - Place where the file's size is returned. |
- Returns
- SFS_OK when the file is memory mapped or any other code otherwise.
Implements XrdSfsFile.
◆ open()
Open a file.
- Parameters
-
path | - Pointer to the path of the file to be opened. |
oMode | - Flags indicating how the open is to be handled. SFS_O_CREAT create the file SFS_O_MKPTH Make directory path if missing SFS_O_NOWAIT do not impose operational delays SFS_O_POSC persist only on successful close SFS_O_RAWIO allow client-side decompression SFS_O_RDONLY open read/only SFS_O_RDWR open read/write SFS_O_REPLICA Open for replication SFS_O_RESET Reset any cached information SFS_O_TRUNC truncate existing file to zero length SFS_O_WRONLY open write/only |
cMode | - The file's mode if it will be created. |
client | - Client's identify (see common description). |
opaque | - path's CGI information (see common description). |
- Returns
- One of SFS_OK, SFS_ERROR, SFS_REDIRECT, SFS_STALL, or SFS_STARTED
Implements XrdSfsFile.
◆ read() [1/3]
Read file bytes using asynchrnous I/O.
- Parameters
-
aioparm | - Pointer to async I/O object controlling the I/O. |
- Returns
- SFS_OK Request accepted and will be scheduled.
-
SFS_ERROR File could not be read, error holds the reason.
Implements XrdSfsFile.
◆ read() [2/3]
Read file bytes into a buffer.
- Parameters
-
offset | - The offset where the read is to start. |
buffer | - pointer to buffer where the bytes are to be placed. |
size | - The number of bytes to read. |
- Returns
- >= 0 The number of bytes that placed in buffer.
-
SFS_ERROR File could not be read, error holds the reason.
Implements XrdSfsFile.
◆ read() [3/3]
Preread file blocks into the file system cache.
- Parameters
-
offset | - The offset where the read is to start. |
size | - The number of bytes to pre-read. |
- Returns
- >= 0 The number of bytes that will be pre-read.
-
SFS_ERROR File could not be preread, error holds the reason.
Implements XrdSfsFile.
◆ readv()
Given an array of read requests (size rdvCnt), read them from the file and place the contents consecutively in the provided buffer. A dumb default implementation is supplied but should be replaced to increase performance.
- Parameters
-
readV | pointer to the array of read requests. |
rdvcnt | the number of elements in readV. |
- Returns
- >=0 The numbe of bytes placed into the buffer.
-
SFS_ERROR File could not be read, error holds the reason.
Reimplemented from XrdSfsFile.
◆ stat()
int XrdOfsFile::stat |
( |
struct stat * |
buf | ) |
|
|
virtual |
Return state information on the file.
- Parameters
-
buf | - Pointer to the structure where info it to be returned. |
- Returns
- One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL. When SFS_OK is returned, buf must hold stat information.
Implements XrdSfsFile.
◆ sync() [1/2]
Make sure all outstanding data is actually written to the file (sync).
- Returns
- One of SFS_OK, SFS_ERROR, SFS_REDIRECT, SFS_STALL, or SFS_STARTED
Implements XrdSfsFile.
◆ sync() [2/2]
Make sure all outstanding data is actually written to the file (async).
- Returns
- SFS_OK Request accepted and will be scheduled.
-
SFS_ERROR Request could not be accepted, return error has reason.
Implements XrdSfsFile.
◆ truncate()
Truncate the file.
- Parameters
-
fsize | - The size that the file is to have. |
- Returns
- One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL
Implements XrdSfsFile.
◆ write() [1/2]
Write file bytes using asynchrnous I/O.
- Parameters
-
aioparm | - Pointer to async I/O object controlling the I/O. |
- Returns
- 0 Request accepted and will be scheduled.
-
!0 Request not accepted, returned value is errno.
Implements XrdSfsFile.
◆ write() [2/2]
Write file bytes from a buffer.
- Parameters
-
offset | - The offset where the write is to start. |
buffer | - pointer to buffer where the bytes reside. |
size | - The number of bytes to write. |
- Returns
- >= 0 The number of bytes that were written.
-
SFS_ERROR File could not be written, error holds the reason.
Implements XrdSfsFile.
◆ dorawio
◆ myTPC
◆ oh
◆ tident
const char* XrdOfsFile::tident |
|
protected |
◆ viaDel
The documentation for this class was generated from the following file: