Development/Tutorials/D-Bus/Introduction (es)

Development/Tutorials/D-Bus/Introduction

Languages: عربي | Asturianu | Català | Česky | Kaszëbsczi | Dansk | Deutsch | English | Esperanto | Español | Eesti | فارسی | Suomi | Français | Galego | Italiano | 日本語 | 한국어 | Norwegian | Polski | Português Brasileiro | Română | Русский | Svenska | Slovenčina | Slovenščina | српски | Türkçe | Tiếng Việt | Українська | 简体中文 | 繁體中文

Introduction To D-BUS

Tutorial Series	D-Bus
Previous	None
What's Next	Accessing Interfaces
Further Reading	D-Bus documentation page

Abstracto

D-Bus es un software Libre y de Código Abierto especializado en el mecanismo de comunicación entre procesos Inter-Process Communication (IPC)) que es ampliamente utilizado hoy día para el software de código abierto para escritorio. Es parte del proyectofreedesktop.org y se utiliza en amplio rango de aplicaciones. Ejemplos de su uso lo tenemos en las notificaciones hotplug de Linux, consultas de búsquedas de escritorio en strigi y también como medio primario de Comunicación Entre Procesos de KDE 4. Este tutorial sirve de introducción a la terminología de D-Bus y sus conceptos básicos, desde la perspectiva del programador de aplicaciones.

¿Que es IPC?

El término "IPC" puede utilizarse para describir cualquier número de métodos para obtener información desde un proceso a otro. La información transmitida puede tener la forma de datos de aplicación, método de invocación o señales espontaneas. Actualmente la comunicación tiene lugar a través de sockets o pipes y algunas veces, como es el caso con D-Bus, utiliza un proceso para realizar el enrutamiento del mensaje, activación de servicio y control de acceso.

La utilización de IPC en el escritorio va desde el scripting (que permite utilizar un script (conjunto de sentencias) en un entorno común para interactuar o controlar varias aplicaciones) hasta para proveer acceso a servicios centralizados, permitiendo la coordinación entre múltiples instancias de aplicaciones cooperativas.

Como ejemplo concreto, el acceso a ficheros en KDE se realiza habitualmente a través del sistema de ficheros virtual (VFS:Virtual File System) KIO utilizando KIOSlaves. KIOSlaves consiste en una serie de aplicaciones que permiten el acceso a datos sobre un protocolo dado o especificación (e.g. http o APIs del sistema de ficheros local) mediante la implementación de funciones tales como lectura (read), escritura (write), etc Los esclavos (slaves) corren como procesos independientes e intercambian datos con la aplicación — con la cual el usuario está interactuando &mdash asíncronamente a través de IPC. Esto no solamente permite que múltiples aplicaciones utilicen el mismo esclavo (slave) sino que además permite al mismo esclavo mantenerse simple de forma que pueda realizar cosas como bloqueo de operaciones sin que ello cause el propio bloqueo de la aplicación gráfica. La aplicación gráfica nunca ve actualmente la ocurrencia IPC, como si esta tuviese lugar detrá de las escenas de la API KIO.

Otro ejemplo del uso de la IPC en KDE es el soporte de la aplicación única. Cuando se inicia una KUniqueApplication primeramente chequea si están corriendo otras instancias de la misma aplicación. Si es este el caso lo que hace es enviar un mensaje vía IPC para que dicha aplicación se muestre a sí misma.

El mecanismo primario de IPC para aplicaciones en KDE4 es D-BUS, el cual es un sistema muy popular utilizado por una variedad de software hoy día. QT4 aporta un conjunto de enlaces intuitivos y estables a D-Bus en la forma de clases C++. Esta serie de tutoriales introducen a D-Bus aparte de cubrir el uso de la API D-Bus en QT4. Este artículo en particular describe los conceptos de alto nivel en D-Bus y deja los detalles de como utilizar estas características y funcionalidad a los artículos que siguen.

Buses

D-Bus aporta múltiples "buses" de mensaje para que las aplicaciones se comuniquen entre sí. Cada bus aporta sus propias facilidades de conexión, la cual permite la separación de las diferentes categorias de mensajes: los mensajes enviados por un bus no pueden ser accedidos por otro bus, pero las aplicaciones conectadas al mismo bus pueden comunicarse entre ellas a trávés de él. De esta forma múltiples aplicaciones se pueden conectar al mismo bus en cualquier momento y también una aplicación se puede conectar a múltiples buses simultaneamente. Esto permite la aplicación de diferentes políticas de seguridad a buses diferentes al tiempo que se mantiene una eficiente compartición tanto de los mensajes locales como globales.

Se aporta por defecto un bus de sistema amplio para mensajes internos del kernel (núcleo) del sistema operativo y para otros servicios globales del sistema denominándose, apropiadamente, el bus del sistema (the system bus).

Este es el bus utilizado para cosas tales como señalizar cuando hay disponible nuevo hardware detectado en el sistema, tal como ocurre cuando una unidad flash se conecta o cuando se inserta un disco DVD en una unidad.

Cada sesión de escritorio (e.g. cada usuario logeado) tiene uno o más buses asociados. Estos reciben el nombre de buses de sesion. El bus por defecto de la actual sesión recibe el nombre El bus de sesión y es el que las aplicaciones de escritorio tenderán a usar con más frecuencia.

Adicionalmente, una aplicación puede crear su propio bus privados con otra aplicación en la modalidad de igual a igual (peer to peer).

No hay un límite práctico sobre el número de buses que pueden utilizar las aplicaciones asociadas a un usuario. Sin embargo es en la habilidad de compartir buses — y por tanto mensajes comunes — donde brillan realmente sistemas como D-Bus

Mensajes

La unidad base de comunicación en un bus es el mensaje. Toda la información pasada a través de bus se realiza en forma de mensajes, similar a la información transmitida utilizando TCP/IP vía paquetes.

Unlike network packets, however, each D-Bus message is guaranteed to contain the entire set of data being sent or received. In addition to the data being sent, messages also record who the sender and intended receiver are to allow for proper routing.

This system maps well to how desktop applications tend to work internally: method calls (messages) result in some action being taken with the possibility of return values. One of the primary additional features of D-Bus messages is that they are asynchronous: a message may be sent while the reply may not happen for an indeterminate period of time (timeouts are provided to prevent 'wait forever' deadlocks). Of course, there are conveniences in the Qt4 D-Bus API to make calls appear to be synchronous to the calling application.

Messages can be sent by an application to itself. These are "short-circuited" and kept local to the application, so it is not necessary for code in an application to worry about whether or not it might actually be calling a remote or local application. This is often useful in highly componentized apps and prevents possible deadlock situations.

Namespaces and Addresses

Since multiple applications can be on the same bus, and one application may provide multiple objects to which messages can be sent, it is necessary to have a means to effectively and unambiguously address any given object on any given bus, similar to the way a street address uniquely identifies any given residence or office. There are 3 pieces of information which, when taken together, create a unique address for any given object on a bus: interface, service and object name.

Interfaces

An interface is a set of callable methods and signals that are advertised on the bus. An interface provides a "contract" between the applications passing messages that defines the name, parameters (if any) and return values (if any) of the interface. These methods may not map directly in a one-to-one fashion to methods or API in the application that is advertising the interface, though they often do. This allows multiple applications to provide similar or the same interfaces, regardless of internal implementation, while allowing applications to use these interfaces without worrying about the internal design of the applications.

Interfaces can be described for documentation and code re-use purposes using XML. Not only can users and programmers reference the XML description of the interface, but developers can use classes that are auto-generated from the XML — making using D-Bus much easier and less error-prone (e.g. the compiler can check the syntax of messages at compile time).

Services

A service represents an application connection to a bus.

Service here corresponds to "well-known" Bus names in the D-Bus specification terminology. The term "Bus name" is a bit confusing. Regardless of how it sounds like, Bus names are the names of connections(!) on the bus, not names of buses(!). So here the term service will be used, as the Qt Documentation calls it.

These are kept unique by using a "reverse domain name" approach, as can be seen in many other systems that need to namespace for multiple components. Most services provided by applications from the KDE project itself use the org.kde prefix to their service name. So one may find "org.kde.screensaver" advertised on the session bus.

You should use the domain name for your organization or application for your service names. For example if your domain is awesomeapps.org and the name of your application is wickedwidget you would probably use org.awesomeapps.wickedwidget as the service name on the bus.

If an application has more than one connection to a bus, or if multiple instances of the same application may be active at once, it will need to use a unique service name for each connection. Often this is done by appending the process ID to the service name.

Objects

Of course, an application is likely to advertise access to more than one object on the bus. This many-to-one relationship between objects and services is accommodated by providing a path component to the address. Each path associated with a service represents a different, unique object. An example might be /MainInterface or /Documents/Doc1. The actual path structure is completely arbitrary and is up to the application providing the service as to what the paths should be. These paths simply provide a way to identify and logically group objects for applications that send messages to the application.

Some libraries export object paths with their "reverse domain" prepended to it, so as to properly namespace their objects. This is quite common for libraries and plugins that join an arbitrary service and must therefore avoid all clashing with objects exported by the application and other components. However, this practice is not in use in KDE applications and libraries.

Objects provide access to interfaces. In fact, a given object can provide access to multiple interfaces at the same time.

Putting It All Together

A D-Bus message contains an address made up of all the above components so that it can be routed to the correct application, object and method call. Such an address might look like this:

org.kde.krunner /ScreenSaver org.kde.screensaver.setBlankOnly

In this case org.kde.krunner is the service, /ScreenSaver is the path to the object, org.kde.screensaver is the interface the object exports and setBlankOnly is a method in the interface. If the /ScreenSaver object only provides the org.kde.screensaver interface (or the setBlankOnly method is unique amongst the services it implements) then this would work equally well as an address:

org.kde.krunner /ScreenSaver setBlankOnly

In this way each possible destination is uniquely and reliably addressable.

Calling and Being Called

Now that we have a way to address any given end point on the bus, we can examine the possibilities when it comes to actually sending or receiving messages.

Methods

Methods are messages that are sent to cause code to be executed in the receiving application. If the method is not available because, for instance, the address was wrong or the requested application is not running, an error will be returned to the calling application. If the method is successfully called, an optional return value will be returned to the calling application. Even if there is no return value provided, a success message will be returned. This round trip does have overhead, and it is important to keep this in mind for performance critical code.

Such method calls are always initiated by the calling application and the resulting messages have exactly one source and one destination address.

Signals

Signals are like method calls except that they happen in the "reverse" direction and are not tied to a single destination. A signal is emitted by the application which is exporting the interface and is available to any application on the same bus. This allows an application to spontaneously advertise changes in state or other events, to any applications which may be interested in tracking those changes.

If this sounds a lot like the signal and slots mechanism in Qt, that's because it is. For all intents and purposes it is a non-local version of the same functionality.

Useful Tools

There are several useful tools for exploring the D-Bus busses as well as developing applications that use D-Bus. We will now look briefly at end-user tools as the articles that follow cover the development tools in greater detail and context.

qdbus

qdbus is a command line tool which can be used to list the services, objects and interfaces on a given bus as well as send messages to a given address on the bus. It can be used to explore both the system and the default session bus. If the --system switch is passed, qdbus will connect to the system bus, otherwise it uses the session bus.

qdbus uses the rest of the supplied arguments on the command as an address and, if any, parameters to pass to a given object. If a full address is not supplied, then it lists all the objects available from that point on the bus. For instance, if no addresses are provided a list of available services is listed. If a service name is provided, object paths will be provided. If a path is also provided all methods in all interfaces will be listed. In this way one can quite easily explore and interact with objects on the bus, making qdbus very useful for testing, scripting and even idle exploration.

qdbusviewer

qdbusviewer is a Qt application that provides a graphical interface to essentially the same set of features that qdbus provides on the command line, thus providing a more user friendly mechanism to interact with the bus. qdbusviewer ships with Qt4 itself and is easy for anyone who is familiar with the basic D-Bus concepts, such as object addresses, to use.