LibreOffice
LibreOffice 24.2 SDK C/C++ API Reference
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
salhelper::Thread Class Referenceabstract

A safe encapsulation of osl::Thread. More...

#include <thread.hxx>

Inheritance diagram for salhelper::Thread:
salhelper::SimpleReferenceObject osl::Thread

Public Member Functions

 Thread (char const *name)
 
void launch ()
 Launch the thread. More...
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Static Public Member Functions

static void * operator new (std::size_t size)
 
static void operator delete (void *pointer)
 
- Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static void * operator new (std::size_t nSize)
 see general class documentation More...
 
static void * operator new (std::size_t nSize, std::nothrow_t const &rNothrow)
 see general class documentation More...
 
static void operator delete (void *pPtr)
 see general class documentation More...
 
static void operator delete (void *pPtr, std::nothrow_t const &rNothrow)
 see general class documentation More...
 

Protected Member Functions

virtual ~Thread () SAL_OVERRIDE
 
virtual void execute ()=0
 The main function executed by the thread. More...
 
- Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual ~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE
 

Additional Inherited Members

- Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount m_nCount
 

Detailed Description

A safe encapsulation of osl::Thread.

Since
LibreOffice 3.6

Constructor & Destructor Documentation

◆ Thread()

salhelper::Thread::Thread ( char const *  name)
Parameters
namethe thread name, see osl_setThreadName; must be a non-null null terminated string

◆ ~Thread()

virtual salhelper::Thread::~Thread ( )
protectedvirtual

Reimplemented from osl::Thread.

Member Function Documentation

◆ execute()

virtual void salhelper::Thread::execute ( )
protectedpure virtual

The main function executed by the thread.

Any uncaught exceptions lead to std::terminate.

◆ launch()

void salhelper::Thread::launch ( )

Launch the thread.

This function must be called at most once.

Each call of this function should eventually be followed by a call to osl::Thread::join before exit(3), to ensure the thread is no longer relying on any infrastructure while that infrastructure is being shut down in atexit handlers.

◆ operator delete()

static void salhelper::Thread::operator delete ( void *  pointer)
inlinestatic

◆ operator new()

static void* salhelper::Thread::operator new ( std::size_t  size)
inlinestatic

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