dbus-binding-tool - C language GLib bindings generation utility.


   dbus-binding-tool     [--force]     [--help]     [--ignore-unsupported]
   [--mode=pretty|glib-client|glib-server]                 [--output=file]
   [--prefix=symbol-prefix] [--version] [file...]


   dbus-binding-tool  is  used  to  expose a GObject via D-Bus.  As input,
   dbus-binding-tool uses a D-Bus Introspection XML file.  As output,  the
   client-side  or  server-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


   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="UTF-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" />

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

   client-side bindings
   When building client-side bindings, the --mode=glib-client argument  is
   used.        The       client-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"/>

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


   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

   <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"/>


   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 non-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"/>


   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=""/>


   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=""/>


   The following options are supported:


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


       Display usage information.


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


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


       Specify the output file.


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


       Display the version number of the dbus-binding-tool command.


   The following operands are supported:

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


   The following files are used by this application:

   /usr/bin/dbus-binding-tool      Executable  for  the D-Bus Binding Tool


   See attributes(5) for descriptions of the following attributes:

         ATTRIBUTE TYPE               ATTRIBUTE VALUE        
   Availability                 SUNWdbus-bindings            
   Interface stability          Volatile                     


   dbus-cleanup-sockets(1), dbus-daemon(1), dbus-monitor(1), dbus-send(1),
   dbus-uuidgen(1), libdbus-glib-1(3), attributes(5)


   Written by Brian Cameron, Sun Microsystems Inc., 2009.

More Linux Commands

aio_suspend(3) - wait for asynchronous I/O operation or time
The aio_suspend() function suspends the calling thread until one of the following occurs: * One or more of the asynchronous I/O requests in the list aiocb_list

unload(n) - Unload machine code (Local - Linux man page)....
This command tries to unload shared libraries previously loaded with load from the applications address space. fileName is the name of the file containing the l

filefuncs(3am) provide some file related functionality to ga
The filefuncs extension adds several functions that provide access to file-related facilities. chdir() The chdir() function is a direct hook to the chdir(2) sys

Tk_PostscriptFontName(3) - accessor functions for fonts.....
Given a tkfont, Tk_FontId returns the token that should be selected into an XGCValues structure in order to construct a graphics context that can be used to dra

Tk_InitConsoleChannels(3) - Install the console channels as
Tk_InitConsoleChannels is invoked to create a set of console channels and install them as the standard channels. All I/O on these channels will be discarded unt

snapperd(8) DBus daemon for snapper - Linux manual page.....
Snapperd is a DBus daemon for snapper and not for direct use by the user. HOMEPAGE http://snapper.io/ AUTHORS Arvin Schnell &lt;aschnell@suse.de&gt; SEE ALSO snapper(

sshd_config(5) - OpenSSH SSH daemon configuration file......
sshd(8) reads configuration data from /etc/ssh/sshd_config (or the file specified with -f on the command line). The file contains keyword-argument pairs, one pe

tk(n) - Manipulate Tk internal state - Linux manual page....
The tk command provides access to miscellaneous elements of Tks internal state. Most of the information manipulated by this command pertains to the application

terminfo(5) - terminal capability data base - Linux man page
Terminfo is a data base describing terminals, used by screen-oriented programs such as nvi(1), rogue(1) and libraries such as ncurses(3NCURSES). Terminfo descri

set_menu_format(3menu) - set and get menu sizes (Man Page)
The function set_menu_format sets the maximum display size of the given menu. If this size is too small to display all menu items, the menu will be made scrolla

auto_mkindex(n) - standard library of Tcl procedures........
Tcl includes a library of Tcl procedures for commonly-needed functions. The procedures defined in the Tcl library are generic ones suitable for use by many diff

IO::ScalarArray(3pm) - IO:: interface for reading/writing an
This class is part of the IO::Stringy distribution; see IO::Stringy for change log and general information. The IO::ScalarArray class implements objects which b

We can't live, work or learn in freedom unless the software we use is free.