diff options
author | Sven Eden <yamakuzure@gmx.net> | 2017-09-22 14:27:48 +0200 |
---|---|---|
committer | Sven Eden <yamakuzure@gmx.net> | 2017-09-25 13:02:18 +0200 |
commit | 357e04c35b53f7e9ef10adb15afb7d525e737eb0 (patch) | |
tree | 9c3aad2e32fa66175ee5f08820cf429bed781d2f /man/sd_bus_add_match.xml | |
parent | 510e704e67ea99dc321aadc9527d55ff0f1d4a43 (diff) |
Prep v232.6: Make all supportable API functions visible (v232 addition).
Diffstat (limited to 'man/sd_bus_add_match.xml')
-rw-r--r-- | man/sd_bus_add_match.xml | 57 |
1 files changed, 25 insertions, 32 deletions
diff --git a/man/sd_bus_add_match.xml b/man/sd_bus_add_match.xml index 2014141ae..cac662f8d 100644 --- a/man/sd_bus_add_match.xml +++ b/man/sd_bus_add_match.xml @@ -3,29 +3,29 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> <!-- - This file is part of systemd. + This file is part of elogind. Copyright 2016 Julian Orth - systemd is free software; you can redistribute it and/or modify it + elogind is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. - systemd is distributed in the hope that it will be useful, but + elogind is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License - along with systemd; If not, see <http://www.gnu.org/licenses/>. + along with elogind; If not, see <http://www.gnu.org/licenses/>. --> <refentry id="sd_bus_add_match"> <refentryinfo> <title>sd_bus_add_match</title> - <productname>systemd</productname> + <productname>elogind</productname> <authorgroup> <author> @@ -49,7 +49,7 @@ <refsynopsisdiv> <funcsynopsis> - <funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo> + <funcsynopsisinfo>#include <elogind/sd-bus.h></funcsynopsisinfo> <funcprototype> <funcdef>int <function>sd_bus_add_match</function></funcdef> @@ -73,34 +73,26 @@ <title>Description</title> <para> - <function>sd_bus_add_match()</function> installs a match rule for incoming messages received on the specified bus - connection object <parameter>bus</parameter>. The syntax of the match rule expression passed in - <parameter>match</parameter> is described in the <ulink - url="https://dbus.freedesktop.org/doc/dbus-specification.html">D-Bus Specification</ulink>. The specified handler - function <parameter>callback</parameter> is called for eaching incoming message matching the specified - expression, the <parameter>userdata</parameter> parameter is passed as-is to the callback function. + <function>sd_bus_add_match()</function> adds a match rule used to dispatch + incoming messages. The syntax of the rule passed in + <parameter>match</parameter> is described in the + <ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html">D-Bus Specification</ulink>. </para> <para> - On success, and if non-<constant>NULL</constant>, the <parameter>slot</parameter> return parameter will be set to - a slot object that may be used as a reference to the installed match, and may be utilized to remove it again at a - later time with - <citerefentry><refentrytitle>sd_bus_slot_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>. If - specified as <constant>NULL</constant> the lifetime of the match is bound to the lifetime of the bus object itself, and the match - cannot be removed independently. + The message <parameter>m</parameter> passed to the callback is only + borrowed, that is, the callback should not call + <citerefentry><refentrytitle>sd_bus_message_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry> + on it. If the callback wants to hold on to the message beyond the lifetime + of the callback, it needs to call + <citerefentry><refentrytitle>sd_bus_message_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry> + to create a new reference. </para> <para> - The message <parameter>m</parameter> passed to the callback is only borrowed, that is, the callback should not - call <citerefentry><refentrytitle>sd_bus_message_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry> on - it. If the callback wants to hold on to the message beyond the lifetime of the callback, it needs to call - <citerefentry><refentrytitle>sd_bus_message_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry> to create - a new reference. - </para> - - <para> - If an error occurs during the callback invocation, the callback should return a negative error number. If it - wants other callbacks that match the same rule to be called, it should return 0. Otherwise it should return a + If an error occurs during the callback invocation, the callback should + return a negative error number. If it wants other callbacks that match the + same rule to be called, it should return 0. Otherwise it should return a positive integer. </para> </refsect1> @@ -109,8 +101,9 @@ <title>Return Value</title> <para> - On success, <function>sd_bus_add_match()</function> returns 0 or a positive integer. On failure, it returns a - negative errno-style error code. + On success, <function>sd_bus_add_match()</function> returns 0 or a + positive integer. On failure, it returns a negative errno-style error + code. </para> </refsect1> @@ -118,8 +111,8 @@ <title>See Also</title> <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, </para> </refsect1> |