include/dbus-c++/object.h

   1 /*
   2  *
   3  *  D-Bus++ - C++ bindings for D-Bus
   4  *
   5  *  Copyright (C) 2005-2009  Paolo Durante <shackan@gmail.com>
   6  *
   7  *
   8  *  This library is free software; you can redistribute it and/or
   9  *  modify it under the terms of the GNU Lesser General Public
  10  *  License as published by the Free Software Foundation; either
  11  *  version 2.1 of the License, or (at your option) any later version.
  12  *
  13  *  This library is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  *  Lesser General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU Lesser General Public
  19  *  License along with this library; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24
  25 #ifndef __DBUSXX_OBJECT_H
  26 #define __DBUSXX_OBJECT_H
  27
  28 #include <string>
  29 #include <list>
  30
  31 #include "api.h"
  32 #include "interface.h"
  33 #include "connection.h"
  34 #include "message.h"
  35 #include "types.h"
  36
  37 namespace DBus {
  38
  39 class DBUSXXAPI Object
  40 {
  41 protected:
  42
  43         Object(Connection &conn, const Path &path, const char *service);
  44
  45 public:
  46
  47         virtual ~Object();
  48
  49         const DBus::Path &path() const { return _path; }
  50
  51         const std::string &service() const { return _service; }
  52
  53         Connection &conn() { return _conn; }
  54
  55 private:
  56
  57         DBUSXXAPILOCAL virtual bool handle_message(const Message &) = 0;
  58         DBUSXXAPILOCAL virtual void register_obj() = 0;
  59         DBUSXXAPILOCAL virtual void unregister_obj() = 0;
  60
  61 private:
  62
  63         Connection      _conn;
  64         DBus::Path      _path;
  65         std::string     _service;
  66 };
  67
  68 /*
  69 */
  70
  71 class ObjectAdaptor;
  72
  73 typedef std::list<ObjectAdaptor *> ObjectAdaptorPList;
  74 typedef std::list<std::string> ObjectPathList;
  75
  76 class DBUSXXAPI ObjectAdaptor : public Object, public virtual AdaptorBase
  77 {
  78 public:
  79
  80         static ObjectAdaptor *from_path(const Path &path);
  81
  82         static ObjectAdaptorPList from_path_prefix(const std::string &prefix);
  83
  84         static ObjectPathList child_nodes_from_prefix(const std::string &prefix);
  85
  86         struct Private;
  87
  88         ObjectAdaptor(Connection &conn, const Path &path);
  89
  90         ~ObjectAdaptor();
  91
  92         ObjectAdaptor &object() { return *this; }
  93
  94 private:
  95
  96         void _emit_signal(SignalMessage &);
  97
  98         bool handle_message(const Message &);
  99
 100         void register_obj();
 101         void unregister_obj();
 102
 103 friend struct Private;
 104 };
 105
 106 /*
 107 */
 108
 109 class ObjectProxy;
 110
 111 typedef std::list<ObjectProxy *> ObjectProxyPList;
 112
 113 class DBUSXXAPI ObjectProxy : public Object, public virtual ProxyBase,
 114                               virtual public CallbackTarget
 115 {
 116 public:
 117
 118         ObjectProxy(Connection &conn, const Path &path, const char *service = "");
 119
 120         ~ObjectProxy();
 121
 122         ObjectProxy &object() { return *this; }
 123
 124 private:
 125
 126         Message _invoke_method(CallMessage &, int timeout);
 127         PendingCall _invoke_method_async(CallMessage &, const PendingCallSlot &, void*, int timeout);
 128
 129         bool handle_message(const Message &);
 130
 131         void register_obj();
 132         void unregister_obj();
 133
 134 private:
 135
 136         MessageSlot _filtered;
 137         PendingCalls _pending;
 138
 139 friend class PendingCall; //TODO: in order to manage pending calls lifetime
 140 friend struct PendingCall::Private; //TODO:  in order to manage pending calls lifetime
 141 };
 142
 143 } /* namespace DBus */
 144
 145 #endif//__DBUSXX_OBJECT_H