Gambas Documentation
Application Repository
Code Snippets
Compilation & Installation
Components
gb
gb.args
gb.cairo
gb.chart
gb.clipper
gb.complex
gb.compress
gb.crypt
gb.data
gb.db
gb.db.form
gb.db.mysql
gb.db.odbc
gb.db.postgresql
gb.db.sqlite2
gb.db.sqlite3
gb.dbus
.DBusObserver.Message
_DBus
_DBusConnection
Applications
Register
Tag
Unregister
DBus
DBusApplication
DBusConnection
DBusObject
DBusObserver
DBusProxy
DBusSignal
DBusValues
DBusVariant
gb.dbus.trayicon
gb.debug
gb.desktop
gb.desktop.gnome.keyring
gb.desktop.x11
gb.eval
gb.eval.highlight
gb.form
gb.form.dialog
gb.form.editor
gb.form.htmlview
gb.form.mdi
gb.form.print
gb.form.stock
gb.form.terminal
gb.gmp
gb.gsl
gb.gtk
gb.gtk.opengl
gb.gtk3
gb.gtk3.opengl
gb.gtk3.webview
gb.gui
gb.gui.opengl
gb.gui.qt
gb.gui.qt.ext
gb.gui.qt.opengl
gb.gui.qt.webkit
gb.gui.trayicon
gb.gui.webview
gb.hash
gb.highlight
gb.image
gb.image.effect
gb.image.imlib
gb.image.io
gb.inotify
gb.jit
gb.libxml
gb.logging
gb.map
gb.markdown
gb.media
gb.media.form
gb.memcached
gb.mime
gb.mysql
gb.ncurses
gb.net
gb.net.curl
gb.net.pop3
gb.net.smtp
gb.openal
gb.opengl
gb.opengl.glsl
gb.opengl.glu
gb.opengl.sge
gb.openssl
gb.option
gb.pcre
gb.pdf
gb.poppler
gb.qt4
gb.qt4.ext
gb.qt4.opengl
gb.qt4.webkit
gb.qt4.webview
gb.qt5
gb.qt5.ext
gb.qt5.opengl
gb.qt5.webkit
gb.qt5.webview
gb.qt6
gb.qt6.ext
gb.qt6.opengl
gb.qt6.webview
gb.report
gb.report2
gb.scanner
gb.sdl
gb.sdl.sound
gb.sdl2
gb.sdl2.audio
gb.settings
gb.signal
gb.term
gb.test
gb.util
gb.util.web
gb.v4l
gb.vb
gb.web
gb.web.feed
gb.web.form
gb.web.gui
gb.xml
gb.xml.html
gb.xml.rpc
gb.xml.xslt
Controls pictures
Deprecated components
Developer Documentation
Development Environment Documentation
Documents
Error Messages
Gambas Playground
How To's
Language Index
Language Overviews
Last Changes
Lexicon
README
Search the wiki
To Do
Topics
Tutorials
Wiki License
Wiki Manual

_DBusConnection.Register (gb.dbus)

Sub Register ( Object As DBusObject, Path As String [ , Interface As String[] ] )

Export a DBusObject object to the bus.

  • Object is the DBusObject to export.

  • Path is the D-Bus path where the object will be attached.

  • Interfaces allows to specify the name of additional interfaces implemented by the DBus object.

What is exported?

  • Public methods whose name has no underscore inside, and whose arguments and return type can be converted to a D-Bus datatype.

  • Public properties whose name has no underscore inside, and whose type can be converted to a D-Bus datatype.

As soon as you register at least one object, your application appears on the bus with the name org.gambas.<application name>.

All method and properties whose name begins with an interface name specified in the Interfaces argument, where points are replaced by underscore, and followed by an extra underscore, are exported under that interface.

All other methods and properties are exported through an interface named org.gambas.<application name>.<class name>. If you don't specify the Interfaces argument, all methods are properties are indifferently exported through that interface.

Example

Let suppose you have a project named MyProject that wants to export a class named MyDBusClass as a unique object.

Here is the MyDBusClass source code:

' MyDBusClass class

Inherits DBusObject

Create Static

Public Sub Compute(Value1 As Float, Value2 As Float) As Float

  Return Value1 + Value2

End

Here is the project startup method that will register the DBus object:

' Main module

Public Sub Main

  DBus.Session.Register(MyDBusClass, "/MyDBusClass")

End

Then, you will be able to run the exported class from another application that way:

Print DBus["org.gambas.MyProject"]["/MyDBusClass"].Compute(3, 4)

7