Branch data     Line data    Source code

       1                 :            : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2                 :            : /*
       3                 :            :  * Version: MPL 1.1 / GPLv3+ / LGPLv3+
       4                 :            :  *
       5                 :            :  * The contents of this file are subject to the Mozilla Public License Version
       6                 :            :  * 1.1 (the "License"); you may not use this file except in compliance with
       7                 :            :  * the License or as specified alternatively below. You may obtain a copy of
       8                 :            :  * the License at http://www.mozilla.org/MPL/
       9                 :            :  *
      10                 :            :  * Software distributed under the License is distributed on an "AS IS" basis,
      11                 :            :  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
      12                 :            :  * for the specific language governing rights and limitations under the
      13                 :            :  * License.
      14                 :            :  *
      15                 :            :  * Major Contributor(s):
      16                 :            :  * [ Copyright (C) 2012 Red Hat, Inc., Stephan Bergmann <sbergman@redhat.com>
      17                 :            :  *   (initial developer) ]
      18                 :            :  *
      19                 :            :  * All Rights Reserved.
      20                 :            :  *
      21                 :            :  * For minor contributions see the git repository.
      22                 :            :  *
      23                 :            :  * Alternatively, the contents of this file may be used under the terms of
      24                 :            :  * either the GNU General Public License Version 3 or later (the "GPLv3+"), or
      25                 :            :  * the GNU Lesser General Public License Version 3 or later (the "LGPLv3+"),
      26                 :            :  * in which case the provisions of the GPLv3+ or the LGPLv3+ are applicable
      27                 :            :  * instead of those above.
      28                 :            :  */
      29                 :            : 
      30                 :            : #ifndef INCLUDED_SALHELPER_THREAD_HXX
      31                 :            : #define INCLUDED_SALHELPER_THREAD_HXX
      32                 :            : 
      33                 :            : #include "sal/config.h"
      34                 :            : 
      35                 :            : #include <cstddef>
      36                 :            : 
      37                 :            : #include "osl/thread.hxx"
      38                 :            : #include "sal/types.h"
      39                 :            : #include "salhelper/salhelperdllapi.h"
      40                 :            : #include "salhelper/simplereferenceobject.hxx"
      41                 :            : 
      42                 :            : namespace salhelper {
      43                 :            : 
      44                 :            : /**
      45                 :            :    A safe encapsulation of ::osl::Thread.
      46                 :            : 
      47                 :            :    @since LibreOffice 3.6
      48                 :            : */
      49                 :            : class SALHELPER_DLLPUBLIC Thread:
      50                 :            :     public salhelper::SimpleReferenceObject, private osl::Thread
      51                 :            : {
      52                 :            : public:
      53                 :            :     /**
      54                 :            :        @param name the thread name, see ::osl_setThreadName; must be a non-null
      55                 :            :        null terminated string
      56                 :            :      */
      57                 :            :     Thread(char const * name);
      58                 :            : 
      59                 :            :     /**
      60                 :            :        Launch the thread.
      61                 :            : 
      62                 :            :        This function must be called at most once.
      63                 :            : 
      64                 :            :        Each call of this function should eventually be followed by a call to
      65                 :            :        ::osl::Thread::join before exit(3), to ensure the thread is no longer
      66                 :            :        relying on any infrastructure while that infrastructure is being shut
      67                 :            :        down in atexit handlers.
      68                 :            :     */
      69                 :            :     void launch();
      70                 :            : 
      71                 :            :     using osl::Thread::getIdentifier;
      72                 :            :     using osl::Thread::join;
      73                 :            :     using osl::Thread::schedule;
      74                 :            :     using osl::Thread::terminate;
      75                 :            : 
      76                 :            :     // While the below static member functions should arguably always be called
      77                 :            :     // with qualified (osl::Thread) names, compilers would still complain that
      78                 :            :     // they are inaccessible from within derivations of salhelper::Thread (an
      79                 :            :     // alternative would be to force such derivations to use global names,
      80                 :            :     // prefixed with ::osl::Thread):
      81                 :            :     using osl::Thread::getCurrentIdentifier;
      82                 :            :     using osl::Thread::wait;
      83                 :            :     using osl::Thread::yield;
      84                 :            : 
      85                 :       3544 :     static inline void * operator new(std::size_t size)
      86                 :       3544 :     { return SimpleReferenceObject::operator new(size); }
      87                 :            : 
      88                 :       3540 :     static inline void operator delete(void * pointer)
      89                 :       3540 :     { SimpleReferenceObject::operator delete(pointer); }
      90                 :            : 
      91                 :            : protected:
      92                 :            :     virtual ~Thread();
      93                 :            : 
      94                 :            :     /**
      95                 :            :        The main function executed by the thread.
      96                 :            : 
      97                 :            :        Any uncaught exceptions lead to std::terminate.
      98                 :            :     */
      99                 :            :     virtual void execute() = 0;
     100                 :            : 
     101                 :            : private:
     102                 :            :     virtual void SAL_CALL run();
     103                 :            : 
     104                 :            :     virtual void SAL_CALL onTerminated();
     105                 :            : 
     106                 :            :     char const * name_;
     107                 :            : };
     108                 :            : 
     109                 :            : }
     110                 :            : 
     111                 :            : #endif
     112                 :            : 
     113                 :            : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */