Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Public Attributes | List of all members
AZ::IO::RemoteFileIO Class Reference

Inherits AZ::IO::NetworkFileIO.

Public Member Functions

 AZ_RTTI (RemoteFileIO, "{E2939E15-3B83-402A-A6DA-A436EDAB2ED2}", NetworkFileIO)
 
 AZ_CLASS_ALLOCATOR (RemoteFileIO, OSAllocator)
 
 RemoteFileIO (FileIOBase *excludedFileIO=nullptr)
 
Result Open (const char *filePath, OpenMode mode, HandleType &fileHandle) override
 
Result Close (HandleType fileHandle) override
 
Result Tell (HandleType fileHandle, AZ::u64 &offset) override
 
Result Seek (HandleType fileHandle, AZ::s64 offset, SeekType type) override
 
Result Size (HandleType fileHandle, AZ::u64 &size) override
 
Result Read (HandleType fileHandle, void *buffer, AZ::u64 size, bool failOnFewerThanSizeBytesRead=false, AZ::u64 *bytesRead=nullptr) override
 
Result Write (HandleType fileHandle, const void *buffer, AZ::u64 size, AZ::u64 *bytesWritten=nullptr) override
 
bool Eof (HandleType fileHandle) override
 
Result Size (const char *filePath, AZ::u64 &size) override
 
void SetAlias (const char *alias, const char *path) override
 
const char * GetAlias (const char *alias) const override
 
void ClearAlias (const char *alias) override
 
void SetDeprecatedAlias (AZStd::string_view oldAlias, AZStd::string_view newAlias) override
 
AZStd::optional< AZ::u64 > ConvertToAlias (char *inOutBuffer, AZ::u64 bufferLength) const override
 
bool ConvertToAlias (AZ::IO::FixedMaxPath &convertedPath, const AZ::IO::PathView &path) const override
 
bool ResolvePath (const char *path, char *resolvedPath, AZ::u64 resolvedPathSize) const override
 
bool ResolvePath (AZ::IO::FixedMaxPath &resolvedPath, const AZ::IO::PathView &path) const override
 
bool ReplaceAlias (AZ::IO::FixedMaxPath &replacedAliasPath, const AZ::IO::PathView &path) const override
 
RemoteFileCache & GetCache (HandleType fileHandle)
 
- Public Member Functions inherited from AZ::IO::NetworkFileIO
 AZ_RTTI (NetworkFileIO, "{A863335E-9330-44E2-AD89-B5309F3B8B93}", FileIOBase)
 
 AZ_CLASS_ALLOCATOR (NetworkFileIO, OSAllocator)
 
Result Open (const char *filePath, OpenMode mode, HandleType &fileHandle) override
 
Result Close (HandleType fileHandle) override
 
Result Tell (HandleType fileHandle, AZ::u64 &offset) override
 
Result Seek (HandleType fileHandle, AZ::s64 offset, SeekType type) override
 
Result Size (HandleType fileHandle, AZ::u64 &size) override
 
Result Read (HandleType fileHandle, void *buffer, AZ::u64 size, bool failOnFewerThanSizeBytesRead=false, AZ::u64 *bytesRead=nullptr) override
 
Result Write (HandleType fileHandle, const void *buffer, AZ::u64 size, AZ::u64 *bytesWritten=nullptr) override
 
Result Flush (HandleType fileHandle) override
 
bool Eof (HandleType fileHandle) override
 
AZ::u64 ModificationTime (HandleType fileHandle) override
 
bool Exists (const char *filePath) override
 
Result Size (const char *filePath, AZ::u64 &size) override
 
AZ::u64 ModificationTime (const char *filePath) override
 
bool IsDirectory (const char *filePath) override
 
bool IsReadOnly (const char *filePath) override
 
Result CreatePath (const char *filePath) override
 
Result DestroyPath (const char *filePath) override
 
Result Remove (const char *filePath) override
 
Result Copy (const char *sourceFilePath, const char *destinationFilePath) override
 
Result Rename (const char *sourceFilePath, const char *destinationFilePath) override
 
Result FindFiles (const char *filePath, const char *filter, FindFilesCallbackType callback) override
 
void SetAlias (const char *alias, const char *path) override
 
void ClearAlias (const char *alias) override
 
void SetDeprecatedAlias (AZStd::string_view oldAlias, AZStd::string_view newAlias) override
 
AZStd::optional< AZ::u64 > ConvertToAlias (char *inOutBuffer, AZ::u64 bufferLength) const override
 
bool ConvertToAlias (AZ::IO::FixedMaxPath &convertedPath, const AZ::IO::PathView &path) const override
 
const char * GetAlias (const char *alias) const override
 
bool ResolvePath (const char *path, char *resolvedPath, AZ::u64 resolvedPathSize) const override
 
bool ResolvePath (AZ::IO::FixedMaxPath &resolvedPath, const AZ::IO::PathView &path) const override
 
bool ReplaceAlias (AZ::IO::FixedMaxPath &replacedAliasPath, const AZ::IO::PathView &path) const override
 
bool GetFilename (HandleType fileHandle, char *filename, AZ::u64 filenameSize) const override
 
bool IsRemoteIOEnabled () override
 

Public Attributes

AZStd::recursive_mutex m_remoteFileCacheGuard
 
AZStd::unordered_map< HandleType, RemoteFileCache, AZStd::hash< HandleType >, AZStd::equal_to< HandleType >, AZ::OSStdAllocator > m_remoteFileCache
 

Additional Inherited Members

- Protected Attributes inherited from AZ::IO::NetworkFileIO
AZStd::recursive_mutex m_remoteFilesGuard
 
AZStd::unordered_map< HandleType, AZ::OSString, AZStd::hash< HandleType >, AZStd::equal_to< HandleType >, AZ::OSStdAllocator > m_remoteFiles
 
The documentation for this class was generated from the following file: