LOG4CPP::THREADING::THREADLOCALDATAHOLDER(3)

Bestie, welcome to the log4cpp::t...older< T >(3) page from the Library Functions Manual. This is the whole thing for log4cpp::threading::ThreadLocalDataHolder< T >, and yes, the original repeats itself a lot — I'm keeping every single pass, because we do not erase the Doxygen chaos in this house. 💅

🌸 NAME 🌸

log4cpp::threading::ThreadLocalDataHolder< T > — This class holds Thread local data of type T, i.e.

✨ SYNOPSIS ✨

#include <BoostThreads.hh>

🎀 Public Types

typedef T data_type
typedef T data_type
typedef T data_type

💖 Public Member Functions

Okay bestie, the original page repeats this whole function crew like it's caught in a group-chat loop. I'm keeping every occurrence so nothing gets lost. 🫶

Raw pass 1:

T * get () const
T * operator-> () const
T & operator* () const
T * release ()
void reset (T *p=NULL)
ThreadLocalDataHolder ()
~ThreadLocalDataHolder ()

Raw pass 2:

T * get () const
T * operator-> () const
T & operator* () const
T * release ()
void reset (T *p=NULL)
ThreadLocalDataHolder ()
~ThreadLocalDataHolder ()

Annotated pass 1:

• T * get () const — Obtains the Object held for the current thread.
• T * operator-> () const — Obtains the Object held for the current thread.
• T & operator* () const — Obtains the Object held for the current thread.
• T * release () — Releases the Object held for the current thread.
• void reset (T *p=NULL) — Sets a new Object to be held for the current thread.
• ThreadLocalDataHolder ()
• ~ThreadLocalDataHolder ()

Annotated pass 2:

• T * get () const — Obtains the Object held for the current thread.
• T * operator-> () const — Obtains the Object held for the current thread.
• T & operator* () const — Obtains the Object held for the current thread.
• T * release () — Releases the Object held for the current thread.
• void reset (T *p=NULL) — Sets a new Object to be held for the current thread.
• ThreadLocalDataHolder ()
• ~ThreadLocalDataHolder ()

Raw pass 3, shorter this time:

T * get () const
T * operator-> () const
T & operator* () const
T * release ()
void reset (T *p=NULL)

🌟 Static Public Member Functions

• static void freeHolder (void *p)

💜 Detailed Description

template<typename T>
class log4cpp::threading::ThreadLocalDataHolder< T >

The page says: "This class holds Thread local data of type T, i.e.

for each thread a ThreadLocalDataHolder holds 0 or 1 instance of T. The held object must be heap allocated and will be deleted upon termination of the thread to which it belongs.

And then it says it again, with a little spelling moment:

for each thread a ThreadLocalDataHolder holds 0 or 1 instance of T. The held object must be heap allocated and will be deleted upon termination of the thread to wich it belongs. This is an omni_threads based equivalent of Boost.Threads thread_specific_ptr<T> class.

Yes, bestie, wich is in the original. No cap. 🫶

🌈 Member Typedef Documentation

The page lists this typedef three times, exactly like this:

template<typename T> typedef T log4cpp::threading::ThreadLocalDataHolder< T >::data_type
template<typename T> typedef T log4cpp::threading::ThreadLocalDataHolder< T >::data_type
template<typename T> typedef T log4cpp::threading::ThreadLocalDataHolder< T >::data_type

🦋 Constructor & Destructor Documentation

Four identical pairs, in order:

template<typename T> log4cpp::threading::ThreadLocalDataHolder< T >::ThreadLocalDataHolder () [inline]
template<typename T> log4cpp::threading::ThreadLocalDataHolder< T >::~ThreadLocalDataHolder () [inline]

template<typename T> log4cpp::threading::ThreadLocalDataHolder< T >::ThreadLocalDataHolder () [inline]
template<typename T> log4cpp::threading::ThreadLocalDataHolder< T >::~ThreadLocalDataHolder () [inline]

template<typename T> log4cpp::threading::ThreadLocalDataHolder< T >::ThreadLocalDataHolder () [inline]
template<typename T> log4cpp::threading::ThreadLocalDataHolder< T >::~ThreadLocalDataHolder () [inline]

template<typename T> log4cpp::threading::ThreadLocalDataHolder< T >::ThreadLocalDataHolder () [inline]
template<typename T> log4cpp::threading::ThreadLocalDataHolder< T >::~ThreadLocalDataHolder () [inline]

👑 Member Function Documentation

🍓 freeHolder

• template<typename T> void log4cpp::threading::ThreadLocalDataHolder< T >::freeHolder (void * p) [inline], [static]

🍓 get

Occurrence 1:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::get () const [inline]

Occurrence 2:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::get () const [inline]

Occurrence 3:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::get () const [inline]
  • Obtains the Object held for the current thread.
  • Returns: a pointer to the held Object or NULL if no Object has been set for the current thread.

Occurrence 4:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::get () const [inline]
  • Obtains the Object held for the current thread.
  • Returns: a pointer to the held Object or NULL if no Object has been set for the current thread.

Occurrence 5:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::get () const [inline]

🍓 operator*

Occurrence 1:

• template<typename T> T & log4cpp::threading::ThreadLocalDataHolder< T >::operator* () const [inline]

Occurrence 2:

• template<typename T> T & log4cpp::threading::ThreadLocalDataHolder< T >::operator* () const [inline]

Occurrence 3:

• template<typename T> T & log4cpp::threading::ThreadLocalDataHolder< T >::operator* () const [inline]
  • Obtains the Object held for the current thread.
  • Precondition: get() != NULL
  • Returns: a reference to the held Object.

Occurrence 4:

• template<typename T> T & log4cpp::threading::ThreadLocalDataHolder< T >::operator* () const [inline]
  • Obtains the Object held for the current thread.
  • Precondition: get() != NULL
  • Returns: a reference to the held Object.

Occurrence 5:

• template<typename T> T & log4cpp::threading::ThreadLocalDataHolder< T >::operator* () const [inline]

🍓 operator->

Occurrence 1:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::operator-> () const [inline]

Occurrence 2:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::operator-> () const [inline]

Occurrence 3:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::operator-> () const [inline]
  • Obtains the Object held for the current thread. Initially each thread holds NULL.
  • Returns: a pointer to the held Object or NULL if no Object has been set for the current thread.

Occurrence 4:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::operator-> () const [inline]
  • Obtains the Object held for the current thread. Initially each thread holds NULL.
  • Returns: a pointer to the held Object or NULL if no Object has been set for the current thread.

Occurrence 5:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::operator-> () const [inline]

🍓 release

Occurrence 1:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::release () [inline]

Occurrence 2:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::release () [inline]

Occurrence 3:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::release () [inline]
  • Releases the Object held for the current thread.
  • Postcondition: get() == NULL
  • Returns: a pointer to the Object thas was held for the current thread or NULL if no Object was held.

Occurrence 4:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::release () [inline]
  • Releases the Object held for the current thread.
  • Postcondition: get() == NULL
  • Returns: a pointer to the Object thas was held for the current thread or NULL if no Object was held.

Occurrence 5:

• template<typename T> T * log4cpp::threading::ThreadLocalDataHolder< T >::release () [inline]

🍓 reset

Occurrence 1:

• template<typename T> void log4cpp::threading::ThreadLocalDataHolder< T >::reset (T * p = NULL) [inline]

Occurrence 2:

• template<typename T> void log4cpp::threading::ThreadLocalDataHolder< T >::reset (T * p = NULL) [inline]

Occurrence 3:

• template<typename T> void log4cpp::threading::ThreadLocalDataHolder< T >::reset (T * p = NULL) [inline]
  • Sets a new Object to be held for the current thread. A previously set Object will be deleted.
  • Parameters: p the new object to hold.
  • Postcondition: get() == p

Occurrence 4:

• template<typename T> void log4cpp::threading::ThreadLocalDataHolder< T >::reset (T * p = NULL) [inline]
  • Sets a new Object to be held for the current thread. A previously set Object will be deleted.
  • Parameters: p the new object to hold.
  • Postcondition: get() == p

Occurrence 5:

• template<typename T> void log4cpp::threading::ThreadLocalDataHolder< T >::reset (T * p = NULL) [inline]

🌟 Author

Generated automatically by Doxygen for log4cpp from the source code.

---

That's the whole page, bestie. Footer tea: log4cpp, Version 1.1, page title log4cpp::t...older< T >(3) — and no date is shown, so we're not inventing one. 🎀✨