include/dbaccess/AsyncronousLink.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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_DBACCESS_ASYNCRONOUSLINK_HXX
  21 #define INCLUDED_DBACCESS_ASYNCRONOUSLINK_HXX
  22
  23 #include <tools/link.hxx>
  24 #include <osl/mutex.hxx>
  25
  26 struct ImplSVEvent;
  27
  28 namespace dbaui
  29 {
  30
  31     // a helper for multi-threaded handling of async events
  32
  33     /** handles asynchronous links which may be called in multi-threaded environments
  34         If you use an instance of this class as member of your own class, it will handle
  35         several crucial points for you (for instance the case that somebody posts the
  36         event while another thread tries to delete this event in the _destructor_ of the
  37         class).
  38     */
  39     class OAsyncronousLink
  40     {
  41         Link                m_aHandler;
  42
  43     protected:
  44         ::osl::Mutex        m_aEventSafety;
  45         ::osl::Mutex        m_aDestructionSafety;
  46         ImplSVEvent *       m_nEventId;
  47
  48     public:
  49         /** constructs the object
  50             @param      _rHandler           The link to be called asyncronously
  51         */
  52         OAsyncronousLink( const Link& _rHandler );
  53         virtual ~OAsyncronousLink();
  54
  55         bool    IsRunning() const { return m_nEventId != 0; }
  56
  57         void Call( void* _pArgument = NULL );
  58         void CancelCall();
  59
  60     protected:
  61         DECL_LINK(OnAsyncCall, void*);
  62     };
  63 }
  64 #endif // INCLUDED_DBACCESS_ASYNCRONOUSLINK_HXX
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */