Branch data     Line data    Source code

       1                 :            : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2                 :            : /*************************************************************************
       3                 :            :  *
       4                 :            :  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
       5                 :            :  *
       6                 :            :  * Copyright 2000, 2010 Oracle and/or its affiliates.
       7                 :            :  *
       8                 :            :  * OpenOffice.org - a multi-platform office productivity suite
       9                 :            :  *
      10                 :            :  * This file is part of OpenOffice.org.
      11                 :            :  *
      12                 :            :  * OpenOffice.org is free software: you can redistribute it and/or modify
      13                 :            :  * it under the terms of the GNU Lesser General Public License version 3
      14                 :            :  * only, as published by the Free Software Foundation.
      15                 :            :  *
      16                 :            :  * OpenOffice.org is distributed in the hope that it will be useful,
      17                 :            :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      18                 :            :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      19                 :            :  * GNU Lesser General Public License version 3 for more details
      20                 :            :  * (a copy is included in the LICENSE file that accompanied this code).
      21                 :            :  *
      22                 :            :  * You should have received a copy of the GNU Lesser General Public License
      23                 :            :  * version 3 along with OpenOffice.org.  If not, see
      24                 :            :  * <http://www.openoffice.org/license.html>
      25                 :            :  * for a copy of the LGPLv3 License.
      26                 :            :  *
      27                 :            :  ************************************************************************/
      28                 :            : 
      29                 :            : #ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
      30                 :            : #define __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
      31                 :            : 
      32                 :            : #include <threadhelp/lockhelper.hxx>
      33                 :            : 
      34                 :            : namespace framework{
      35                 :            : 
      36                 :            : /*-************************************************************************************************************//**
      37                 :            :     @short          "baseclass" to make own classes threadsafe
      38                 :            :     @descr          Sometimes you must share your lock- or mutex member with any other baseclasses.
      39                 :            :                     And baseclasses are initialized erlier then members! That's why you should use
      40                 :            :                     this struct as first of your baseclasses!!!
      41                 :            :                     Then you will get a public member "m_aLock" which can be used by special guard implementations
      42                 :            :                     to make your code threadsafe.
      43                 :            : 
      44                 :            :     @seealso        class LockHelper
      45                 :            : 
      46                 :            :     @implements     -
      47                 :            :     @base           -
      48                 :            : 
      49                 :            :     @devstatus      ready to use
      50                 :            : *//*-*************************************************************************************************************/
      51                 :     138843 : struct ThreadHelpBase
      52                 :            : {
      53                 :            :     //-------------------------------------------------------------------------------------------------------------
      54                 :            :     //  public methods
      55                 :            :     //-------------------------------------------------------------------------------------------------------------
      56                 :            :     public:
      57                 :     143724 :         ThreadHelpBase( ::osl::SolarMutex* pSolarMutex = NULL )
      58                 :     143724 :                 :   m_aLock( pSolarMutex )
      59                 :            :         {
      60                 :     143724 :         }
      61                 :            : 
      62                 :            :     //-------------------------------------------------------------------------------------------------------------
      63                 :            :     //  public member
      64                 :            :     //  Make it mutable for using in const functions!
      65                 :            :     //-------------------------------------------------------------------------------------------------------------
      66                 :            :     public:
      67                 :            : 
      68                 :            :         mutable LockHelper m_aLock;
      69                 :            : };
      70                 :            : 
      71                 :            : }       //  namespace framework
      72                 :            : 
      73                 :            : #endif  //  #ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
      74                 :            : 
      75                 :            : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */