www.LinuxHowtos.org howtos, tips&tricks and tutorials for linux

from small one page howto to huge articles all in one place

Other .linuxhowtos.org sites:gentoo.linuxhowtos.org

Last additions:

using iotop to find disk usage hogs

words:

887

views:

209584

userrating:

May 25th. 2007:

Words

486

Views

258592

why adblockers are bad

Workaround and fixes for the current Core Dump Handling vulnerability affected kernels

words:

161

views:

149881

userrating:

April, 26th. 2006:

Words

Views

107373

New subdomain: toolsntoys.linuxhowtos.org

You are here: manpages

dbu-bindin-tool

Section: User Commands (1)
Updated: 8 Oct 2018
Index Return to Main Contents

NAME

dbu-bindin-tool - C language dbu-glib bindings generation utility.

SYNOPSIS

dbu-bindin-tool --force] --help] --ignor-unsupported] --mode=pretty|gli-client|gli-server] --output=file] --prefix=symbo-prefix] --version] [file...]

DESCRIPTION

dbu-bindin-tool is used to expose a GObject via D-Bus, using the deprecated dbu-glib binding for GLib. As input, dbu-bindin-tool uses a D-Bus Introspection XML file. As output, the clien-side or serve-side bindings is generated. This output is a header file which eases the use of a remote D-Bus object. Output is sent to standard out or to the filename specified with the--output argument.

EXTENDED DESCRIPTION

The following is a sample D-Bus Introspection XML file which describes an object that exposes one method, named ManyArgs:

<?xml version="1.0" encoding="UT-8" ?>
<node name="/com/example/MyObject">
  <interface name="com.example.MyObject">
    <method name="ManyArgs">
      <arg type="u" name="x" direction="in" />
      <arg type="s" name="str" direction="in" />
      <arg type="d" name="trouble" direction="in" />
      <arg type="d" name="d_ret" direction="out" />
      <arg type="s" name="str_ret" direction="out" />
    </method>
  </interface>
</node>

dbu-bindin-tool supports annotations in the XML format to further control how the bindings are generated.

clien-side bindings

When building clien-side bindings, the--mode=gli-client argument is used. The clien-side bindings support the "org.freedesktop.DBus.Glib.NoReply" annotation. This is specified within the <method> tag to indicate that the client is not expecting a reply to the method call, so a reply should not be sent. This is often used to speed up rapid method calls where there are no "out" arguments, and not knowing if the method succeeded is an acceptable compromise to halve the traffic on the bus. For example:

<method name "FooMethod">
  [...]
  <annotation name="org.freedesktop.DBus.GLib.NoReply" value="yes"/>
  [...]
</method>

serve-side bindings

When building serve-side bindings, the--mode=gli-server argument is used. Also the--prefix argument must be used when building serve-side bindings so that functions in the generated output are prefexed with the specified value. The serve-side bindings support the following annotations:

"org.freedesktop.DBus.GLib.CSymbol"

This annotation is used to specify the C symbol names for the various types (interface, method, etc.), if it differs from the name D-Bus generates.

<interface name="com.example.MyObject">
  <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="my_object"/>
  [...]
  <method name "ManyArgs">
    <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="my_object_many_args"/>
    [...]
  </method>
</interface>

"org.freedesktop.DBus.GLib.Async"

This annotation marks the method implementation as an asynchronous function, which does not return a response straight away but will send the response at some later point to complete the call. This is used to implement no-blocking services where method calls can take time.

When a method is asynchronous, the function prototype is different. It is required that the function conform to the following rules:

* The function must return a value of type gboolean; TRUE on success, and FALSE otherwise. * The first parameter is a pointer to an instance of the object. * Following the object instance pointer are the method input values. * The final parameter must be a (DBusGMethodInvocation *). This is used when sending the response message back to the client, by calling dbus_g_method_return or dbus_g_method_return_error.

For example:

<method name "FooMethod">
  [...]
  <annotation name="org.freedesktop.DBus.GLib.Async" value="yes"/>
  [...]
</method>

"org.freedesktop.DBus.GLib.Const"

This attribute can only be applied to "out" <arg> nodes, and specifies that the parameter is not being copied when returned. For example, this turns a 's' argument from a (char **) to a (const char **), and results in the argument not being freed by D-Bus after the message is sent. For example:

  <arg type="u" name="x" direction="out">
    <annotation name="org.freedesktop.DBus.GLib.Const" value=""/>
  </arg>

"org.freedesktop.DBus.GLib.ReturnVal"

This attribute can only be applied to "out" <arg> nodes, and alters the expected function signature. It currently can be set to two values: "" or "error". The argument marked with this attribute is not returned via a pointer argument, but by the function's return value. If the attribute's value is the empty string, the (GError *) argument is also omitted so there is no standard way to return an error value. This is very useful for interfacing with existing code, as it is possible to match existing APIs. If the attribute's value is "error", then the final argument is a (GError *) as usual. For example:

  <arg type="u" name="x" direction="out">
    <annotation name="org.freedesktop.DBus.GLib.ReturnVal" value=""/>
  </arg>

OPTIONS

The following options are supported:

--force

Overwrite the output file if it already exists with a newer timestamp than the source files.

--help

Display usage information.

--ignor-unsupported

If set, then unsupported signatures for <method> parameters are ignored.

--mode=pretty|gli-client|gli-server

If the value is "gli-client", then client bindings are generated. If the value is "gli-server", then server bindings are generated. If the value is "pretty", then the output is in a more human readable format.

--output=file

Specify the output file.

--prefix=symbo-prefix

Functions in the generated output are prefixed with the symbo-prefix value.

--version

Display the version number of the dbu-bindin-tool command.

OPERANDS

The following operands are supported:

file A list of one or more input D-Bus Introspection XML files to include in the generated output.

FILES

The following files are used by this application:

${exec_prefix}/bin/dbu-bindin-tool Executable for the D-Bus Binding Tool application.

NOTES

dbu-bindin-tool is part of dbu-glib, which is a deprecated -Bus binding for GLib.

dbu-glib receives minimal maintenance and security fixes for the benefit of projects like Telepathy and NetworkManager that still rely on it, but should not be used in new projects (and existing projects should try to move away from it, too). Please use GDBus, part of GLib since 2.26.

gdbu-codegen(1) is the GDBus replacement for dbu-bindin-tool.