DBus 的 C 編程接口

時間：2019-06-12 12:20:01

關(guān)鍵字： api c dbus

手機看文章

掃描二維碼
隨時隨地手機看文章

[導(dǎo)讀]最近在學(xué) Dbus，不過總是不得其門而入。大部分資料都講了很多東西卻最終沒有讓我搞清楚怎么用 DBus，不就是一個 IPC 通信的工具么？就沒有一點實用些的資料么？看了很多資料之后還是覺得只見樹木不見

最近在學(xué) Dbus，不過總是不得其門而入。

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

在網(wǎng)上找到這么一篇文章：http://www.matthew.ath.cx/misc/dbus，正合我意，下面的內(nèi)容基本是對這篇文章的翻譯和擴(kuò)充。

注意：

翻譯沒有得到原文作者同意，原文也很簡單易懂，最好去讀原文。如果收到投訴，我會立即撤掉本文的。本文不是一篇好的 DBus 入門，有很多基本的東西不在記述之內(nèi)。一般情況下不會直接使用 C API 進(jìn)行 DBus 的編程，而是使用某種 DBus-binding，但我覺得理解 DBus 的 C API 對完整地理解 DBus 是非常重要的。雖然 DBus 是用 C 寫的，而且本文寫的是 C API，但是 DBus 設(shè)計中充滿的面向?qū)ο蟮乃枷?，請注意?/p>

一、共通部分的代碼

在使用 DBus 進(jìn)行通信的時候，有一些代碼是無論如何都會使用到的。首先，你必須要連接上 Dbus，一般來說，系統(tǒng)中會有一個 System Bus 和一個 Session Bus（他們的差別，請參考我另外的筆記）。其次，你需要在 Dbus 中注冊一個名字，用于標(biāo)識自己。為了簡單起見，這里先不考慮重名的情況：

DBusError?err;
DBusConnection*?conn;
int?ret;
//?initialise?the?errors
dbus_error_init(&err);
?
//?connect?to?the?bus
conn?=?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?bus
ret?=?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 和注冊一個名稱，應(yīng)該是在程序最開始運行的時候就會進(jìn)行的操作。

當(dāng)然，在程序的結(jié)束的時候，需要關(guān)閉掉與 Dbus 的連接。使用下面的函數(shù)：

dbus_connection_close(conn);

二、發(fā)送信號（Sending Signal）

信號是一種廣播的消息，你可以簡單的發(fā)出一個信號，這樣，所有連接在 DBus 總線上并注冊了接受對應(yīng)信號的進(jìn)程，都會收到這個信號。為了發(fā)出一個信號，需要的只是創(chuàng)建一個 DBusMessage 對象來代表信號，然后追加上一些需要發(fā)出的參數(shù)，就可以發(fā)向總線了。發(fā)完之后還需要釋放掉 Message。如果內(nèi)存不足的話，這下面不少函數(shù)都會返回 false，所以一般情況下你都需要處理這些情況的返回值。

dbus_uint32_t?serial?=?0;?//?unique?number?to?associate?replies?with?requests
DBusMessage*?msg;
DBusMessageIter?args;
?
//?create?a?signal?and?check?for?errors
msg?=?dbus_message_new_signal("/test/signal/Object",?//?object?name?of?the?signal
??????????????????????????????"test.signal.Type",?//?interface?name?of?the?signal
??????????????????????????????"Test");?//?name?of?the?signal
if?(NULL?==?msg)
{
????fprintf(stderr,?"Message?Nulln");
????exit(1);
}
?
//?append?arguments?onto?signal
dbus_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?connection
if?(!dbus_connection_send(conn,?msg,?&serial))?{
????fprintf(stderr,?"Out?Of?Memory!n");
????exit(1);
}
dbus_connection_flush(conn);
?
//?free?the?message
dbus_message_unref(msg);

三、調(diào)用方法（Calling a Method）

調(diào)用一個遠(yuǎn)程方法（remote method）與發(fā)送一個信號（sending a signal）是很類似的。需要創(chuàng)建一個 DBusMessage，然后通過注冊在 DBus 上的名稱指定發(fā)送的對象。然后追加相應(yīng)的參數(shù)，但調(diào)用方法分為兩種，一種是阻塞式的，另一種則可以異步調(diào)用。異步調(diào)用的時候會得到一個 DBusMessage* 的返回，從這個 DBusMessage 中可以獲取一些返回的參數(shù)。

調(diào)用方法一：

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?name
if?(NULL?==?msg)?{
????fprintf(stderr,?"Message?Nulln");
????exit(1);
}
?
//?append?arguments
dbus_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?reply
if?(!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?Nulln");
????exit(1);
}
dbus_connection_flush(conn);
?
//?free?message
dbus_message_unref(msg);

調(diào)用方法二：

bool?stat;
dbus_uint32_t?level;
?
//?block?until?we?receive?a?reply
dbus_pending_call_block(pending);
?
//?get?the?reply?message
msg?=?dbus_pending_call_steal_reply(pending);
if?(NULL?==?msg)?{
????fprintf(stderr,?"Reply?Nulln");
????exit(1);
}
//?free?the?pending?message?handle
dbus_pending_call_unref(pending);
?
//?read?the?parameters
if?(!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,?%dn",?stat,?level);
?
//?free?reply?and?close?connection
dbus_message_unref(msg);

四、接收消息（Receiving a Signal）

接下來的兩種操作主要是從總線從讀取消息并處理這些消息。

要接收一個消息，你首先需要告訴 DBus 你對什么樣的消息感興趣：

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

然后，進(jìn)程就可以在一個循環(huán)中等待這類消息的發(fā)生了：

/?loop?listening?for?signals?being?emmitted
while?(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?%sn",?sigvalue);
????????}
????}
?
????//?free?the?message
????dbus_message_unref(msg);
}

五、提供被遠(yuǎn)程調(diào)用的方法（Exposing a Method to be called）

在第二節(jié)中，我們看到了調(diào)用一個遠(yuǎn)程方法，這節(jié)就是告訴我們怎么樣提供一個方法讓別的應(yīng)用程序調(diào)用。用下面的程序，就可以把方法關(guān)聯(lián)在那些提供給外部的方法上，并解析出相應(yīng)的參數(shù)，最后構(gòu)建一個消息返回給調(diào)用方法的應(yīng)用程序。

提供遠(yuǎn)程調(diào)用方法1：

//?loop,?testing?for?new?messages
while?(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);
}

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?%sn",?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 顯然還遠(yuǎn)遠(yuǎn)不夠。接下來，就要對這些程序以及背后的理念進(jìn)行具體的探究了。