comp • gb.dbus • dbusconnection • register

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