DBusObjectManagerServer

gio.dbus_object_manager_server.DBusObjectManagerServer is used to export gio.dbus_object.DBusObject instances using the standardized `org.freedesktop.DBus.ObjectManager`

interface. For example, remote D-Bus clients can get all objects and properties in a single call. Additionally, any change in the object hierarchy is broadcast using signals. This means that D-Bus clients can keep caches up to date by only listening to D-Bus signals.

The recommended path to export an object manager at is the path form of the well-known name of a D-Bus service, or below. For example, if a D-Bus service is available at the well-known name net.example.ExampleService1, the object manager should typically be exported at /net/example/ExampleService1, or below (to allow for multiple object managers in a service).

It is supported, but not recommended, to export an object manager at the root path, /.

See gio.dbus_object_manager_client.DBusObjectManagerClient for the client-side code that is intended to be used with gio.dbus_object_manager_server.DBusObjectManagerServer or any D-Bus object implementing the org.freedesktop.DBus.ObjectManager interface.

class DBusObjectManagerServer : ObjectG , DBusObjectManager {

this(string objectPath);

void export_(gio.dbus_object_skeleton.DBusObjectSkeleton object);

void exportUniquely(gio.dbus_object_skeleton.DBusObjectSkeleton object);

gio.dbus_connection.DBusConnection getConnection();

bool isExported(gio.dbus_object_skeleton.DBusObjectSkeleton object);

void setConnection(gio.dbus_connection.DBusConnection connection);

bool unexport(string objectPath);

}

Constructors

this this(string objectPath): Creates a new #GDBusObjectManagerServer object.

Members

Functions

exportUniquely void exportUniquely(gio.dbus_object_skeleton.DBusObjectSkeleton object): Like gio.dbus_object_manager_server.DBusObjectManagerServer.export_ but appends a string of the form _N (with N being a natural number) to object's object path if an object with the given path already exists. As such, the #GDBusObjectProxy:g-object-path property of object may be modified.
export_ void export_(gio.dbus_object_skeleton.DBusObjectSkeleton object): Exports object on manager.
getConnection gio.dbus_connection.DBusConnection getConnection(): Gets the #GDBusConnection used by manager.
isExported bool isExported(gio.dbus_object_skeleton.DBusObjectSkeleton object): Returns whether object is currently exported on manager.
setConnection void setConnection(gio.dbus_connection.DBusConnection connection): Exports all objects managed by manager on connection. If connection is null, stops exporting objects.
unexport bool unexport(string objectPath): If manager has an object at path, removes the object. Otherwise does nothing.

Mixed In Members

From `mixin DBusObjectManagerT!()`

getInterface gio.dbus_interface.DBusInterface getInterface(string objectPath, string interfaceName): Gets the interface proxy for interface_name at object_path, if any.
getObject gio.dbus_object.DBusObject getObject(string objectPath): Gets the #GDBusObject at object_path, if any.
getObjectPath string getObjectPath(): Gets the object path that manager is for.
getObjects gio.dbus_object.DBusObject[] getObjects(): Gets all #GDBusObject objects known to manager.
connectInterfaceAdded ulong connectInterfaceAdded(T callback, Flag!"After" after): Connect to InterfaceAdded signal.
connectInterfaceRemoved ulong connectInterfaceRemoved(T callback, Flag!"After" after): Connect to InterfaceRemoved signal.
connectObjectAdded ulong connectObjectAdded(T callback, Flag!"After" after): Connect to ObjectAdded signal.
connectObjectRemoved ulong connectObjectRemoved(T callback, Flag!"After" after): Connect to ObjectRemoved signal.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

From DBusObjectManager

getInterface gio.dbus_interface.DBusInterface getInterface(string objectPath, string interfaceName): Gets the interface proxy for interface_name at object_path, if any.
getObject gio.dbus_object.DBusObject getObject(string objectPath): Gets the #GDBusObject at object_path, if any.
getObjectPath string getObjectPath(): Gets the object path that manager is for.
getObjects gio.dbus_object.DBusObject[] getObjects(): Gets all #GDBusObject objects known to manager.
connectInterfaceAdded ulong connectInterfaceAdded(T callback, Flag!"After" after): Connect to InterfaceAdded signal.
connectInterfaceRemoved ulong connectInterfaceRemoved(T callback, Flag!"After" after): Connect to InterfaceRemoved signal.
connectObjectAdded ulong connectObjectAdded(T callback, Flag!"After" after): Connect to ObjectAdded signal.
connectObjectRemoved ulong connectObjectRemoved(T callback, Flag!"After" after): Connect to ObjectRemoved signal.

gio dbus_object_manager_server classes