1 /* 2 * This file is part of gtkD. 3 * 4 * gtkD is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU Lesser General Public License 6 * as published by the Free Software Foundation; either version 3 7 * of the License, or (at your option) any later version, with 8 * some exceptions, please read the COPYING file. 9 * 10 * gtkD 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 Lesser General Public License for more details. 14 * 15 * You should have received a copy of the GNU Lesser General Public License 16 * along with gtkD; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA 18 */ 19 20 // generated automatically - do not change 21 // find conversion definition on APILookup.txt 22 // implement new conversion functionalities on the wrap.utils pakage 23 24 25 module gio.DBusObjectManagerServer; 26 27 private import gio.DBusConnection; 28 private import gio.DBusObjectManagerIF; 29 private import gio.DBusObjectManagerT; 30 private import gio.DBusObjectSkeleton; 31 private import glib.ConstructionException; 32 private import glib.Str; 33 private import gobject.ObjectG; 34 private import gtkc.gio; 35 public import gtkc.giotypes; 36 37 38 /** 39 * #GDBusObjectManagerServer is used to export #GDBusObject instances using 40 * the standardized 41 * [org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) 42 * interface. For example, remote D-Bus clients can get all objects 43 * and properties in a single call. Additionally, any change in the 44 * object hierarchy is broadcast using signals. This means that D-Bus 45 * clients can keep caches up to date by only listening to D-Bus 46 * signals. 47 * 48 * The recommended path to export an object manager at is the path form of the 49 * well-known name of a D-Bus service, or below. For example, if a D-Bus service 50 * is available at the well-known name `net.example.ExampleService1`, the object 51 * manager should typically be exported at `/net/example/ExampleService1`, or 52 * below (to allow for multiple object managers in a service). 53 * 54 * It is supported, but not recommended, to export an object manager at the root 55 * path, `/`. 56 * 57 * See #GDBusObjectManagerClient for the client-side code that is 58 * intended to be used with #GDBusObjectManagerServer or any D-Bus 59 * object implementing the org.freedesktop.DBus.ObjectManager 60 * interface. 61 * 62 * Since: 2.30 63 */ 64 public class DBusObjectManagerServer : ObjectG, DBusObjectManagerIF 65 { 66 /** the main Gtk struct */ 67 protected GDBusObjectManagerServer* gDBusObjectManagerServer; 68 69 /** Get the main Gtk struct */ 70 public GDBusObjectManagerServer* getDBusObjectManagerServerStruct() 71 { 72 return gDBusObjectManagerServer; 73 } 74 75 /** the main Gtk struct as a void* */ 76 protected override void* getStruct() 77 { 78 return cast(void*)gDBusObjectManagerServer; 79 } 80 81 protected override void setStruct(GObject* obj) 82 { 83 gDBusObjectManagerServer = cast(GDBusObjectManagerServer*)obj; 84 super.setStruct(obj); 85 } 86 87 /** 88 * Sets our main struct and passes it to the parent class. 89 */ 90 public this (GDBusObjectManagerServer* gDBusObjectManagerServer, bool ownedRef = false) 91 { 92 this.gDBusObjectManagerServer = gDBusObjectManagerServer; 93 super(cast(GObject*)gDBusObjectManagerServer, ownedRef); 94 } 95 96 // add the DBusObjectManager capabilities 97 mixin DBusObjectManagerT!(GDBusObjectManagerServer); 98 99 100 /** */ 101 public static GType getType() 102 { 103 return g_dbus_object_manager_server_get_type(); 104 } 105 106 /** 107 * Creates a new #GDBusObjectManagerServer object. 108 * 109 * The returned server isn't yet exported on any connection. To do so, 110 * use g_dbus_object_manager_server_set_connection(). Normally you 111 * want to export all of your objects before doing so to avoid 112 * [InterfacesAdded](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) 113 * signals being emitted. 114 * 115 * Params: 116 * objectPath = The object path to export the manager object at. 117 * 118 * Returns: A #GDBusObjectManagerServer object. Free with g_object_unref(). 119 * 120 * Since: 2.30 121 * 122 * Throws: ConstructionException GTK+ fails to create the object. 123 */ 124 public this(string objectPath) 125 { 126 auto p = g_dbus_object_manager_server_new(Str.toStringz(objectPath)); 127 128 if(p is null) 129 { 130 throw new ConstructionException("null returned by new"); 131 } 132 133 this(cast(GDBusObjectManagerServer*) p, true); 134 } 135 136 /** 137 * Exports @object on @manager. 138 * 139 * If there is already a #GDBusObject exported at the object path, 140 * then the old object is removed. 141 * 142 * The object path for @object must be in the hierarchy rooted by the 143 * object path for @manager. 144 * 145 * Note that @manager will take a reference on @object for as long as 146 * it is exported. 147 * 148 * Params: 149 * object = A #GDBusObjectSkeleton. 150 * 151 * Since: 2.30 152 */ 153 public void expor(DBusObjectSkeleton object) 154 { 155 g_dbus_object_manager_server_export(gDBusObjectManagerServer, (object is null) ? null : object.getDBusObjectSkeletonStruct()); 156 } 157 158 /** 159 * Like g_dbus_object_manager_server_export() but appends a string of 160 * the form _N (with N being a natural number) to @object's object path 161 * if an object with the given path already exists. As such, the 162 * #GDBusObjectProxy:g-object-path property of @object may be modified. 163 * 164 * Params: 165 * object = An object. 166 * 167 * Since: 2.30 168 */ 169 public void exportUniquely(DBusObjectSkeleton object) 170 { 171 g_dbus_object_manager_server_export_uniquely(gDBusObjectManagerServer, (object is null) ? null : object.getDBusObjectSkeletonStruct()); 172 } 173 174 /** 175 * Gets the #GDBusConnection used by @manager. 176 * 177 * Returns: A #GDBusConnection object or %NULL if 178 * @manager isn't exported on a connection. The returned object should 179 * be freed with g_object_unref(). 180 * 181 * Since: 2.30 182 */ 183 public DBusConnection getConnection() 184 { 185 auto p = g_dbus_object_manager_server_get_connection(gDBusObjectManagerServer); 186 187 if(p is null) 188 { 189 return null; 190 } 191 192 return ObjectG.getDObject!(DBusConnection)(cast(GDBusConnection*) p, true); 193 } 194 195 /** 196 * Returns whether @object is currently exported on @manager. 197 * 198 * Params: 199 * object = An object. 200 * 201 * Returns: %TRUE if @object is exported 202 * 203 * Since: 2.34 204 */ 205 public bool isExported(DBusObjectSkeleton object) 206 { 207 return g_dbus_object_manager_server_is_exported(gDBusObjectManagerServer, (object is null) ? null : object.getDBusObjectSkeletonStruct()) != 0; 208 } 209 210 /** 211 * Exports all objects managed by @manager on @connection. If 212 * @connection is %NULL, stops exporting objects. 213 * 214 * Params: 215 * connection = A #GDBusConnection or %NULL. 216 */ 217 public void setConnection(DBusConnection connection) 218 { 219 g_dbus_object_manager_server_set_connection(gDBusObjectManagerServer, (connection is null) ? null : connection.getDBusConnectionStruct()); 220 } 221 222 /** 223 * If @manager has an object at @path, removes the object. Otherwise 224 * does nothing. 225 * 226 * Note that @object_path must be in the hierarchy rooted by the 227 * object path for @manager. 228 * 229 * Params: 230 * objectPath = An object path. 231 * 232 * Returns: %TRUE if object at @object_path was removed, %FALSE otherwise. 233 * 234 * Since: 2.30 235 */ 236 public bool unexport(string objectPath) 237 { 238 return g_dbus_object_manager_server_unexport(gDBusObjectManagerServer, Str.toStringz(objectPath)) != 0; 239 } 240 }