#include <VFS.h>

Inheritance diagram for kodi::addon::CInstanceVFS:

Public Member Functions
	CInstanceVFS (KODI_HANDLE instance)

	~CInstanceVFS () override=default

virtual void *	Open (const VFSURL &url)
	Open a file for input. More...

virtual void *	OpenForWrite (const VFSURL &url, bool overWrite)
	Open a file for output. More...

virtual ssize_t	Read (void context, void buffer, size_t uiBufSize)
	Read from a file. More...

virtual ssize_t	Write (void context, const void buffer, size_t uiBufSize)
	Write to a file. More...

virtual int64_t	Seek (void *context, int64_t position, int whence)
	Seek in a file. More...

virtual int	Truncate (void *context, int64_t size)
	Truncate a file. More...

virtual int64_t	GetLength (void *context)
	Get total size of a file. More...

virtual int64_t	GetPosition (void *context)
	Get current position in a file. More...

virtual int	GetChunkSize (void *context)
	Get chunk size of a file. More...

virtual int	IoControl (void context, XFILE::EIoControl request, void param)
	Perform an IO-control on the file. More...

virtual bool	Close (void *context)
	Close a file. More...

virtual int	Stat (const VFSURL &url, struct __stat64 *buffer)
	Stat a file. More...

virtual bool	Exists (const VFSURL &url)
	Check for file existence. More...

virtual void	ClearOutIdle ()
	Clear out any idle connections. More...

virtual void	DisconnectAll ()
	Disconnect all connections. More...

virtual bool	Delete (const VFSURL &url)
	Delete a file. More...

virtual bool	Rename (const VFSURL &url, const VFSURL &url2)
	Rename a file. More...

virtual bool	DirectoryExists (const VFSURL &url)
	Check for directory existence. More...

virtual bool	RemoveDirectory (const VFSURL &url)
	Remove a directory. More...

virtual bool	CreateDirectory (const VFSURL &url)
	Create a directory. More...

Public Member Functions inherited from kodi::addon::IAddonInstance
	IAddonInstance (ADDON_TYPE type)

virtual	~IAddonInstance ()=default

virtual ADDON_STATUS	CreateInstance (int instanceType, std::string instanceID, KODI_HANDLE instance, KODI_HANDLE &addonInstance)

Additional Inherited Members
Public Attributes inherited from kodi::addon::IAddonInstance
const ADDON_TYPE	m_type

Constructor & Destructor Documentation

§ CInstanceVFS()

kodi::addon::CInstanceVFS::CInstanceVFS ( KODI_HANDLE instance )

inlineexplicit

§ ~CInstanceVFS()

kodi::addon::CInstanceVFS::~CInstanceVFS ( )

overridedefault

Member Function Documentation

§ ClearOutIdle()

virtual void kodi::addon::CInstanceVFS::ClearOutIdle ( )

inlinevirtual

Clear out any idle connections.

§ Close()

virtual bool kodi::addon::CInstanceVFS::Close ( void * context )

inlinevirtual

Close a file.

Parameters

[in] context The context of the file

Returns: True on success, false on failure

§ CreateDirectory()

virtual bool kodi::addon::CInstanceVFS::CreateDirectory ( const VFSURL & url )

inlinevirtual

Create a directory.

Parameters

[in] url The URL of the file

Returns: True if creation was successful, false otherwise

§ Delete()

virtual bool kodi::addon::CInstanceVFS::Delete ( const VFSURL & url )

inlinevirtual

Delete a file.

Parameters

[in] url The URL of the file

Returns: True if deletion was successful, false otherwise

§ DirectoryExists()

virtual bool kodi::addon::CInstanceVFS::DirectoryExists ( const VFSURL & url )

inlinevirtual

Check for directory existence.

Parameters

[in] url The URL of the file

Returns: True if directory exists, false otherwise

§ DisconnectAll()

virtual void kodi::addon::CInstanceVFS::DisconnectAll ( )

inlinevirtual

Disconnect all connections.

§ Exists()

virtual bool kodi::addon::CInstanceVFS::Exists ( const VFSURL & url )

inlinevirtual

Check for file existence.

Parameters

[in] url The URL of the file

Returns: True if file exists, false otherwise

§ GetChunkSize()

virtual int kodi::addon::CInstanceVFS::GetChunkSize ( void * context )

inlinevirtual

Get chunk size of a file.

Parameters

[in] context The context of the file

Returns: Chunk size

§ GetLength()

virtual int64_t kodi::addon::CInstanceVFS::GetLength ( void * context )

inlinevirtual

Get total size of a file.

Parameters

[in] context The context of the file

Returns: Total file size

§ GetPosition()

virtual int64_t kodi::addon::CInstanceVFS::GetPosition ( void * context )

inlinevirtual

Get current position in a file.

Parameters

[in] context The context of the file

Returns: Current position

§ IoControl()

virtual int kodi::addon::CInstanceVFS::IoControl	(	void *	context,
		XFILE::EIoControl	request,
		void *	param
	)

inlinevirtual

Perform an IO-control on the file.

Parameters

[in]	context	The context of the file
[in]	request	The requested IO-control
[in]	param	Parameter attached to the IO-control

Returns: -1 on error, >= 0 on success

§ Open()

virtual void* kodi::addon::CInstanceVFS::Open ( const VFSURL & url )

inlinevirtual

Open a file for input.

Parameters

[in] url The URL of the file

Returns: Context for the opened file

§ OpenForWrite()

virtual void* kodi::addon::CInstanceVFS::OpenForWrite	(	const VFSURL &	url,
		bool	overWrite
	)

inlinevirtual

Open a file for output.

Parameters

[in]	url	The URL of the file
[in]	overWrite	Whether or not to overwrite an existing file

Returns: Context for the opened file

§ Read()

virtual ssize_t kodi::addon::CInstanceVFS::Read	(	void *	context,
		void *	buffer,
		size_t	uiBufSize
	)

inlinevirtual

Read from a file.

Parameters

[in]	context	The context of the file
[out]	buffer	The buffer to read data into
[in]	uiBufSize	Number of bytes to read

Returns: Number of bytes read

§ RemoveDirectory()

virtual bool kodi::addon::CInstanceVFS::RemoveDirectory ( const VFSURL & url )

inlinevirtual

Remove a directory.

Parameters

[in] url The URL of the directory

Returns: True if removal was successful, false otherwise

§ Rename()

virtual bool kodi::addon::CInstanceVFS::Rename	(	const VFSURL &	url,
		const VFSURL &	url2
	)

inlinevirtual

Rename a file.

Parameters

[in]	url	The URL of the source file
[in]	url2	The URL of the destination file

Returns: True if deletion was successful, false otherwise

§ Seek()

virtual int64_t kodi::addon::CInstanceVFS::Seek	(	void *	context,
		int64_t	position,
		int	whence
	)

inlinevirtual

Seek in a file.

Parameters

[in]	context	The context of the file
[in]	position	The position to seek to
[in]	whence	Position in file 'position' is relative to (SEEK_CUR, SEEK_SET, SEEK_END)

Returns: Offset in file after seek

§ Stat()

virtual int kodi::addon::CInstanceVFS::Stat	(	const VFSURL &	url,
		struct __stat64 *	buffer
	)

inlinevirtual

Stat a file.

Parameters

[in]	url	The URL of the file
[in]	buffer	The buffer to store results in

Returns: -1 on error, 0 otherwise

§ Truncate()

virtual int kodi::addon::CInstanceVFS::Truncate	(	void *	context,
		int64_t	size
	)

inlinevirtual

Truncate a file.

Parameters

[in]	context	The context of the file
[in]	size	The size to truncate the file to

Returns: 0 on success, -1 on error

§ Write()

virtual ssize_t kodi::addon::CInstanceVFS::Write	(	void *	context,
		const void *	buffer,
		size_t	uiBufSize
	)

inlinevirtual

Write to a file.

Parameters

[in]	context	The context of the file
[in]	buffer	The buffer to read data from
[in]	uiBufSize	Number of bytes to write

Returns: Number of bytes written

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

VFS.h

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

§ CInstanceVFS()

§ ~CInstanceVFS()

Member Function Documentation

§ ClearOutIdle()

§ Close()

§ CreateDirectory()

§ Delete()

§ DirectoryExists()

§ DisconnectAll()

§ Exists()

§ GetChunkSize()

§ GetLength()

§ GetPosition()

§ IoControl()

§ Open()

§ OpenForWrite()

§ Read()

§ RemoveDirectory()

§ Rename()

§ Seek()

§ Stat()

§ Truncate()

§ Write()