libs/pbd/pbd/crossthread.h

   1 /*
   2     Copyright (C) 2000-2007 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __pbd__crossthread_h__
  21 #define __pbd__crossthread_h__
  22
  23 #include <pbd/abstract_ui.h>
  24 #include <sigc++/sigc++.h>
  25 #include <pthread.h>
  26
  27 template<class RequestType>
  28 void
  29 call_slot_from_thread_or_dispatch_it (pthread_t thread_id, AbstractUI<RequestType>& ui, sigc::slot<void> theSlot)
  30 {
  31         /* when called, this function will determine whether the calling thread
  32            is the same as thread specified by the first argument. if it is,
  33            the we execute the slot. if not, we ask the interface given by the second
  34            argument to call the slot.
  35         */
  36
  37         if (pthread_self() == thread_id) {
  38                 theSlot ();
  39         } else {
  40                 ui.call_slot (theSlot);
  41         }
  42 }
  43
  44 template<class RequestType>
  45 sigc::slot<void>
  46 crossthread_safe (pthread_t thread_id, AbstractUI<RequestType>& ui, sigc::slot<void> theSlot)
  47 {
  48         /* this function returns a slot that will ensure that theSlot is either
  49            called by the specified thread or passed to the interface via
  50            AbstractUI::call_slot().
  51         */
  52
  53         return sigc::bind (sigc::ptr_fun (call_slot_from_thread_or_dispatch_it<RequestType>),
  54                            thread_id, ui, theSlot);
  55 }
  56
  57 #endif /* __pbd__crossthread_h__ */