herrie/src/dbus.h

   1 /*
   2  * Copyright (c) 2006-2011 Ed Schouten <ed@80386.nl>
   3  * All rights reserved.
   4  *
   5  * Copyright (c) 2008 Steve Jothen <sjothen@gmail.com>
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29 /**
  30  * @file dbus.h
  31  * @brief DBus integration.
  32  */
  33
  34 #ifdef BUILD_DBUS
  35 /**
  36  * @brief Initialize DBus locking.
  37  */
  38 void dbus_init(void);
  39
  40 /**
  41  * @brief DBus mutex to provide exclusion between the user input and
  42  *        DBus event paths.
  43  */
  44 extern GMutex *dbus_mtx;
  45
  46 /**
  47  * @brief Called before entering the gmainloop
  48  */
  49 void dbus_before_mainloop(void);
  50
  51 /**
  52  * @brief Called after exiting the gmainloop
  53  */
  54 void dbus_after_mainloop(void);
  55
  56 /**
  57  * @brief Acquire a lock on DBus.
  58  */
  59 static inline void
  60 dbus_lock(void)
  61 {
  62         g_mutex_lock(dbus_mtx);
  63 }
  64
  65 /**
  66  * @brief Release a lock on DBus.
  67  */
  68 static inline void
  69 dbus_unlock(void)
  70 {
  71         g_mutex_unlock(dbus_mtx);
  72 }
  73 #endif /* BUILD_DBUS */