Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
XFILE::CUPnPFile Class Reference

#include <UPnPFile.h>

Inheritance diagram for XFILE::CUPnPFile:
XFILE::IFile

Public Member Functions

 CUPnPFile ()
 
 ~CUPnPFile () override
 
bool Open (const CURL &url) override
 
bool Exists (const CURL &url) override
 
int Stat (const CURL &url, struct __stat64 *buffer) override
 
ssize_t Read (void *lpBuf, size_t uiBufSize) override
 
int64_t Seek (int64_t iFilePosition, int iWhence=SEEK_SET) override
 
void Close () override
 
int64_t GetPosition () override
 
int64_t GetLength () override
 
- Public Member Functions inherited from XFILE::IFile
 IFile ()
 
virtual ~IFile ()
 
virtual bool OpenForWrite (const CURL &url, bool bOverWrite=false)
 
virtual bool ReOpen (const CURL &url)
 
virtual int Stat (struct __stat64 *buffer)
 
virtual ssize_t Write (const void *bufPtr, size_t bufSize)
 
virtual bool ReadString (char *szLine, int iLineLength)
 
virtual void Flush ()
 
virtual int Truncate (int64_t size)
 
virtual int GetChunkSize ()
 
virtual double GetDownloadSpeed ()
 
virtual bool Delete (const CURL &url)
 
virtual bool Rename (const CURL &url, const CURL &urlnew)
 
virtual bool SetHidden (const CURL &url, bool hidden)
 
virtual int IoControl (EIoControl 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
 

Constructor & Destructor Documentation

◆ CUPnPFile()

CUPnPFile::CUPnPFile ( )
default

◆ ~CUPnPFile()

CUPnPFile::~CUPnPFile ( )
overridedefault

Member Function Documentation

◆ Close()

void XFILE::CUPnPFile::Close ( )
inlineoverridevirtual

Implements XFILE::IFile.

◆ Exists()

bool CUPnPFile::Exists ( const CURL & url)
overridevirtual

Implements XFILE::IFile.

◆ GetLength()

int64_t XFILE::CUPnPFile::GetLength ( )
inlineoverridevirtual

Implements XFILE::IFile.

◆ GetPosition()

int64_t XFILE::CUPnPFile::GetPosition ( )
inlineoverridevirtual

Implements XFILE::IFile.

◆ Open()

bool CUPnPFile::Open ( const CURL & url)
overridevirtual

Implements XFILE::IFile.

◆ Read()

ssize_t XFILE::CUPnPFile::Read ( void * bufPtr,
size_t bufSize )
inlineoverridevirtual

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

Parameters
bufPtrpointer to buffer
bufSizesize 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.

◆ Seek()

int64_t XFILE::CUPnPFile::Seek ( int64_t iFilePosition,
int iWhence = SEEK_SET )
inlineoverridevirtual

Implements XFILE::IFile.

◆ Stat()

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

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
urlspecifies requested file
bufferpointer to __stat64 buffer to receive information about file
Returns
zero of success, -1 otherwise.

Implements XFILE::IFile.


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