From aeefd3fe454bfaed093355278b1e2caa84bfd77a Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Sun, 30 Jun 2024 12:33:25 +0900 Subject: Rename threading nt* related files to equivalent tq* Signed-off-by: Michele Calgaro --- doc/html/ntqthreadstorage.html | 189 ----------------------------------------- 1 file changed, 189 deletions(-) delete mode 100644 doc/html/ntqthreadstorage.html (limited to 'doc/html/ntqthreadstorage.html') diff --git a/doc/html/ntqthreadstorage.html b/doc/html/ntqthreadstorage.html deleted file mode 100644 index c18111bd1..000000000 --- a/doc/html/ntqthreadstorage.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - -TQThreadStorage Class - - - - - - - -

TQThreadStorage Class Reference

- -

The TQThreadStorage class provides per-thread data storage. -More... -

All the functions in this class are thread-safe when TQt is built with thread support.

#include <ntqthreadstorage.h> -

List of all member functions. -

Public Members

TQThreadStorage ()
~TQThreadStorage ()
bool hasLocalData () const
T & localData ()
T localData () const
void setLocalData ( T data )

Detailed Description

- - -The TQThreadStorage class provides per-thread data storage. -

- - -

TQThreadStorage is a template class that provides per-thread data -storage. -

Note that due to compiler limitations, TQThreadStorage can only store pointers. -

The setLocalData() function stores a single thread-specific value -for the calling thread. The data can be accessed later using the -localData() functions. TQThreadStorage takes ownership of the -data (which must be created on the heap with new) and deletes -it when the thread exits (either normally or via termination). -

The hasLocalData() function allows the programmer to determine if -data has previously been set using the setLocalData() function. -This is useful for lazy initializiation. -

For example, the following code uses TQThreadStorage to store a -single cache for each thread that calls the cacheObject() and -removeFromCache() functions. The cache is automatically -deleted when the calling thread exits (either normally or via -termination). -

-    TQThreadStorage<TQCache<SomeClass> *> caches;
-
-    void cacheObject( const TQString &key, SomeClass *object )
-    {
-        if ( ! caches.hasLocalData() )
-            caches.setLocalData( new TQCache<SomeClass> );
-
-        caches.localData()->insert( key, object );
-    }
-
-    void removeFromCache( const TQString &key )
-    {
-        if ( ! caches.hasLocalData() )
-            return; // nothing to do
-
-        caches.localData()->remove( key );
-    }
-

- -

Caveats -

As noted above, TQThreadStorage can only store pointers due to -compiler limitations. Support for value-based objects will be -added when the majority of compilers are able to support partial -template specialization. -
The destructor does not -delete per-thread data. TQThreadStorage only deletes per-thread -data when the thread exits or when setLocalData() is called -multiple times. -
TQThreadStorage can only be used with threads started with -TQThread. It cannot be used with threads started with -platform-specific APIs. -
As a corollary to the above, platform-specific APIs cannot be -used to exit or terminate a TQThread using TQThreadStorage. Doing so -will cause all per-thread data to be leaked. See TQThread::exit() -and TQThread::terminate(). -
TQThreadStorage can be used to store data for the main() -thread after TQApplication has been constructed. TQThreadStorage -deletes all data set for the main() thread when TQApplication is -destroyed, regardless of whether or not the main() thread has -actually finished. -
The implementation of TQThreadStorage limits the total number of -TQThreadStorage objects to 256. An unlimited number of threads -can store per-thread data in each TQThreadStorage object. -

See also Environment Classes and Threading. - -

Member Function Documentation

TQThreadStorage::TQThreadStorage () -

- -

Constructs a new per-thread data storage object. - -

TQThreadStorage::~TQThreadStorage () -

- -

Destroys the per-thread data storage object. -

Note: The per-thread data stored is not deleted. Any data left -in TQThreadStorage is leaked. Make sure that all threads using -TQThreadStorage have exited before deleting the TQThreadStorage. -

bool TQThreadStorage::hasLocalData () const -

- -

Returns TRUE if the calling thread has non-zero data available; -otherwise returns FALSE. -

T & TQThreadStorage::localData () -

- -

Returns a reference to the data that was set by the calling -thread. -

Note: TQThreadStorage can only store pointers. This function -returns a reference to the pointer that was set by the calling -thread. The value of this reference is 0 if no data was set by -the calling thread, -

T TQThreadStorage::localData () const -

- -This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -

Returns a copy of the data that was set by the calling thread. -

Note: TQThreadStorage can only store pointers. This function -returns a pointer to the data that was set by the calling thread. -If no data was set by the calling thread, this function returns 0. -

void TQThreadStorage::setLocalData ( T data ) -

- -

Sets the local data for the calling thread to data. It can be -accessed later using the localData() functions. -

If data is 0, this function deletes the previous data (if -any) and returns immediately. -

If data is non-zero, TQThreadStorage takes ownership of the data and deletes it automatically either when the thread exits -(either normally or via termination) or when setLocalData() is -called again. -

Note: TQThreadStorage can only store pointers. The data -argument must be either a pointer to an object created on the heap -(i.e. using new) or 0. You should not delete data -yourself; TQThreadStorage takes ownership and will delete the data itself. -

See also localData() and hasLocalData(). - - -

- -

Trademarks -

TQt 3.3.8

- -- cgit v1.2.3