第一个 D-Bus 程序

本文通过编写一个简单的 D-Bus 程序,带领读者正式进入 D-Bus 编程。

程序功能

我们知道,D-Bus 是一种高级的 IPC 通信机制,在 D-Bus 通信过程中,存在一个后台进程(BUS Daemon Process),后台进程和普通进程间信息交互是通过域套接字进行通信。大致的通信流程如下图所示:

在该示例中,进程 2 作为服务端,接收消息前需要连接到总线(dbus_bus_get),并告知总线自己希望得到的消息类型(dbus_bus_add_match),然后等待接收消息(dbus_connection_pop_message)。进程 2 收到总线转发的消息时会根据消息类型,做不同的处理(若是信号类型则不需要发送返回值给总线)。

进程 1 作为客户端,需先连接到总线(dbus_bus_get),然后构造消息(dbus_message_new_signal),再发送消息(dbus_connection_send)到后台进程。后台进程接收消息,然后根据消息类型对消息进行不同处理(bus_dispatch_matches)。

完整代码可在 GitHub 获取。

代码实现

dbus-server.c

/* 服务端代码 */
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <dbus/dbus.h>

void listen_signal()
{
    DBusMessage * msg;
    DBusMessageIter arg;
    DBusConnection * connection;
    DBusError err;
    int ret;
    char * sigvalue;

    /* 步骤1:建立与D-Bus后台的连接 */
    dbus_error_init(&err);

    connection = dbus_bus_get(DBUS_BUS_SESSION, &err);

    if(dbus_error_is_set(&err)) {
        fprintf(stderr,"ConnectionError %s\n",err.message);
        dbus_error_free(&err);
    }
    if(connection == NULL) {
        return;
    }

    /* 步骤2:给连接名分配一个可记忆名字 getiot.singal.dest 作为 Bus name */
    /* 这个步骤不是必须的,但推荐这样处理 */
    ret =dbus_bus_request_name(connection, "getiot.singal.dest", DBUS_NAME_FLAG_REPLACE_EXISTING, &err);

    if(dbus_error_is_set(&err)){
        fprintf(stderr,"Name Error%s\n",err.message);
        dbus_error_free(&err);
    }
    if(ret != DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER)
        return;

    /* 步骤3:通知 D-Bus daemon,希望监听来自接口 getiot.signal.Type 的信号 */
    dbus_bus_add_match(connection, "type='signal',interface='getiot.signal.Type'", &err);

    /* 实际需要发送东西给 daemon 来通知希望监听的内容,所以需要 flush */
    dbus_connection_flush(connection);

    if(dbus_error_is_set(&err)) {
        fprintf(stderr, "Match Error%s\n", err.message);
        dbus_error_free(&err);
    }

    /* 步骤4:在循环中监听,每隔开1秒,就去试图自己的连接中获取这个信号 */
    /* 这里给出的是中连接中获取任何消息的方式,所以获取后去检查一下这个消息是否我们期望的信号,并获取内容 */
    /* 我们也可以通过这个方式来获取 method call 消息 */
    while(1) {
        dbus_connection_read_write(connection, 0);
        msg = dbus_connection_pop_message (connection);
        if(msg == NULL) {
            sleep(1);
            continue;
        }

        if(dbus_message_is_signal(msg,"getiot.signal.Type","Test")) {
            if(!dbus_message_iter_init(msg, &arg)) {
                fprintf(stderr,"MessageHas no Param");
            }
            else if(dbus_message_iter_get_arg_type(&arg) != DBUS_TYPE_STRING) {
                fprintf(stderr,"Param isnot string");
            }
            else {
                dbus_message_iter_get_basic(&arg, &sigvalue);
            }
            printf("Recetive Singal Value : %s\n", sigvalue);
        }
        dbus_message_unref(msg);
    } /* End of while */

}
int main(void)
{
    printf("------Start Listen_signal!-------\n");
    listen_signal();
    return 0;
}

dbus-client.c

/* 客户端代码 */
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <dbus/dbus-glib.h>
#include <dbus/dbus.h>
#include <unistd.h>

int send_a_signal(char * sigvalue)
{
    DBusError err;
    DBusConnection * connection;
    DBusMessage * msg;
    DBusMessageIter arg;
    dbus_uint32_t  serial =0;
    int ret;

    dbus_error_init(&err);

    /* 步骤1:建立与D-Bus后台的连接 */
    connection =dbus_bus_get(DBUS_BUS_SESSION, &err);

    if(dbus_error_is_set(&err)) {
        fprintf(stderr, "ConnectionErr : %s\n", err.message);
        dbus_error_free(&err);
    }
    if(connection == NULL) {
        return -1;
    }

    /* 步骤2:给连接名分配一个 well-known 的名字作为 Bus name,这个步骤不是必须的 */
    /* 可以用宏开关控制这段代码,调试时可以用这个名字来检查,是否已经开启了这个应用的另外的进程 */
#if 1
    ret = dbus_bus_request_name(connection, "getiot.singal.source", DBUS_NAME_FLAG_REPLACE_EXISTING, &err);

    if(dbus_error_is_set(&err)) {
        fprintf(stderr, "Name Err :%s\n", err.message);
        dbus_error_free(&err);
    }
    if(ret != DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER) {
        return -1;
    }
#endif

    /* 步骤3:发送一个信号,需要指定这个信号的路径(即可以指向对象)、接口,以及信号名,创建一个 Message */
    if((msg = dbus_message_new_signal("/getiot/signal/Object", "getiot.signal.Type", "Test")) == NULL) {
        fprintf(stderr,"MessageNULL\n");
        return -1;
    }
    /* 给这个信号(messge)具体的内容 */
    dbus_message_iter_init_append(msg,&arg);
    if(!dbus_message_iter_append_basic(&arg,DBUS_TYPE_STRING,&sigvalue)) {
        fprintf(stderr,"Out OfMemory!\n");
        return -1;
    }

    printf("Signal Send: %s\n",sigvalue);
    /* 步骤4: 将信号从连接中发送 */
    if( !dbus_connection_send(connection,msg,&serial)) {
        fprintf(stderr,"Out of Memory!\n");
        return -1;
    }
    dbus_connection_flush(connection);
    printf("--------Success Signal Send----------\n");

    /* 步骤5: 释放相关的分配的内存 */
    dbus_message_unref(msg );
    return 0;
}

int main(void)
{
    printf("------Start Send_a_signal!-------\n");
    send_a_signal("hello world");
    return 0;
}

Makefile

CFLAGS_DBUS = (shell pkg-config --cflags --libs dbus-1)
CFLAGS_DBUS_GLIB =(shell pkg-config --cflags --libs dbus-glib-1)

CFLAGS = -g -Wall -Werror


all: dbus-server dbus-client

dbus-server: dbus-server.c
    gcc <(CFLAGS) (CFLAGS_DBUS)(CFLAGS_DBUS_GLIB) -o @

dbus-client: dbus-client.c
    gcc< (CFLAGS)(CFLAGS_DBUS) (CFLAGS_DBUS_GLIB) -o@

clean:
    rm -f dbus-server
    rm -f dbus-client


.PHONY: all clean

编译运行

执行 make 命令编译 dbus-server.c 和 dbus-client.c 程序。

先运行服务端程序(dbus-server),再运行客户端程序(dbus-client),运行结果如下。

$ ./dbus-client 
------Start Send_a_signal!-------
Signal Send: hello world
--------Success Signal Send----------

$ ./dbus-server 
------Start Listen_signal!-------
Recetive Singal Value : hello world