dbus/mainloop/__init__.py

   1 # Copyright (C) 2006 Collabora Ltd. <http://www.collabora.co.uk/>
   2 #
   3 # Licensed under the Academic Free License version 2.1
   4 #
   5 # This library is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU Lesser General Public License as published by
   7 # the Free Software Foundation; either version 2.1 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This library is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU Library General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU Library General Public License
  16 # along with this library; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18
  19 """Base definitions, etc. for main loop integration.
  20
  21 """
  22
  23 import _dbus_bindings
  24
  25 NativeMainLoop = _dbus_bindings.NativeMainLoop
  26
  27 NULL_MAIN_LOOP = _dbus_bindings.NULL_MAIN_LOOP
  28 """A null mainloop which doesn't actually do anything.
  29
  30 For advanced users who want to dispatch events by hand. This is almost
  31 certainly a bad idea - if in doubt, use the GLib main loop found in
  32 `dbus.mainloop.glib`.
  33 """
  34
  35 WATCH_READABLE = _dbus_bindings.WATCH_READABLE
  36 """Represents a file descriptor becoming readable.
  37 Used to implement file descriptor watches."""
  38
  39 WATCH_WRITABLE = _dbus_bindings.WATCH_WRITABLE
  40 """Represents a file descriptor becoming readable.
  41 Used to implement file descriptor watches."""
  42
  43 WATCH_HANGUP = _dbus_bindings.WATCH_HANGUP
  44 """Represents a file descriptor reaching end-of-file.
  45 Used to implement file descriptor watches."""
  46
  47 WATCH_ERROR = _dbus_bindings.WATCH_ERROR
  48 """Represents an error condition on a file descriptor.
  49 Used to implement file descriptor watches."""
  50
  51 __all__ = (
  52            # Imported into this module
  53            'NativeMainLoop', 'WATCH_READABLE', 'WATCH_WRITABLE',
  54            'WATCH_HANGUP', 'WATCH_ERROR', 'NULL_MAIN_LOOP',
  55
  56            # Submodules
  57            'glib'
  58            )