dbus的入門於應用–dbus的C編程介面

大部分資料都講了很多東西卻最終沒有讓我搞清楚怎麼用 DBus，不就是一個 IPC 通訊的工具嗎？就沒有一點實用些的資料嗎？看了很多資料之後還是覺得只見樹木不見森林。仔細整理下思路，覺得還是應該從最基本的方面入門，先從DBus 的 C API 入手學習，有了這些知識，就算麻煩，也可以先在完成一個準系統的例子程式的同時大概的知道
DBus 的運行機制。

在網上找到這麼一篇文章：http://www.matthew.ath.cx/misc/dbus， 正合我意，下面的內容基本是對這篇文章的翻譯和擴充。

注意：

翻譯沒有得到原文作者同意，原文也很簡單易懂，最好去讀原文。如果收到投訴，我會立即撤掉本文的。
本文不是一篇好的 DBus 入門，有很多基本的東西不在記述之內。
一般情況下不會直接使用 C API 進行 DBus 的編程，而是使用某種 DBus-binding，但我覺得理解 DBus 的 C API 對完整地理解 DBus 是非常重要的。

雖然 DBus 是用 C 寫的，而且本文寫的是 C API，但是 DBus 設計中充滿的物件導向的思想，請注意。

一、共通部分的代碼
在使用 DBus 進行通訊的時候，有一些代碼是無論如何都會使用到的。首先，你必須要串連上 Dbus，一般來說，系統中會有一個 System Bus 和一個 Session Bus（他們的差別，請參考我另外的筆記）。其次，你需要在 Dbus 中註冊一個名字，用於標識自己。為了簡單起見，這裡先不考慮重名的情況：

DBusError err;DBusConnection* conn;int ret;// initialise the errorsdbus_error_init(&err); // connect to the busconn = dbus_bus_get(DBUS_BUS_SESSION, &err);if (dbus_error_is_set(&err)) {    fprintf(stderr, "Connection Error (%s)\n", err.message);    dbus_error_free(&err);}if (NULL == conn) {    exit(1);}// request a name on the busret = dbus_bus_request_name(conn, "test.method.server",                            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 (DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER != ret) {    exit(1);}

一般來說，串連上 Dbus 和註冊一個名稱，應該是在程式最開始啟動並執行時候就會進行的操作。

當然，在程式的結束的時候，需要關閉掉與 Dbus 的串連。使用下面的函數：

dbus_connection_close(conn);

二、發送訊號（Sending Signal）
訊號是一種廣播的訊息，你可以簡單的發出一個訊號，這樣，所有串連在 DBus 匯流排上並註冊了接受對應訊號的進程，都會收到這個訊號。為了發出一個訊號，需要的只是建立一個 DBusMessage 對象來代表訊號，然後追加上一些需要發出的參數，就可以發向匯流排了。發完之後還需要釋放掉 Message。如果記憶體不足的話，這下面不少函數都會返回 false，所以一般情況下你都需要處理這些情況的傳回值。

dbus_uint32_t serial = 0; // unique number to associate replies with requestsDBusMessage* msg;DBusMessageIter args; // create a signal and check for errorsmsg = dbus_message_new_signal("/test/signal/Object", // object name of the signal                              "test.signal.Type", // interface name of the signal                              "Test"); // name of the signalif (NULL == msg){    fprintf(stderr, "Message Null\n");    exit(1);} // append arguments onto signaldbus_message_iter_init_append(msg, &args);if (!dbus_message_iter_append_basic(&args, DBUS_TYPE_STRING, &sigvalue)) {    fprintf(stderr, "Out Of Memory!\n");    exit(1);} // send the message and flush the connectionif (!dbus_connection_send(conn, msg, &serial)) {    fprintf(stderr, "Out Of Memory!\n");    exit(1);}dbus_connection_flush(conn); // free the messagedbus_message_unref(msg);

三、調用方法（Calling a Method）
調用一個遠程方法（remote method）與發送一個訊號（sending a signal）是很類似的。需要建立一個 DBusMessage，然後通過註冊在 DBus 上的名稱指定發送的對象。然後追加相應的參數，但調用方法分為兩種，一種是阻塞式的，另一種則可以非同步呼叫。非同步呼叫的時候會得到一個 DBusMessage* 的返回，從這個 DBusMessage 中可以擷取一些返回的參數。

調用方法1：

DBusMessage* msg;DBusMessageIter args;DBusPendingCall* pending; msg = dbus_message_new_method_call("test.method.server", // target for the method call                                   "/test/method/Object", // object to call on                                   "test.method.Type", // interface to call on                                   "Method"); // method nameif (NULL == msg) {    fprintf(stderr, "Message Null\n");    exit(1);} // append argumentsdbus_message_iter_init_append(msg, &args);if (!dbus_message_iter_append_basic(&args, DBUS_TYPE_STRING, ¶m)) {    fprintf(stderr, "Out Of Memory!\n");    exit(1);} // send message and get a handle for a replyif (!dbus_connection_send_with_reply (conn, msg, &pending, -1)) { // -1 is default timeout    fprintf(stderr, "Out Of Memory!\n");    exit(1);}if (NULL == pending) {    fprintf(stderr, "Pending Call Null\n");    exit(1);}dbus_connection_flush(conn); // free messagedbus_message_unref(msg);

調用方法2：

bool stat;dbus_uint32_t level; // block until we receive a replydbus_pending_call_block(pending); // get the reply messagemsg = dbus_pending_call_steal_reply(pending);if (NULL == msg) {    fprintf(stderr, "Reply Null\n");    exit(1);}// free the pending message handledbus_pending_call_unref(pending); // read the parametersif (!dbus_message_iter_init(msg, &args))    fprintf(stderr, "Message has no arguments!\n");else if (DBUS_TYPE_BOOLEAN != dbus_message_iter_get_arg_type(&args))    fprintf(stderr, "Argument is not boolean!\n");else    dbus_message_iter_get_basic(&args, &stat); if (!dbus_message_iter_next(&args))    fprintf(stderr, "Message has too few arguments!\n");else if (DBUS_TYPE_UINT32 != dbus_message_iter_get_arg_type(&args))    fprintf(stderr, "Argument is not int!\n");else    dbus_message_iter_get_basic(&args, &level); printf("Got Reply: %d, %d\n", stat, level); // free reply and close connectiondbus_message_unref(msg);

四、接收訊息（Receiving a Signal）
接下來的兩種操作主要是從匯流排從讀取訊息並處理這些訊息。
要接收一個訊息，你首先需要告訴 DBus 你對什麼樣的訊息感興趣：

// add a rule for which messages we want to seedbus_bus_add_match(conn,                   "type='signal',interface='test.signal.Type'",                   &err); // see signals from the given interfacedbus_connection_flush(conn);if (dbus_error_is_set(&err)) {    fprintf(stderr, "Match Error (%s)\n", err.message);    exit(1);}

然後，進程就可以在一個迴圈中等待這類訊息的發生了：

/ loop listening for signals being emmittedwhile (true) {     // non blocking read of the next available message    dbus_connection_read_write(conn, 0);    msg = dbus_connection_pop_message(conn);     // loop again if we haven't read a message    if (NULL == msg) {        sleep(1);        continue;    }     // check if the message is a signal from the correct interface and with the correct name    if (dbus_message_is_signal(msg, "test.signal.Type", "Test")) {        // read the parameters        if (!dbus_message_iter_init(msg, &args))            fprintf(stderr, "Message has no arguments!\n");        else if (DBUS_TYPE_STRING != dbus_message_iter_get_arg_type(&args))            fprintf(stderr, "Argument is not string!\n");        else {            dbus_message_iter_get_basic(&args, &sigvalue);            printf("Got Signal with value %s\n", sigvalue);        }    }     // free the message    dbus_message_unref(msg);}

五、提供被遠程調用的方法（Exposing a Method to be called）
在第二節中，我們看到了調用一個遠程方法，這節就是告訴我們怎麼樣提供一個方法讓別的應用程式調用。用下面的程式，就可以把方法關聯在那些提供給外部的方法上，並解析出相應的參數，最後構建一個訊息返回給調用方法的應用程式。

提供被遠程調用的方法1：

// loop, testing for new messageswhile (true) {    // non blocking read of the next available message    dbus_connection_read_write(conn, 0);    msg = dbus_connection_pop_message(conn);      // loop again if we haven't got a message    if (NULL == msg) {        sleep(1);        continue;    }     // check this is a method call for the right interface and method    if (dbus_message_is_method_call(msg, "test.method.Type", "Method"))        reply_to_method_call(msg, conn);     // free the message    dbus_message_unref(msg);}

提供被遠程調用的方法2：

void reply_to_method_call(DBusMessage* msg, DBusConnection* conn){    DBusMessage* reply;    DBusMessageIter args;    DBusConnection* conn;    bool stat = true;    dbus_uint32_t level = 21614;    dbus_uint32_t serial = 0;    char* param = "";     // read the arguments    if (!dbus_message_iter_init(msg, &args))        fprintf(stderr, "Message has no arguments!\n");    else if (DBUS_TYPE_STRING != dbus_message_iter_get_arg_type(&args))        fprintf(stderr, "Argument is not string!\n");    else        dbus_message_iter_get_basic(&args, ¶m);    printf("Method called with %s\n", param);     // create a reply from the message    reply = dbus_message_new_method_return(msg);     // add the arguments to the reply    dbus_message_iter_init_append(reply, &args);    if (!dbus_message_iter_append_basic(&args, DBUS_TYPE_BOOLEAN, &stat)) {        fprintf(stderr, "Out Of Memory!\n");        exit(1);    }    if (!dbus_message_iter_append_basic(&args, DBUS_TYPE_UINT32, &level)) {        fprintf(stderr, "Out Of Memory!\n");        exit(1);    }     // send the reply && flush the connection    if (!dbus_connection_send(conn, reply, &serial)) {        fprintf(stderr, "Out Of Memory!\n");        exit(1);    }    dbus_connection_flush(conn);     // free the reply    dbus_message_unref(reply);}

這就基本上全部了。但用這些來理解 DBus 顯然還遠遠不夠。接下來，就要對這些程式以及背後的理念進行具體的探究了。

轉載自：http://www.cnblogs.com/liyiwen/archive/2012/12/02/2798876.html

參考資料：

1. http://dbus.freedesktop.org/doc/dbus-specification.html 
   這當然是最權威最重要的資料，但我覺得不是一個很好的入門資料。
2. http://dbus.freedesktop.org/doc/dbus-tutorial.html 這裡面有一些不錯的例子，對Names
   的解釋也很好，但用的是 glib 的 binding，不能探究更底層的動作一度還是讓我雲裡霧裡。
3. http://dbus.freedesktop.org/doc/api/html/group__DBusMessage.html  DBus 的 C
   編程介面的線上文檔，非常棒也非常有用