include/salhelper/thread.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #ifndef INCLUDED_SALHELPER_THREAD_HXX
  11 #define INCLUDED_SALHELPER_THREAD_HXX
  12
  13 #include "sal/config.h"
  14
  15 #include <cstddef>
  16
  17 #include "osl/thread.hxx"
  18 #include "sal/types.h"
  19 #include "salhelper/salhelperdllapi.h"
  20 #include "salhelper/simplereferenceobject.hxx"
  21
  22 namespace salhelper
  23 {
  24 /**
  25    A safe encapsulation of ::osl::Thread.
  26
  27    @since LibreOffice 3.6
  28 */
  29 class SALHELPER_DLLPUBLIC Thread : public salhelper::SimpleReferenceObject, private osl::Thread
  30 {
  31 public:
  32     /**
  33        @param name the thread name, see ::osl_setThreadName; must be a non-null
  34        null terminated string
  35      */
  36     Thread(char const* name);
  37
  38     /**
  39        Launch the thread.
  40
  41        This function must be called at most once.
  42
  43        Each call of this function should eventually be followed by a call to
  44        ::osl::Thread::join before exit(3), to ensure the thread is no longer
  45        relying on any infrastructure while that infrastructure is being shut
  46        down in atexit handlers.
  47     */
  48     void launch();
  49
  50     using osl::Thread::getIdentifier;
  51     using osl::Thread::join;
  52     using osl::Thread::schedule;
  53     using osl::Thread::terminate;
  54
  55     // While the below static member functions should arguably always be called
  56     // with qualified (osl::Thread) names, compilers would still complain that
  57     // they are inaccessible from within derivations of salhelper::Thread (an
  58     // alternative would be to force such derivations to use global names,
  59     // prefixed with ::osl::Thread):
  60     using osl::Thread::getCurrentIdentifier;
  61     using osl::Thread::wait;
  62     using osl::Thread::yield;
  63
  64     static void* operator new(std::size_t size)
  65     {
  66         return SimpleReferenceObject::operator new(size);
  67     }
  68
  69     static void operator delete(void* pointer) { SimpleReferenceObject::operator delete(pointer); }
  70
  71 protected:
  72     virtual ~Thread() SAL_OVERRIDE;
  73
  74     /**
  75        The main function executed by the thread.
  76
  77        Any uncaught exceptions lead to std::terminate.
  78     */
  79     virtual void execute() = 0;
  80
  81 private:
  82     virtual void SAL_CALL run() SAL_OVERRIDE;
  83
  84     virtual void SAL_CALL onTerminated() SAL_OVERRIDE;
  85
  86     char const* name_;
  87 };
  88 }
  89
  90 #endif
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */