This concrete class defines the interface for Thread Local Storage (TLS). More...

Detailed Description

This concrete class defines the interface for Thread Local Storage (TLS).

TLS provides a mechanism for each thread to have its own instance of a global variable. A canonical example of TLS is the C error code variable 'errno'.

NOTES:

o The initial contents (per thread) of a TLS variable will be zero.
o If a new TLS variable/index can NOT be created (i.e. exceeded the
  Platforms supported limits) a Fatal Error is generated.
o A TLS variable can ONLY store a void pointer (or a size_t integer).
o Each instance of this class represents a single TLS variable that
  is SAME across ALL threads, i.e. do NOT create a TLS instance per
  thread, create a TLS instance per global variable.
o TLS instances can NOT be created statically, i.e. they must be
  created AFTER the Cpl::System::Api::initialize() is called.
o TLS instances can NOT be copied.

#include <Tls.h>

Public Member Functions
	Tls ()
	Constructor.

	~Tls ()
	Destructor.

void *	get (void)
	Returns the thread-based stored value.

void	set (void *newValue)
	This method sets the thread-based stored value.

Protected Attributes
Cpl_System_TlsKey_T	m_key
	Raw TLS key/handle/index.

Constructor & Destructor Documentation

◆ Tls()

Cpl::System::Tls::Tls ( )

Constructor.

◆ ~Tls()

Cpl::System::Tls::~Tls ( )

Destructor.

Member Function Documentation

◆ get()

void * Cpl::System::Tls::get ( void )

Returns the thread-based stored value.

◆ set()

void Cpl::System::Tls::set ( void * newValue )

This method sets the thread-based stored value.

Member Data Documentation

◆ m_key

Cpl_System_TlsKey_T Cpl::System::Tls::m_key

protected

Raw TLS key/handle/index.

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

Cpl/System/Tls.h