kodi
Classes | Public Member Functions | Protected Attributes | List of all members
ADDON::CVFSEntry Class Reference

A virtual filesystem entry add-on. More...

#include <VFSEntry.h>

Inheritance diagram for ADDON::CVFSEntry:
Inheritance graph
[legend]
Collaboration diagram for ADDON::CVFSEntry:
Collaboration graph
[legend]

Classes

struct  ProtocolInfo
 A structure encapsulating properties of supplied protocol. More...
 

Public Member Functions

 CVFSEntry (const AddonInfoPtr &addonInfo)
 Construct from add-on properties. More...
 
void * Open (const CURL &url)
 
void * OpenForWrite (const CURL &url, bool bOverWrite)
 
bool Exists (const CURL &url)
 
int Stat (const CURL &url, struct __stat64 *buffer)
 
ssize_t Read (void *ctx, void *lpBuf, size_t uiBufSize)
 
ssize_t Write (void *ctx, const void *lpBuf, size_t uiBufSize)
 
int64_t Seek (void *ctx, int64_t iFilePosition, int iWhence=SEEK_SET)
 
int Truncate (void *ctx, int64_t size)
 
void Close (void *ctx)
 
int64_t GetPosition (void *ctx)
 
int64_t GetLength (void *ctx)
 
int GetChunkSize (void *ctx)
 
int IoControl (void *ctx, XFILE::EIoControl request, void *param)
 
bool Delete (const CURL &url)
 
bool Rename (const CURL &url, const CURL &url2)
 
bool GetDirectory (const CURL &url, CFileItemList &items, void *ctx)
 
bool DirectoryExists (const CURL &url)
 
bool RemoveDirectory (const CURL &url)
 
bool CreateDirectory (const CURL &url)
 
void ClearOutIdle ()
 
void DisconnectAll ()
 
bool ContainsFiles (const CURL &url, CFileItemList &items)
 
const std::string & GetProtocols () const
 
const std::string & GetExtensions () const
 
bool HasFiles () const
 
bool HasDirectories () const
 
bool HasFileDirectories () const
 
const std::string & GetZeroconfType () const
 
const ProtocolInfoGetProtocolInfo () const
 
- Public Member Functions inherited from ADDON::IAddonInstanceHandler
 IAddonInstanceHandler (ADDON_TYPE type, const AddonInfoPtr &addonInfo, AddonInstanceId instanceId=ADDON_INSTANCE_ID_UNUSED, KODI_HANDLE parentInstance=nullptr, const std::string &uniqueWorkID="")
 Class constructor for handling add-on instance processes, allowing an add-on to handle multiple work simultaneously and independently. More...
 
ADDON_TYPE UsedType () const
 
AddonInstanceId InstanceId () const
 
const std::string & UniqueWorkID ()
 
std::string ID () const
 
std::string Name () const
 
std::string Author () const
 
std::string Icon () const
 
std::string Path () const
 
std::string Profile () const
 
CAddonVersion Version () const
 
ADDON_STATUS CreateInstance ()
 
void DestroyInstance ()
 
const AddonDllPtr & Addon () const
 
AddonInfoPtr GetAddonInfo () const
 
virtual void OnPreInstall ()
 
virtual void OnPostInstall (bool update, bool modal)
 
virtual void OnPreUnInstall ()
 
virtual void OnPostUnInstall ()
 

Protected Attributes

std::string m_protocols
 Protocols for VFS entry.
 
std::string m_extensions
 Extensions for VFS entry.
 
std::string m_zeroconf
 Zero conf announce string for VFS protocol.
 
bool m_files
 Vfs entry can read files.
 
bool m_directories
 VFS entry can list directories.
 
bool m_filedirectories
 VFS entry contains file directories.
 
ProtocolInfo m_protocolInfo
 Info about protocol for network dialog.
 
- Protected Attributes inherited from ADDON::IAddonInstanceHandler
KODI_ADDON_INSTANCE_INFO m_info {}
 
KODI_ADDON_INSTANCE_STRUCT m_ifc {}
 

Detailed Description

A virtual filesystem entry add-on.

Constructor & Destructor Documentation

◆ CVFSEntry()

ADDON::CVFSEntry::CVFSEntry ( const AddonInfoPtr &  addonInfo)
explicit

Construct from add-on properties.

Parameters
addonInfoGeneral addon properties

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