XFILE::CWinLibraryFile Class Reference

#include <WinLibraryFile.h>

Inheritance diagram for XFILE::CWinLibraryFile:

Public Member Functions
	CWinLibraryFile ()
virtual	~CWinLibraryFile (void)
virtual bool	Open (const CURL &url)
virtual bool	OpenForWrite (const CURL &url, bool bOverWrite=false)
virtual void	Close ()
virtual ssize_t	Read (void *lpBuf, size_t uiBufSize)
virtual ssize_t	Write (const void *lpBuf, size_t uiBufSize)
virtual int64_t	Seek (int64_t iFilePosition, int iWhence=SEEK_SET)
virtual int	Truncate (int64_t toSize)
virtual int64_t	GetPosition ()
virtual int64_t	GetLength ()
virtual void	Flush ()
virtual bool	Delete (const CURL &url)
virtual bool	Rename (const CURL &urlCurrentName, const CURL &urlNewName)
virtual bool	SetHidden (const CURL &url, bool hidden)
virtual bool	Exists (const CURL &url)
virtual int	Stat (const CURL &url, struct __stat64 *statData)
	Fills struct __stat64 with information about file specified by url.
virtual int	Stat (struct __stat64 *statData)
Public Member Functions inherited from XFILE::IFile
	IFile ()
virtual	~IFile ()
virtual bool	ReOpen (const CURL &url)
virtual ReadLineResult	ReadLine (char *buffer, std::size_t bufferSize)
virtual int	GetChunkSize ()
virtual double	GetDownloadSpeed ()
virtual int	IoControl (IOControl request, void *param)
virtual const std::string	GetProperty (XFILE::FileProperty type, const std::string &name="") const
virtual const std::vector< std::string >	GetPropertyValues (XFILE::FileProperty type, const std::string &name="") const

Static Public Member Functions
static IFile *	Get (const CURL &url)
static bool	IsValid (const CURL &url)
static bool	IsInAccessList (const CURL &url)

Constructor & Destructor Documentation

CWinLibraryFile()

CWinLibraryFile::CWinLibraryFile ( )

default

~CWinLibraryFile()

CWinLibraryFile::~CWinLibraryFile ( void )

virtualdefault

Member Function Documentation

Close()

void CWinLibraryFile::Close ( )

virtual

Implements XFILE::IFile.

Delete()

bool CWinLibraryFile::Delete ( const CURL & url )

virtual

Reimplemented from XFILE::IFile.

Exists()

bool CWinLibraryFile::Exists ( const CURL & url )

virtual

Implements XFILE::IFile.

Flush()

void CWinLibraryFile::Flush ( )

virtual

Reimplemented from XFILE::IFile.

Get()

static IFile * XFILE::CWinLibraryFile::Get ( const CURL & url )

static

GetLength()

int64_t CWinLibraryFile::GetLength ( )

virtual

Implements XFILE::IFile.

GetPosition()

int64_t CWinLibraryFile::GetPosition ( )

virtual

Implements XFILE::IFile.

IsInAccessList()

bool CWinLibraryFile::IsInAccessList ( const CURL & url )

static

IsValid()

bool CWinLibraryFile::IsValid ( const CURL & url )

static

Open()

bool CWinLibraryFile::Open ( const CURL & url )

virtual

Implements XFILE::IFile.

OpenForWrite()

bool CWinLibraryFile::OpenForWrite ( const CURL & url, bool bOverWrite = false )

virtual

Reimplemented from XFILE::IFile.

Read()

ssize_t CWinLibraryFile::Read ( void * bufPtr, size_t bufSize )

virtual

Attempt to read bufSize bytes from currently opened file into buffer bufPtr.

Parameters

bufPtr	pointer to buffer
bufSize	size of the buffer

Returns

number of successfully read bytes if any bytes were read and stored in buffer, zero if no bytes are available to read (end of file was reached) or undetectable error occur, -1 in case of any explicit error

Implements XFILE::IFile.

Rename()

bool CWinLibraryFile::Rename ( const CURL & urlCurrentName, const CURL & urlNewName )

virtual

Reimplemented from XFILE::IFile.

Seek()

int64_t CWinLibraryFile::Seek ( int64_t iFilePosition, int iWhence = SEEK_SET )

virtual

Implements XFILE::IFile.

SetHidden()

bool CWinLibraryFile::SetHidden ( const CURL & url, bool hidden )

virtual

Reimplemented from XFILE::IFile.

Stat() [1/2]

int CWinLibraryFile::Stat ( const CURL & url, struct __stat64 * buffer )

virtual

Fills struct __stat64 with information about file specified by url.

For st_mode function will set correctly _S_IFDIR (directory) flag and may set _S_IREAD (read permission), _S_IWRITE (write permission) flags if such information is available. Function may set st_size (file size), st_atime, st_mtime, st_ctime (access, modification, creation times). Any other flags and members of __stat64 that didn't updated with actual file information will be set to zero (st_nlink can be set ether to 1 or zero).

Parameters

[in]	url	specifies requested file. Ends with a directory separator for directories.
[out]	buffer	pointer to __stat64 buffer to receive information about file

Returns

zero for success, -1 otherwise.

Implements XFILE::IFile.

Stat() [2/2]

int CWinLibraryFile::Stat ( struct __stat64 * buffer )

virtual

Fills struct __stat64 with information about currently open file For st_mode function will set correctly _S_IFDIR (directory) flag and may set _S_IREAD (read permission), _S_IWRITE (write permission) flags if such information is available. Function may set st_size (file size), st_atime, st_mtime, st_ctime (access, modification, creation times). Any other flags and members of __stat64 that didn't updated with actual file information will be set to zero (st_nlink can be set ether to 1 or zero).

Parameters

buffer

pointer to __stat64 buffer to receive information about file

Returns

zero of success, -1 otherwise.

Reimplemented from XFILE::IFile.

Truncate()

int CWinLibraryFile::Truncate ( int64_t toSize )

virtual

Reimplemented from XFILE::IFile.

Write()

ssize_t CWinLibraryFile::Write ( const void * bufPtr, size_t bufSize )

virtual

Attempt to write bufSize bytes from buffer bufPtr into currently opened file.

Parameters

bufPtr	pointer to buffer
bufSize	size of the buffer

Returns

number of successfully written bytes if any bytes were written, zero if no bytes were written and no detectable error occur, -1 in case of any explicit error

Reimplemented from XFILE::IFile.

---

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

• WinLibraryFile.h
• WinLibraryFile.cpp