XII Release 0.1.0
Loading...
Searching...
No Matches
xiiDataDirectory::FileserveDataDirectoryReader Class Reference
Inheritance diagram for xiiDataDirectory::FileserveDataDirectoryReader:
[legend]

Public Member Functions

 FileserveDataDirectoryReader (xiiInt32 iDataDirUserData)
 
- Public Member Functions inherited from xiiDataDirectory::FolderReader
 FolderReader (xiiInt32 iDataDirUserData)
 
virtual xiiUInt64 Skip (xiiUInt64 uiBytes) override
 Helper method to skip a number of bytes (implementations of the directory reader may implement this more efficiently for example)
 
virtual xiiUInt64 Read (void *pBuffer, xiiUInt64 uiBytes) override
 
virtual xiiUInt64 GetFileSize () const override
 Returns the current total size of the file.
 
- Public Member Functions inherited from xiiDataDirectoryReader
 xiiDataDirectoryReader (xiiInt32 iDataDirUserData)
 
- Public Member Functions inherited from xiiDataDirectoryReaderWriterBase
 xiiDataDirectoryReaderWriterBase (xiiInt32 iDataDirUserData, bool bIsReader)
 The derived class should pass along whether it is a reader or writer.
 
xiiResult Open (xiiStringView sFile, xiiDataDirectoryType *pOwnerDataDirectory, xiiFileShareMode::Enum fileShareMode)
 Used by xiiDataDirectoryType's to try to open the given file. They need to pass along their own pointer.
 
void Close ()
 Closes this data stream.
 
const xiiString128GetFilePath () const
 Returns the relative path of this file within the owner data directory.
 
xiiDataDirectoryTypeGetDataDirectory () const
 Returns the pointer to the data directory, which created this reader/writer.
 
bool IsReader () const
 Returns true if this is a reader stream, false if it is a writer stream.
 
xiiInt32 GetDataDirUserData () const
 

Protected Member Functions

virtual xiiResult InternalOpen (xiiFileShareMode::Enum FileShareMode) override
 This function must be implemented by the derived class.
 
- Protected Member Functions inherited from xiiDataDirectory::FolderReader
virtual void InternalClose () override
 This function must be implemented by the derived class.
 

Additional Inherited Members

- Protected Attributes inherited from xiiDataDirectory::FolderReader
bool m_bIsInUse
 
xiiOSFile m_File
 
- Protected Attributes inherited from xiiDataDirectoryReaderWriterBase
bool m_bIsReader
 
xiiInt32 m_iDataDirUserData = 0
 
xiiDataDirectoryTypem_pDataDirType
 
xiiString128 m_sFilePath
 

Member Function Documentation

◆ InternalOpen()

xiiResult xiiDataDirectory::FileserveDataDirectoryReader::InternalOpen ( xiiFileShareMode::Enum FileShareMode)
overrideprotectedvirtual

This function must be implemented by the derived class.

Reimplemented from xiiDataDirectory::FolderReader.


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