#include <SMBFile.h>

Inheritance diagram for XFILE::CSMBFile:

Public Member Functions
	CSMBFile ()

int	OpenFile (const CURL &url, std::string &strAuth)
	Checks authentication against SAMBA share. Reads password cache created in CSMBDirectory::OpenDir().

	~CSMBFile () override

void	Close () override

int64_t	Seek (int64_t iFilePosition, int iWhence=SEEK_SET) override

ssize_t	Read (void *lpBuf, size_t uiBufSize) override

bool	Open (const CURL &url) override

bool	Exists (const CURL &url) override

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

int	Stat (struct __stat64 *buffer) override

int	Truncate (int64_t size) override

int64_t	GetLength () override

int64_t	GetPosition () override

ssize_t	Write (const void *lpBuf, size_t uiBufSize) override

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

bool	Delete (const CURL &url) override

bool	Rename (const CURL &url, const CURL &urlnew) override

int	GetChunkSize () override

int	IoControl (EIoControl request, void *param) override

Public Member Functions inherited from XFILE::IFile
	IFile ()

virtual	~IFile ()

virtual bool	ReOpen (const CURL &url)

virtual bool	ReadString (char *szLine, int iLineLength)

virtual void	Flush ()

virtual double	GetDownloadSpeed ()

virtual bool	SetHidden (const CURL &url, bool hidden)

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

Protected Member Functions
bool	IsValidFile (const std::string &strFileName)

std::string	GetAuthenticatedPath (const CURL &url)

Protected Attributes
CURL	m_url

int64_t	m_fileSize

int	m_fd

bool	m_allowRetry

Constructor & Destructor Documentation

◆ CSMBFile()

CSMBFile::CSMBFile ( )

◆ ~CSMBFile()

CSMBFile::~CSMBFile ( )

override

Member Function Documentation

◆ Close()

void CSMBFile::Close ( )

overridevirtual

Implements XFILE::IFile.

◆ Delete()

bool CSMBFile::Delete ( const CURL & url )

overridevirtual

Reimplemented from XFILE::IFile.

◆ Exists()

bool CSMBFile::Exists ( const CURL & url )

overridevirtual

Implements XFILE::IFile.

◆ GetAuthenticatedPath()

std::string CSMBFile::GetAuthenticatedPath ( const CURL & url )

protected

◆ GetChunkSize()

int CSMBFile::GetChunkSize ( )

overridevirtual

Reimplemented from XFILE::IFile.

◆ GetLength()

int64_t CSMBFile::GetLength ( )

overridevirtual

Implements XFILE::IFile.

◆ GetPosition()

int64_t CSMBFile::GetPosition ( )

overridevirtual

Implements XFILE::IFile.

◆ IoControl()

int CSMBFile::IoControl	(	EIoControl	request,
		void *	param )

overridevirtual

Reimplemented from XFILE::IFile.

◆ IsValidFile()

bool CSMBFile::IsValidFile ( const std::string & strFileName )

protected

◆ Open()

bool CSMBFile::Open ( const CURL & url )

overridevirtual

Implements XFILE::IFile.

◆ OpenFile()

int CSMBFile::OpenFile	(	const CURL &	url,
		std::string &	strAuth )

Checks authentication against SAMBA share. Reads password cache created in CSMBDirectory::OpenDir().

Parameters

strAuth The SMB style path

Returns: SMB file descriptor

◆ OpenForWrite()

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

overridevirtual

Reimplemented from XFILE::IFile.

◆ Read()

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

overridevirtual

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 CSMBFile::Rename	(	const CURL &	url,
		const CURL &	urlnew )

overridevirtual

Reimplemented from XFILE::IFile.

◆ Seek()

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

overridevirtual

Implements XFILE::IFile.

◆ Stat() [1/2]

int CSMBFile::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

url	specifies requested file
buffer	pointer to __stat64 buffer to receive information about file

Returns: zero of success, -1 otherwise.

Implements XFILE::IFile.

◆ Stat() [2/2]

int CSMBFile::Stat ( struct __stat64 * buffer )

overridevirtual

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 CSMBFile::Truncate ( int64_t size )

overridevirtual

Reimplemented from XFILE::IFile.

◆ Write()

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

overridevirtual

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.

Member Data Documentation

◆ m_allowRetry

bool XFILE::CSMBFile::m_allowRetry

protected

◆ m_fd

int XFILE::CSMBFile::m_fd

protected

◆ m_fileSize

int64_t XFILE::CSMBFile::m_fileSize

protected

◆ m_url

CURL XFILE::CSMBFile::m_url

protected

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

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ CSMBFile()

◆ ~CSMBFile()

Member Function Documentation

◆ Close()

◆ Delete()

◆ Exists()

◆ GetAuthenticatedPath()

◆ GetChunkSize()

◆ GetLength()

◆ GetPosition()

◆ IoControl()

◆ IsValidFile()

◆ Open()

◆ OpenFile()

◆ OpenForWrite()

◆ Read()

◆ Rename()

◆ Seek()

◆ Stat() [1/2]

◆ Stat() [2/2]

◆ Truncate()

◆ Write()

Member Data Documentation

◆ m_allowRetry

◆ m_fd

◆ m_fileSize

◆ m_url