From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- .../nel/classNLMISC_1_1CAsyncFileManager.html | 465 +++++++++++++++++++++ 1 file changed, 465 insertions(+) create mode 100644 docs/doxygen/nel/classNLMISC_1_1CAsyncFileManager.html (limited to 'docs/doxygen/nel/classNLMISC_1_1CAsyncFileManager.html') diff --git a/docs/doxygen/nel/classNLMISC_1_1CAsyncFileManager.html b/docs/doxygen/nel/classNLMISC_1_1CAsyncFileManager.html new file mode 100644 index 00000000..064fd81c --- /dev/null +++ b/docs/doxygen/nel/classNLMISC_1_1CAsyncFileManager.html @@ -0,0 +1,465 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +

Home

nevrax.com

+ + + + +

+ + + + + + + + + + +

+ + +

+ Nevrax.org

+ + + + + + + +

	News
	Mailing-list
	Documentation
	CVS
	Bugs
	License

+ + +

+ + + + + + +

Documentation

+ + +Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages Search +

NLMISC::CAsyncFileManager Class Reference

CAsyncFileManager is a class that manage file loading in a seperate thread. +More... +

+#include <async_file_manager.h> +

Inheritance diagram for NLMISC::CAsyncFileManager: +

+ + + + +List of all members. + + + + + + + + + + + + + + + + +

Public Methods
void	loadFile (const std::string &fileName, uint8 **pPtr)
void	loadFiles (const std::vector< std::string > &vFileNames, const std::vector< uint8 ** > &vPtrs)
void	signal (bool *pSgn)
void	cancelSignal (bool *pSgn)
void	addLoadTask (IRunnable *ploadTask)
	Add a load task in the CAsyncFileManager task list. More...
bool	cancelLoadTask (const ICancelCallback &cancelCallBack)
	Call this method to cancel a programmed load. More...
Static Public Methods
CAsyncFileManager &	getInstance ()
void	terminate ()
Private Methods
	CAsyncFileManager ()
Static Private Attributes
CAsyncFileManager *	_Singleton = NULL

Detailed Description

+CAsyncFileManager is a class that manage file loading in a seperate thread. +

+Author:: +Matthieu Besson , Nevrax France

+Date:: +2002

+ +

+Definition at line 41 of file async_file_manager.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
NLMISC::CAsyncFileManager::CAsyncFileManager ( ) [private]
+
+ + + + + +
+ + + +
+ +
+Definition at line 40 of file async_file_manager.cpp. +
+Referenced by getInstance.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + + +
void NLMISC::CAsyncFileManager::addLoadTask ( IRunnable * ploadTask )
+
+ + + + + +
+ + + +
+Add a load task in the CAsyncFileManager task list. +
+ +
+Definition at line 67 of file async_file_manager.cpp. +
+References NLMISC::CTaskManager::addTask.
+

+ + + + +
+ + + + + + + + + + +
bool NLMISC::CAsyncFileManager::cancelLoadTask ( const ICancelCallback & cancelCallBack )
+
+ + + + + +
+ + + +
+Call this method to cancel a programmed load. +
+
+Returns:
+False if the task either already ended or running.
+
+Definition at line 72 of file async_file_manager.cpp. +
+References NLMISC::CTaskManager::_TaskQueue, and NLMISC::CTaskManager::waitCurrentTaskToComplete.
+

+ + + + +
+ + + + + + + + + + +
void NLMISC::CAsyncFileManager::cancelSignal ( bool * pSgn )
+
+ + + + + +
+ + + +
+ +
+Definition at line 170 of file async_file_manager.cpp. +
+References NLMISC::CTaskManager::_TaskQueue.
+

+ + + + +
+ + + + + + + + + +
CAsyncFileManager & NLMISC::CAsyncFileManager::getInstance ( ) [static]
+
+ + + + + +
+ + + +
+ +
+Definition at line 46 of file async_file_manager.cpp. +
+References _Singleton, and CAsyncFileManager. +
+Referenced by terminate.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLMISC::CAsyncFileManager::loadFile ( const std::string & fileName,
uint8 ** pPtr
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 149 of file async_file_manager.cpp. +
+References NLMISC::CTaskManager::addTask.
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLMISC::CAsyncFileManager::loadFiles ( const std::vector< std::string > & vFileNames,
const std::vector< uint8 ** > & vPtrs
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 156 of file async_file_manager.cpp. +
+References NLMISC::CTaskManager::addTask.
+

+ + + + +
+ + + + + + + + + + +
void NLMISC::CAsyncFileManager::signal ( bool * pSgn )
+
+ + + + + +
+ + + +
+ +
+Definition at line 163 of file async_file_manager.cpp. +
+References NLMISC::CTaskManager::addTask.
+

+ + + + +
+ + + + + + + + + +
void NLMISC::CAsyncFileManager::terminate ( ) [static]
+
+ + + + + +
+ + + +
+ +
+Definition at line 57 of file async_file_manager.cpp. +
+References _Singleton, and getInstance.
+

Member Data Documentation

+ + + + +
+ + +
CAsyncFileManager * NLMISC::CAsyncFileManager::_Singleton = NULL [static, private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 36 of file async_file_manager.cpp. +
+Referenced by getInstance, and terminate.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NLMISC::CAsyncFileManager Class Reference

Public Methods

Static Public Methods

Private Methods

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation