From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/a02227.html | 508 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 508 insertions(+) create mode 100644 docs/doxygen/nel/a02227.html (limited to 'docs/doxygen/nel/a02227.html') diff --git a/docs/doxygen/nel/a02227.html b/docs/doxygen/nel/a02227.html new file mode 100644 index 00000000..e6878460 --- /dev/null +++ b/docs/doxygen/nel/a02227.html @@ -0,0 +1,508 @@ + + +NeL: NLSOUND::CAsyncFileManagerSound class Reference + + + +

NLSOUND::CAsyncFileManagerSound Class Reference

#include <async_file_manager_sound.h> +

Detailed Description

+CAsyncFileManagerSound is a class that manage sound file loading in a seperate thread This class mostly depend on the CAsyncFileManager class for serializing async file loas request.

Author:: Boris Boucher
+Nevrax France

Date:: 2002

+ +

+Definition at line 42 of file async_file_manager_sound.h. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions
void cancelLoadWaveFile (const std::string &filename)
void cancelSignal (bool *pSgn)
void loadFile (const std::string &fileName, uint8 **pPtr)
void loadFiles (const std::vector< std::string > &vFileNames, const std::vector< uint8 ** > &vPtrs)
void loadWavFile (IBuffer *pdestBuffer, const std::string &filename)
void signal (bool *pSgn)
void terminate ()

Static Public Member Functions
CAsyncFileManagerSound & getInstance ()

Private Member Functions
CAsyncFileManagerSound ()
Constructor.

Static Private Attributes
CAsyncFileManagerSound * _Singleton
Singleton instance.

Friends
class CCancelLoadWavFile
A non exported class for load canceling purpose.

+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
NLSOUND::CAsyncFileManagerSound::CAsyncFileManagerSound ( ) [inline, private]
+
+ + + + + +
+ + + +
+Constructor. +
+ +
+Definition at line 61 of file async_file_manager_sound.h. +
+Referenced by getInstance(). +
+
00061 {}; +

+

Member Function Documentation

+ + + + +
+ + + + + + + + + + +
void NLSOUND::CAsyncFileManagerSound::cancelLoadWaveFile ( const std::string & filename )
+
+ + + + + +
+ + + +
+ +
+Definition at line 91 of file async_file_manager_sound.cpp. +
+References nlwarning. +
+
00092 { +00093 nlwarning("CAsyncFileManagerSound::cancelLoadWaveFile : not implemented yet !"); +00094 // CAsyncFileManager::getInstance().cancelLoadTask(CCancelLoadWavFile(filename)); +00095 } +

+

+ + + + +
+ + + + + + + + + + +
void NLSOUND::CAsyncFileManagerSound::cancelSignal ( bool * pSgn )
+
+ + + + + +
+ + + +
+ +
+Definition at line 125 of file async_file_manager_sound.cpp. +
+References nlwarning. +
+
00126 { +00127 if (pSgn == 0) +00128 { +00129 nlwarning("CAsyncFileManagerSound::cancelSignal : trying to remove a signal with a null pointer !"); +00130 return; +00131 } +00132 CAsyncFileManager::getInstance().cancelSignal(pSgn); +00133 } +

+

+ + + + +
+ + + + + + + + + +
CAsyncFileManagerSound & NLSOUND::CAsyncFileManagerSound::getInstance ( ) [static]
+
+ + + + + +
+ + + +
+ +
+Definition at line 42 of file async_file_manager_sound.cpp. +
+References CAsyncFileManagerSound(). +
+Referenced by terminate(). +
+
00043 { +00044 NL_ALLOC_CONTEXT(NLSOUND_CAsyncFileManagerSound); +00045 if (_Singleton == NULL) +00046 { +00047 _Singleton = new CAsyncFileManagerSound(); +00048 } +00049 return *_Singleton; +00050 } +

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLSOUND::CAsyncFileManagerSound::loadFile ( const std::string & fileName,
uint8 ** pPtr
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 99 of file async_file_manager_sound.cpp. +
+References uint8. +
+
00100 { +00101 CAsyncFileManager::getInstance().loadFile(fileName, pPtr); +00102 } +

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLSOUND::CAsyncFileManagerSound::loadFiles ( const std::vector< std::string > & vFileNames,
const std::vector< uint8 ** > & vPtrs
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 104 of file async_file_manager_sound.cpp. +
+References nlwarning. +
+
00105 { +00106 if (vFileNames.size() != vPtrs.size()) +00107 { +00108 nlwarning("CAsyncFileManagerSound::loadFiles : number of filenames and pointer differ ! (%u file, %u ptr)", vFileNames.size(), vPtrs.size()); +00109 // ignore load request... +00110 return; +00111 } +00112 CAsyncFileManager::getInstance().loadFiles(vFileNames, vPtrs); +00113 } +

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLSOUND::CAsyncFileManagerSound::loadWavFile ( IBuffer * pdestBuffer,
const std::string & filename
)
+
+ + + + + +
+ + + +
+ +
+Definition at line 62 of file async_file_manager_sound.cpp. +
+
00063 { +00064 NL_ALLOC_CONTEXT(NLSOUND_CAsyncFileManagerSound); +00065 CAsyncFileManager::getInstance().addLoadTask(new CLoadWavFile(pdestBuffer, filename)); +00066 } +

+

+ + + + +
+ + + + + + + + + + +
void NLSOUND::CAsyncFileManagerSound::signal ( bool * pSgn )
+
+ + + + + +
+ + + +
+ +
+Definition at line 115 of file async_file_manager_sound.cpp. +
+References nlwarning. +
+
00116 { +00117 if (pSgn == 0) +00118 { +00119 nlwarning("CAsyncFileManagerSound::signal : trying to signal with a null pointer !"); +00120 return; +00121 } +00122 CAsyncFileManager::getInstance().signal(pSgn); +00123 } +

+

+ + + + +
+ + + + + + + + + +
void NLSOUND::CAsyncFileManagerSound::terminate ( )
+
+ + + + + +
+ + + +
+ +
+Definition at line 53 of file async_file_manager_sound.cpp. +
+References getInstance(). +
+
00054 { +00055 if (_Singleton != NULL) +00056 { +00057 delete &getInstance(); +00058 _Singleton = NULL; +00059 } +00060 } +

+

Friends And Related Function Documentation

+ + + + +
+ + +
friend class CCancelLoadWavFile [friend] +
+
+ + + + + +
+ + + +
+A non exported class for load canceling purpose. +
+ +
+Definition at line 68 of file async_file_manager_sound.h.
+

Field Documentation

+ + + + +
+ + +
CAsyncFileManagerSound * NLSOUND::CAsyncFileManagerSound::_Singleton [static, private] +
+
+ + + + + +
+ + + +
+Singleton instance. +
+ +
+Definition at line 39 of file async_file_manager_sound.cpp.
+

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

Generated on Tue Mar 16 14:28:13 2004 for NeL by + +

+1.3.6

+ + -- cgit v1.2.1


Public Member Functions
void	cancelLoadWaveFile (const std::string &filename)
void	cancelSignal (bool *pSgn)
void	loadFile (const std::string &fileName, uint8 **pPtr)
void	loadFiles (const std::vector< std::string > &vFileNames, const std::vector< uint8 ** > &vPtrs)
void	loadWavFile (IBuffer *pdestBuffer, const std::string &filename)
void	signal (bool *pSgn)
void	terminate ()
Static Public Member Functions
CAsyncFileManagerSound &	getInstance ()
Private Member Functions
	CAsyncFileManagerSound ()
	Constructor.
Static Private Attributes
CAsyncFileManagerSound *	_Singleton
	Singleton instance.
Friends
class	CCancelLoadWavFile
	A non exported class for load canceling purpose.