sal/inc/osl/getglobalmutex.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: getglobalmutex.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #if !defined INCLUDED_OSL_GETGLOBALMUTEX_HXX
  32 #define INCLUDED_OSL_GETGLOBALMUTEX_HXX
  33
  34 #include "osl/mutex.hxx"
  35
  36 namespace osl {
  37
  38 /** A helper functor for the rtl_Instance template.
  39
  40     See the rtl_Instance template for examples of how this class is used.
  41  */
  42 class GetGlobalMutex
  43 {
  44 public:
  45     ::osl::Mutex * operator()()
  46     {
  47         return ::osl::Mutex::getGlobalMutex();
  48     }
  49 };
  50
  51 }
  52
  53 #endif // INCLUDED_OSL_GETGLOBALMUTEX_HXX